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 > RSCharting > RSGraphCharts > Classes

TRSGraphChartValue Class

Extends the RSCharts.TRSShapeChartValue class to provide the properties and methods needed to describe one graph chart value (or node). The TRSGraphChartValue class is used by the RSGraphCharts.TRSGraphChart component. The TRSGraphChartValue class manages not only the node, but the outbound Links of the node. These links specify the characteristics of the arrow that connects two TRSGraphChartValue instances.

Namespace: RSGraphCharts

	Name	Description
	Create(TCollection)	Initializes a new instance of the TRSGraphChartValue class. (Overrides RSCharts.TRSShapeChartValue.Create(TCollection).)
	Destroy	Represents the destructor of the TRSGraphChartValue class. (Overrides RSCharts.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 RSCharts.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 RSChartPanel.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 RSCharts.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 RSChartPanel.TRSChartValue.)

public property

Collection

Specifies the RSGraphCharts.TRSGraphChartValues 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 RSChartPanel.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 RSChartPanel.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 RSCharts.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 RSCharts.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 RSCharts.TRS2DImageChartValue.)

published property

Level

Specifies the optional level of the node. A lot of graph charts, such as org charts and flow charts, are not just scattered about the chart surface. There is a definite organization, e.g., things flow from a top to a bottom (or a left to a right) and many nodes are considered equivalent so they are placed at the same level as other nodes. The Level property is an integer property from 0 to whatever specifying the level of the node. This Level property is used by the Arrange method to divide the chart canvas into a big grid, where each cell in the grid can contain one chart value. One axis of this virtual grid will be the Levels in the chart. The other axis will be all the nodes/values at that level.

published property

Links

Manages the collection of graph links for this chart value (e.g., the line from this graph chart value to other two graph chart values (specified by the Value property). Each link is defined by the RSGraphCharts.TRSGraphChartLink class, which not only specifies the link but also the appearance of the link, including Caption, LinePoints, and ConnectionPoint.

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 RSChartPanel.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 RSCharts.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 RSCharts.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 RSChartPanel.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 RSChartPanel.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 RSCharts.TRSShapeChartValue.)

published property

Tag

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

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 RSChartPanel.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 RSCharts.TRS2DImageChartValue.)

public property

XAsDateTime

Represents property XAsDateTime. (Inherited from RSCharts.TRS2DImageChartValue.)

published property

Represents property Y. (Inherited from RSCharts.TRS2DImageChartValue.)

public property

YAsDateTime

Represents property YAsDateTime. (Inherited from RSCharts.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

public method

AddChild(String)

Creates a new graph chart value as a child of the current graph chart value. The AddChild method creates the new graph chart value, initializes its Caption to the ACaption parameter and its Level property to the current graph chart value's Level + 1, and then creates a link from the current node to the new node.

The new graph chart value is returned by the method.

note Note

The new graph chart value is considered a "child" only in that its Level is 1 more than the current chart value and there is a link from the current chart value to the new chart value. It is not an enforced relationship. The new graph chart value, as well as the old one, are managed by the RSGraphCharts.TRSGraphChartValues collection. You can change and delete links to sever this "parent-child" relationship.

public method

Assign(TPersistent)

Represents method Assign(TPersistent). (Overrides RSCharts.TRSShapeChartValue.Assign(TPersistent).)

protected method

Changed(TObject)

Overloaded. Represents method Changed(TObject). (Inherited from RSCharts.TRSShapeChartValue.)

protected method

GetAsDateTime(Integer)

Represents method GetAsDateTime(Integer). (Inherited from RSChartPanel.TRSChartValue.)

protected method

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 RSChartPanel.TRSChartValues.DefaultDimension to figure out which Values dimension to read and write.

protected method

GetDisplayName

Represents method GetDisplayName. (Inherited from RSChartPanel.TRSChartValue.)

protected method

GetIntValue(Integer)

Represents method GetIntValue(Integer). (Inherited from RSChartPanel.TRSChartValue.)

protected method

GetValue(Integer)

Represents method GetValue(Integer). (Inherited from RSChartPanel.TRSChartValue.)

protected method

LevelChanged

Represents method LevelChanged.

protected method

LinksNotify(TRSGraphChartLink,TCollectionNotification)

Represents method LinksNotify(TRSGraphChartLink,TCollectionNotification).

protected method

LinksUpdate(TRSGraphChartLink)

Represents method LinksUpdate(TRSGraphChartLink).

protected method

Loaded

Represents method Loaded. (Overrides RSChartPanel.TRSChartValue.Loaded.)

public method

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 RSCharts.TRSPointChartValue.Selectable(TRSRect,TRSChartSelectionAction).)

protected method

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

protected method

SelectionChanged

Represents method SelectionChanged. (Inherited from RSChartPanel.TRSChartValue.)

protected method

SetAsDateTime(Integer,TDateTime)

Represents method SetAsDateTime(Integer,TDateTime). (Inherited from RSChartPanel.TRSChartValue.)

protected method

SetColor(TCanvasColor)

Represents method SetColor(TCanvasColor). (Overrides RSChartPanel.TRSChartValue.SetColor(TCanvasColor).)

protected method

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.

protected method

SetIntValue(Integer,Integer)

Represents method SetIntValue(Integer,Integer). (Inherited from RSChartPanel.TRSChartValue.)

protected method

SetValue(Integer,TRSChartValueType)

Represents method SetValue(Integer,TRSChartValueType). (Inherited from RSChartPanel.TRSChartValue.)

protected method

ValueChanged(Integer)

Represents method ValueChanged(Integer). (Overrides RSChartPanel.TRSChartValue.ValueChanged(Integer).)

public method

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

protected method

VisibleChanged

Represents method VisibleChanged. (Inherited from RSChartPanel.TRSChartValue.)

Top

RiverSoftAVG Products Help

Reference