Candlestick Chart

The Candlestick chart displays the price movement of an asset over a number of trading periods. Each bar indicates the price at the start and end of the trading period, as well as the highest and lowest price reached during the period. The midpoint of the bar indicates the average price during the period.

Public Variables (Properties)

[?]

Common component variables and variable groups : Name, Visible, Breakpoints, Variable Storage, Container Properties, Styles, Preloader, Events, Component Bindings.

Common chart variables and variable groups: Basic Properties, Legend, Zoom, X and Y Axes, Coordinate Grid, Chart Padding, Tooltip and Visualization: Basic Properties.

Data

The following properties are grouped in the Data group of the chart, and define the data which will be used to create the chart.

Source Data

The source data table used for building custom-data-based charts.

Variable Name:

sourceData

Records:

0…Unlimited

Record Format:

Field Name

Field Type

Field Description

volume

Double

Typically the number of trades of the asset during the period.

category

String

Value for the X axis. Typically a timestamp indicating the trading period, but any string can be used.

open

Double

Asset price at the opening of the trading period.

close

Double

Asset price at the close of the trading period

high

Double

Highest price the asset was traded at during the trading period.

low

Double

Lowest price the asset was traded at during the trading period.

Source Data Bindings

A set of expressions used to retrieve data from the records of the Source Data table and build the chart dataset. This property only applies to charts based on custom data.

Variable Name:

dataBindings

Records:

1

Record Format:

Field Name

Field Type

Field Description

volume

String

Expression to define the Volume of the chart dataset.

category

String

Expression to define the Category of the chart dataset.

open

String

Expression to define the Open of the chart dataset.

close

String

Expression to define the Close of the chart dataset.

high

String

Expression to define the High of the chart dataset.

low

String

Expression to define the Low of the chart dataset.

All fields of the Source Data Bindings table have the following Resolution Environment:

Default Context

Specified by the Context setting.

Default Data Table

Value specified by the Source Data table.

Default Row

0 (or dynamic if series propagation is enabled)

Environment Variables

Standard variables only.

Auto Load Dataset

See the common property Auto Load Dataset.

Tooltip

In addition to the common Tooltip properties, the following properties specific to the Candlestick chart are under the Tooltip properties group.

Trend Up Fill

Choose the color to indicate for chart elements trending upward.

Variable Name:

trendUpFill

Records:

1

Record Format:

Field Name

Field Type

Field Description

trendUpFill

Color

Trend Up Fill

Trend Down Fill

Choose the color to indicate for chart elements trending downward.

Variable Name:

trendDownFill

Records:

1

Record Format:

Field Name

Field Type

Field Description

trendDownFill

Color

Trend Down Fill

Visualization: Basic Properties

The following properties appear under the Basic Properties subgroup of the Visualization group.

Chart Padding

See chart padding.

Visualization: Stock

The following properties appear under the Stock subgroup of the Visualization group.

Trend Up Fill

Defines the fill color of the bars in the chart that indicate an upward trend.

Variable Name:

styleTrendUpFillStock

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleTrendUpFillStock

Color

Trend Up Fill

Trend Down Fill

Defines the fill color of the bars in the chart that indicate a downward trend.

Variable Name:

styleTrendDownFillStock

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleTrendDownFillStock

Color

Trend Down Fill

Fill Opacity

Controls the opacity level of the fill color for the bars in the chart.

Variable Name:

styleFillOpacityStock

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleFillOpacityStock

Float

Fill Opacity

Border Color

Sets the border color of the bars in the chart.

Variable Name:

styleStrokeStock

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleStrokeStock

Color

Border Color

Border Opacity

Controls the opacity of the border color for the bars in the chart.

Variable Name:

styleStrokeOpacityStock

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleStrokeOpacityStock

Float

Border Opacity

Border Width

Determines the width of the border for the bars in the chart.

Variable Name:

styleLineWidthStock

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleLineWidthStock

Integer

Border Width

Border Dash Interval

Specifies the dash pattern of the border for the bars in the chart.

Variable Name:

styleLineDashStock

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleLineDashStock

String

Border Dash Interval

Shadow Color

Sets the color of the shadow cast by the bars in the chart.

Variable Name:

styleShadowColorStock

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleShadowColorStock

Color

Shadow Color

Shadow Blur

Determines the blurring effect applied to the shadow cast by the bars in the chart.

Variable Name:

styleShadowBlurStock

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleShadowBlurStock

Integer

Shadow Blur

Shadow Offset X

Controls the horizontal offset of the shadow cast by the bars in the chart.

Variable Name:

styleShadowOffsetXStock

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleShadowOffsetXStock

Integer

Shadow Offset X

Shadow Offset Y

Controls the vertical offset of the shadow cast by the bars in the chart.

Variable Name:

styleShadowOffsetYStock

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleShadowOffsetYStock

Integer

Shadow Offset Y

Cursor

Defines the cursor appearance when interacting with the bars in the chart.

Variable Name:

styleCursorStock

Records:

1

Record Format:

Field Name

Field Type

Field Description

styleCursorStock

String

Cursor

Category Style

Define specific styles to apply to any number of series in the chart.

Variable Name:

styleSeriesStyleStock

Records:

0…Unlimited

Record Format:

Field Name

Field Type

Field Description

series

String

Series

fill

Color

Fill

category

String

Category

r

Integer

Radius

shape

String

Shape

fillOpacity

Float

Fill Opacity

stroke

Color

Stroke

lineWidth

Integer

Line Width

lineDash

String

Line Dash

strokeOpacity

Float

Stroke Opacity

shadowColor

Color

Shadow Color

shadowBlur

Integer

Shadow Blur

shadowOffsetX

Integer

Shadow Offset X

shadowOffsetY

Integer

Shadow Offset Y

cursor

String

Line Dash

Public Events

[?]

Common Events: Common Component Events, Changing Chart Zoom

Was this page helpful?