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.Charts > Classes

TRSChartInChartValue Class

Extends the FMX.RS.Charts.TRSShapeChartValue class to provide the properties and methods needed to describe one sub-chart (e.g., a chart inside the chart, similar to Picture-in-picture). The TRSChartInChartValue class is used by the FMX.RS.Charts.TRSChartInChart component. The SubChart property contains the embedded chart.

The TRSChartInChartValue class will ensure freeing the SubChart when being deleted (unless the SubChart's Owner is not nil).

Namespace: FMX.RS.Charts

	Name	Description
	Create(TCollection)	Initializes a new instance of the TRSChartInChartValue class. (Overrides FMX.RS.Charts.TRSShapeChartValue.Create(TCollection).)
	Destroy	Represents the destructor of the TRSChartInChartValue class. (Overrides FMX.RS.Charts.TRSShapeChartValue.Destroy.)

Top

Name

Description

published property

Alignment

Specifies the location of the Caption within the 2D boundaries of the shape. Use the Alignment property to position your text within the shape. (Inherited from FMX.RS.Charts.TRSShapeChartValue.)

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

Brush

Specifies the color and pattern for filling the shape. Set the Brush property to specify the color and pattern to use when drawing the background or filling in the shape. The value of Brush is a TBrush object. Set the properties of the TBrush object to specify the color and pattern or bitmap to use when filling in the shape on the canvas.
(Inherited from FMX.RS.Charts.TRSShapeChartValue.)

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.)

public property

Collection

Specifies the FMX.RS.Charts.TRSChartInChartValues 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

Font

Specifies the font used to draw each shape's Caption. Set Font to specify the font to use for writing text. The value of Font is a TFont object. Set the properties of the TFont object to specify the font face, color, size, style, and any other aspects of the font.
(Inherited from FMX.RS.Charts.TRSShapeChartValue.)

published property

Height

The Height and Width properties specify the size of the shape. Set Height or Width to change the size of the shape. Using the X, Y, Width and Height properties, you specify the exact rectangle where the shape will be drawn.

Note
You can also use the Radius property to specify the size of the shape.

published property

ImageIndex

Specifies the index of the image to use when drawing the point/image. When the FMX.RS.Charts.TRSPointChart component draws this point, it will use the specified image from its ImageList. The image is stretched to fit the PointsInfo width and height. To not use an image, set ImageIndex to -1. (Inherited from FMX.RS.Charts.TRS2DImageChartValue.)

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

protected property

Options

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

published property

Pen

Specifies the kind of pen the shape chart value uses for outlining the shape. Set Pen to specify the pen to use for outlining the shape. The value of Pen is a TRSPen object (TPen in VCL and TStrokeBrush in FMX). Set the properties of the TRSPen object to specify the color, style, width, and mode of the pen.
(Inherited from FMX.RS.Charts.TRSShapeChartValue.)

published property

Radius

The Radius property is another way (besides using Width and Height ) of specifying the size of the shape. The Radius equals Sqr(Width) + Sqr(Height). Use the Radius if you need to specify size using a radius.
(Inherited from FMX.RS.Charts.TRSShapeChartValue.)

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

Defines the geometric shape of the shape value. The shape is drawn as large as possible within the bounding rectangle. (Inherited from FMX.RS.Charts.TRSShapeChartValue.)

public property

SubChart

Returns the embedded sub-chart for the value. Use the SubChart property like any other chart in the component suite (e.g., add values, set properties, etc). You may need to cast the SubChart to the specific chart type to access all the properties (e.g., FMX.RS.Charts.TRSPieChart , TRSBarChart, etc). To set the SubChart, assign a chart object to the property.

The TRSChartInChartValue class will ensure freeing the SubChart if its Owner is nil.

published property

SubChartType

Returns the type of the SubChart. Set the SubChartType property to create a new chart class in SubChart.

published property

Tag

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

published property

TextBoxAlignment

Specifies the location of the Caption

published property

Value

Returns the main (or only) dimension in a chart value - which dimension is returned is based on the chart type. 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. The ValueCount property returns the number of dimensions in the chart value. Use the Values property to access each dimension in the chart value (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).

Notes to Inheritors
To change which dimension is returned by this Value, override the GetDefValue and SetDefValue methods

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.

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

Width

Note
You can also use the Radius property to specify the size of the shape.

published property

Represents property X. (Inherited from FMX.RS.Charts.TRS2DImageChartValue.)

public property

XAsDateTime

Represents property XAsDateTime. (Inherited from FMX.RS.Charts.TRS2DImageChartValue.)

published property

Represents property Y. (Inherited from FMX.RS.Charts.TRS2DImageChartValue.)

public property

YAsDateTime

Represents property YAsDateTime. (Inherited from FMX.RS.Charts.TRS2DImageChartValue.)

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

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 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.Charts.TRSShapeChartValue.Assign(TPersistent).)
	Changed(TObject)	Overloaded. Represents method Changed(TObject). (Inherited from FMX.RS.Charts.TRSShapeChartValue.)
	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.Charts.TRSPointChartValue.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). (Overrides FMX.RS.ChartPanel.TRSChartValue.SetColor(TCanvasColor).)
	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