RiverSoftAVG Products Help

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Save Permalink URL

Navigation: Code Documentation > RSFMXCharts > FMX.RS.BarCharts > Classes

TRSCandleStickChartValue Class

Extends the FMX.RS.BarCharts.TRSHighLowAverageChartValue class to provide the properties and methods needed to describe one candlestick of the FMX.RS.BarCharts.TRSCandleStickChart component. Each bar represents all four important pieces of information for financial-type data: the open, the close, the high and the low, and the average.

Candlesticks are usually composed of the body, and an upper and a lower shadow (wick): the area between the open and the close is called the real body, price excursions above and below the real body are called shadows.

Namespace: FMX.RS.BarCharts

	Name	Description
	Create(TCollection)	Initializes a new instance of the TRSCandleStickChartValue class. (Overrides FMX.RS.BarCharts.TRSHighLowAverageChartValue.Create(TCollection).)

Top

Name

Description

published property

AsDateTime

Provides access to the Value property as a TDateTime value.

Notes to Inheritors
Usually this property provides access to the first dimension (X) of the value array. However, descendant classes can change which dimension this property accesses.

public property

AsDateTimes[Integer]

Represents property AsDateTimes[Integer]. (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

published property

Average

Specifies the Average for the bar chart value. The Average is represented by a small horizontal line that crosses the bar. (Inherited from FMX.RS.BarCharts.TRSHighLowAverageChartValue.)

published property

Caption

Provides a caption or description of the chart value. This value will only be drawn if coLabelEachPoint is in the chart's Options property. (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

published property

Specifies the closing value for the candlestick. With financial candlesticks, closes higher than opens are good (price went up) and shown in green. Closes lower than opens are bad (price went down) and shown in red.

public property

Collection

Specifies the FMX.RS.BarCharts.TRSCandleStickChartValues instance to
which this Item belongs. Each collection item belongs to the
collection which creates it. The Collection property
points to the collection object to which the value belongs.

published property

Color

Specifies the color of this individual value, e.g., the color of the bar or the point or the shape. When coColorEachPoint is in the FMX.RS.ChartPanel.TRSCustomChart.Options property, this color is drawn by the chart. When coColorEachPoint is not in the the Options property, the Color of the chart is used. (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

published property

High

Specifies the High (or maximum) value for the bar. It specifies the top of the bar on the Y axis (when Orientation is boVertical) (Inherited from FMX.RS.BarCharts.TRSHighLowAverageChartValue.)

published property

ImageIndex

Specifies the index of the image to use when drawing the bar. When the FMX.RS.BarCharts.TRSBarChart component draws this bar, it will use the specified image from its ImageList. The image is stretched to fit the bar area. To not use an image, set ImageIndex to -1. (Inherited from FMX.RS.BarCharts.TRSBarChartValue.)

published property

Low

Specifies the Low (or minimum) value for the bar. It specifies the bottom of the bar on the Y axis (when Orientation is boVertical) (Inherited from FMX.RS.BarCharts.TRSHighLowAverageChartValue.)

published property

Opacity

Specifies the opacity of the value when drawn. The opacity is a value between 0 (invisible) and 1 (fully opaque). Any value in-between controls the transparency of the value.

Important Note
This is an FMX only feature. Any value > 0 is drawn fully opaque in the VCL version

published property

Open

Specifies the opening value for the candlestick. With financial candlesticks, closes higher than opens are good (price went up) and shown in green. Closes lower than opens are bad (price went down) and shown in red.

protected property

Options

Represents property Options. (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

published property

ParentStyle

Controls whether the local Style is used for the bar or the FMX.RS.BarCharts.TRSBarChart.BarStyle property is used instead.
(Inherited from FMX.RS.BarCharts.TRSBarChartValue.)

published property

Scale

Specifies the scale factor for the value. A scale factor of 1 (default) draws the value at its normal size within the chart. Change the scale factor to shrink or grow the value within the chart (for drawing purposes only) (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

public property

Selected

Determines whether the chart value is selected. Use the Selected property to select or deselect a chart value. Selected chart values are displayed with the SelectionColor of the chart panel.
(Inherited from FMX.RS.ChartPanel.TRSChartValue.)

published property

Style

Specifies the style, or shape, of the this bar in the bar chart. If ParentStyle is true, this property is ignored and the FMX.RS.BarCharts.TRSBarChart.BarStyle property is used instead. (Inherited from FMX.RS.BarCharts.TRSBarChartValue.)

published property

Tag

Provides user-defined storage that is associated with the value (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

published property

Value

Represents property Value. (Inherited from FMX.RS.BarCharts.TRSSparseBarChartValue.)

public property

ValueCount

Returns the number of dimensions in the chart value. A chart value, depending on the chart type, can contain 1 or more dimensional values that define the chart value.

For example, each chart value in a bar chart contains 1 value (defining the height of the bar), line chart values contains 2 dimensions: X and Y, and shape chart values contain 4 dimensions: X, Y, Width, and Height.

Use the Values property to access each dimension in the chart value. The Value property in comparison returns the main (or only) dimension in a chart value - which dimension is returned is based on the chart type.

Caution
Note that TRSChartValue descendant classes expose properties, such as X and Y, which are safer to access the specific dimension of the value. You should not count on a specific dimension index to contain a specific property

public property

Values[Integer]

Returns the value for the dimension in the chart value. A chart value, depending on the chart type, can contain 1 or more dimensional values that define the chart value.

Caution
Note that TRSChartValue descendant classes expose properties, such as X and Y, which are safer to access the specific dimension of the value. You should not count on a specific dimension index to contain a specific property

The ValueCount will equal the DimensionCount of the collection.

published property

Visible

Determines whether the chart value is visible or not. Use the Visible property to change the visibility of the chart value. Even if the Visible property is True, the chart value may still not be visible if the chart axis is zoomed. (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

published property

Represents property X. (Inherited from FMX.RS.BarCharts.TRSSparseBarChartValue.)

published property

XAsDateTime

Represents property XAsDateTime. (Inherited from FMX.RS.BarCharts.TRSSparseBarChartValue.)

protected property

Provide access to the second dimension of the Values property. The X, Y, and Z properties provide access to the first three dimensions of the Values property.

Use the X, Y, and Z property to access the coordinates of a point.

alert_note Notes to Inheritors

These properties have protected visibility in the class, but descendant classes (e.g., RSCharts|TRS2DChartValue and TRS3DChartvalue ) publish the properties to provide more explanatory access to the dimensions of the Values property.

Remember to also publish the XAsDateTime, YAsDateTime, and ZAsDateTime properties

published property

YAsDateTime

Represents property YAsDateTime. (Inherited from FMX.RS.BarCharts.TRSSparseBarChartValue.)

protected property

Provide access to the third dimension of the Values property formatted as a TDateTime. The XAsDateTime, YAsDateTime, and ZAsDateTime properties provide access to the first three dimensions of the Values property formatted as a TDateTime

alert_note Notes to Inheritors

Remember to also publish the X, Y, and Z properties

protected property

ZAsDateTime

Provide access to the third dimension of the Values property. The X, Y, and Z properties provide access to the first three dimensions of the Values property.

Use the X, Y, and Z property to access the coordinates of a point.

alert_note Notes to Inheritors

Remember to also publish the XAsDateTime, YAsDateTime, and ZAsDateTime properties

Top

	Name	Description
	Assign(TPersistent)	Represents method Assign(TPersistent). (Overrides FMX.RS.ChartPanel.TRSChartValue.Assign(TPersistent).)
	GetAsDateTime(Integer)	Represents method GetAsDateTime(Integer). (Inherited from FMX.RS.ChartPanel.TRSChartValue.)
	GetDefValue	Returns the "default" value for the chart, e.g., Y for 2D charts. This method is called by the Value property. The GetDefValue and SetDefValue methods use the FMX.RS.ChartPanel.TRSChartValues.DefaultDimension to figure out which Values dimension to read and write.
	GetDisplayName	Represents method GetDisplayName. (Inherited from FMX.RS.ChartPanel.TRSChartValue.)
	GetIntValue(Integer)	Represents method GetIntValue(Integer). (Inherited from FMX.RS.ChartPanel.TRSChartValue.)
	GetValue(Integer)	Represents method GetValue(Integer). (Inherited from FMX.RS.ChartPanel.TRSChartValue.)
	Loaded	Represents method Loaded. (Inherited from FMX.RS.ChartPanel.TRSChartValue.)
	Selectable(TRSRect,TRSChartSelectionAction)	Returns true if the value is within the selection rectangle. Descendant classes override this method to signal whether the value is selected or not. (Overrides FMX.RS.ChartPanel.TRSChartValue.Selectable(TRSRect,TRSChartSelectionAction).)
	Selectable(TRSRect,TRSRect,TRSChartSelectionAction)	Overloaded. Returns True if the Value should be selected. This depends on the Selected state and if the value rectangle intersects with the selection rectangle. (Inherited from FMX.RS.ChartPanel.TRSChartValue.)
	SelectionChanged	Represents method SelectionChanged. (Inherited from FMX.RS.ChartPanel.TRSChartValue.)
	SetAsDateTime(Integer,TDateTime)	Represents method SetAsDateTime(Integer,TDateTime). (Inherited from FMX.RS.ChartPanel.TRSChartValue.)
	SetColor(TCanvasColor)	Represents method SetColor(TCanvasColor). (Inherited from FMX.RS.ChartPanel.TRSChartValue.)
	SetDefValue(TRSChartValueType)	Sets the "default" value for the chart, e.g., X for 2D charts. This method is called by the Value property. Change the GetDefValue and SetDefValue methods for TRSChartValue descendants that don't have their default dimension as 0.
	SetIntValue(Integer,Integer)	Represents method SetIntValue(Integer,Integer). (Inherited from FMX.RS.ChartPanel.TRSChartValue.)
	SetValue(Integer,TRSChartValueType)	Represents method SetValue(Integer,TRSChartValueType). (Inherited from FMX.RS.ChartPanel.TRSChartValue.)
	ValueChanged(Integer)	Represents method ValueChanged(Integer). (Inherited from FMX.RS.ChartPanel.TRSChartValue.)
	ValuesToString(String,Boolean)	Returns a comma-delimited string of the floating-point values of the Value. The Fmt property specifies how to format the floating-point values (see FormatFloat function from Delphi's help). The Parentheses property controls if parentheses are put around the comma-delimited string. (Inherited from FMX.RS.ChartPanel.TRSChartValue.)
	VisibleChanged	Represents method VisibleChanged. (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

Top

RiverSoftAVG Products Help

Reference