ZoomCharts Documentation

Version: 1.21.1 (2024-11-08)

ZoomCharts.Configuration.LinearChartSettingsSeriesCandleStickStyle

Inheritance hierarchy

This type inherits from LinearChartSettingsSeriesStyle.

Methods

This type does not define any methods.

Properties

Item style when open is higher than close

depth: number
fillColor: string

Fill color.

fillGradient: GradientDefinition

Fill gradient. Allows building a gradient fill, bound to values. Contains array of value-color pairs. For example: [[-20, 'rgba(0,0,255,0.4)'],[30,'rgba(255,0,0,0.7)']]. If specified fillGradientMode: "horizontal" or "vertical", then value denotes fraction of the column width and must be in interval from 0 to 1 For example: [[0,"black"],[0.5,"red"],[1, "orange"]].

fillGradientMode: "vertical" | "horizontal"
Introduced in version 1.18.9.

Fill gradient orientation for manual fill gradient mode. In use with fillGradient property. "null" for default fillGradient mode, "vertical" for vertical gradient, "horizontal" for horizonal rendering"

fillPattern: string
Introduced in version 1.16.0.

Specifies the URL to the image that will be used as the repeated fill pattern for the series.

When fillPattern is specified, fillGradient is ignored. If fillColor is specified together with fillPattern, it will be used as the background color for the pattern.

Item style when open is smaller than close

Introduced in version 1.13.1.

Style settings for the legend item that is rendered for the series.

Properties
Introduced in version 1.13.2.

Configures the marker that is shown in the legend. Note that the default (shape: null) means that instead of the plain marker, an icon representing the series visual style will be used.

textColor: string
Introduced in version 1.13.1.

The color used for the label of the legend item. Note that for disabled series advanced.disabledSeries.textColor takes precedence.

lineColor: string
lineDash: Array<number>

Array of line dash pattern to have a dashed line. The array contains length of dash followed by length of space in pixels. A sequence of multiple dash-space values is supported. In case you want to set a solid line, pass empty array: []

lineDashOffset: number

Start offset of line dash, in pixels

lineGradient: GradientDefinition

Line gradient. Allows building a gradient line, bound to values. Contains array of value-color pairs. For example: [[-20, 'rgba(0,0,255,0.4)'],[30,'rgba(255,0,0,0.7)']]. If specified lineGradientMode: "horizontal" or "vertical", then value denotes fraction of the column width and must be in interval from 0 to 1 For example: [[0,"black"],[0.5,"red"],[1, "orange"]].

lineGradientMode: "vertical" | "horizontal"

Line gradient orientation for manual line gradient mode. In use with lineGradient property. "null" for default lineGradient mode, "vertical" for vertical gradient, "horizontal" for horizonal rendering"

lineWidth: number

Width of the line.

padding: [number, number]

Item left and right padding

pattern: "candlestick" | "bar"

Candlestick item representation pattern where difference is wethter to show body part

Valid values:
  • candlestick - item body part included.
  • bar - item body part excluded.
shadowColor: string

Shadow color of column. If undefined, no shadow will be applied. Leave empty to use default shadow or set your own shadow color.

shadowOffsetX: number

Shadow direction, x component.

shadowOffsetY: number

Shadow direction, y component.

tooltipColor: string

The series color in the tooltip. 'null' automatically determines based on existing color settings

tooltipGradient: GradientDefinition

A gradient range for tooltip color. Allows building a gradient fill, bound to values. In the case of tooltip, the tooltip will still be rendered with a solid color, but this allows easily specifying different colors depending on the tooltip value. Contains array of value-color pairs. For example: [[-20, 'rgba(0,0,255,0.4)'],[30,'rgba(255,0,0,0.7)']]. If specified fillGradientMode: "horizontal" or "vertical", then value denotes fraction of the column width and must be in interval from 0 to 1 For example: [[0,"black"],[0.5,"red"],[1, "orange"]].

tooltipShadowBlur: string

What color the tooltip shadow is, as a CSS size string

tooltipShadowColor: string

What color the tooltip shadow is, as a CSS color

tooltipShadowLightnessMaxThreshold: number

The maximum level of tooltip color lightness where a shadow will be drawn, between 0 and 1. Shadow will still be drawn if it is within the other threshold.

tooltipShadowLightnessMinThreshold: number

The minimum level of tooltip color lightness for a shadow to be drawn, between 0 and 1. Shadow will still be drawn if it is within the other threshold.

tooltipShadowSize: string

How big the tooltip shadow is, as a CSS size string

X