Hide Comments
Hide Comments

TRSEQChartValue Class

Comments (0)

Defines one equalizer bar in the equalizer chart. Each EQ chart is made up of a collection of EQ bars ( RSCharts|TRSEQChartValues ), where each TRSEQChartValue descendant defines one EQ bar (or frequency) for the chart. The TRSEQChartValue class manages the frequency level (in the Value property) as well as the High value for the frequency.

EQChartDescription

Namespace: FMX.RS.Charts

expandingInheritance Hierarchy

TGCollectionItem
  FMX.RS.ChartPanel.TRSChartValue
    FMX.RS.Charts.TRSEQChartValue
 
expandingSyntax

Delphi

type
  TRSEQChartValue = class(TRSChartValue)
  end; 
 
expandingConstructors

 

Name

Description

public constructor

Create(TCollection)

Initializes a new instance of the TRSEQChartValue class. (Overrides FMX.RS.ChartPanel.TRSChartValue.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 FMX.RS.ChartPanel.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 FMX.RS.ChartPanel.TRSChartValue.)

public property

Collection

Specifies the RSCharts|TRSEQChartValues 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 FMX.RS.ChartPanel.TRSChartValue.)

published property

High

Returns the highest equalizer value this item has contained previously. In other words, if you have set the Value property to 10, 30, and 20 previously, the High property will return 30.

EQChartDescription

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 FMX.RS.ChartPanel.TRSChartValue.)

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

Tag

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

published property

Value

Represents property Value.

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 FMX.RS.ChartPanel.TRSChartValue.)

protected property

X

Provide access to the first 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

protected property

XAsDateTime

Provide access to the first 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

protected property

Y

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

protected property

YAsDateTime

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

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). (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

protected method

GetAsDateTime(Integer)

Represents method GetAsDateTime(Integer). (Inherited from FMX.RS.ChartPanel.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 FMX.RS.ChartPanel.TRSChartValue.)

protected method

GetIntValue(Integer)

Represents method GetIntValue(Integer). (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

protected method

GetValue(Integer)

Represents method GetValue(Integer). (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

protected method

Loaded

Represents method Loaded. (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

public method

ResetHigh

Resets the High value to the current equalizer Value.

public method

Selectable(TRSRect,TRSChartSelectionAction)

Overloaded. Returns true if the value is within the selection rectangle. Descendant classes override this method to signal whether the value is selected or not. (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

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 FMX.RS.ChartPanel.TRSChartValue.)

protected method

SelectionChanged

Represents method SelectionChanged. (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

protected method

SetAsDateTime(Integer,TDateTime)

Represents method SetAsDateTime(Integer,TDateTime). (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

protected method

SetColor(TCanvasColor)

Represents method SetColor(TCanvasColor). (Inherited from FMX.RS.ChartPanel.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 FMX.RS.ChartPanel.TRSChartValue.)

protected method

SetValue(Integer,TRSChartValueType)

Represents method SetValue(Integer,TRSChartValueType). (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

protected method

ValueChanged(Integer)

Represents method ValueChanged(Integer). (Overrides FMX.RS.ChartPanel.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 FMX.RS.ChartPanel.TRSChartValue.)

protected method

VisibleChanged

Represents method VisibleChanged. (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

Top
expandingFields

 

Name

Description

protected field

FValues

Represents field FValues. (Inherited from FMX.RS.ChartPanel.TRSChartValue.)

Top
expandingSee Also

Comments (0)

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