Hide Comments
Hide Comments

Comments (0)

Extends the RSCharts.TRS2DChartValue class to provide the properties and methods needed to describe one guide. Guides are horizontal or vertical lines, similar to Photoshop guides, that help the user more quickly see other chart values. A guide chart is meant to be used with other chart types to help users interpret the values. For example, you could create a horizontal guide at Y=100, which would display a horizontal line across the chart panel at Y=100. The user can then use this guide to see at a glance which values from a line chart are above or below 100.

The TRSGuideChartValue class is used by the RSCharts.TRSGuideChart component. The TRSGuideChartValue class contains the X, Y and Orientation properties to define one guide.
 

Namespace: RSCharts

expandingInheritance Hierarchy

TGCollectionItem
  RSChartPanel.TRSChartValue
    RSCharts.TRS2DChartValue
      RSCharts.TRSGuideChartValue
 

expandingSyntax

Delphi

type
  TRSGuideChartValue = class(TRS2DChartValue)
  end; 
 

expandingConstructors

 

Name

Description

public constructor

Create(TCollection)

Initializes a new instance of the TRSGuideChartValue class. (Overrides RSCharts.TRS2DChartValue.Create(TCollection).)

Top

expandingProperties

 

Name

Description

published property

AsDateTime

Provides access to the   Value property as a TDateTime value.

alert_noteNotes 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

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 RSCharts.TRSGuideChartValues 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

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.

alert_cautionImportant 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

Orientation

Specifies the set of directions for the guide in the guide chart. The default orientation is [loHorizontal].

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

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

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

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.

alert_cautionCaution

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.

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.

alert_cautionCaution

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

X

Represents property X.

public property

XAsDateTime

Represents property XAsDateTime.

published property

Y

Represents property Y.

public property

YAsDateTime

Represents property YAsDateTime.

protected property

Z

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_noteNotes 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_noteNotes 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

Top

expandingMethods

 

Name

Description

public method

Assign(TPersistent)

Represents method Assign(TPersistent). (Overrides RSChartPanel.TRSChartValue.Assign(TPersistent).)

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

Loaded

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

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

SelectGuide(TRSPoint,TLineOrientations,TRSRect)

Overloaded. Represents method SelectGuide(TRSPoint,TLineOrientations,TRSRect).

protected method

SelectGuide(TRSPoint,TRSRect)

Overloaded. Represents method SelectGuide(TRSPoint,TRSRect).

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

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

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

expandingFields

 

Name

Description

protected field

FValues

Represents field FValues. (Inherited from RSChartPanel.TRSChartValue.)

Top

expandingSee Also

Comments (0)

RiverSoftAVG Charting Component Suite (RCCS) © 2005-2015, Thomas G. Grubb