Hide Comments
Hide Comments

Comments (0)

The TRSDBCandleStickChart component is the database aware version of the TRSCandleStickChart. The TRSCandleStickChart component is a TRSHighLowAverageChart descendant that represents a candlestick chart. The CandleStick Chart displays each chart value ( TRSCandleStickChartValue ) as a vertical or horizontal candlestick (depending on  Orientation).

The values for the chart are created by reading a dataset (database table or query) specified with the    DataSource property. Each record in the dataset provides one value for the chart, where the DataFieldX property specifies the field to use for the X value, DataFieldClose specifies the field to use for the Close value, etc.

CandleStickChartExample

Namespace: RSDBCharts

expandingInheritance Hierarchy

TRSCandleStickChart
  RSDBCharts.TRSDBCandleStickChart
 

expandingSyntax

Delphi

type 
  TRSDBCandleStickChart = class(TRSCandleStickChart) 
  end;  
 

expandingConstructors

 

Name

Description

public destructor

Destroy

Represents the destructor of the TRSDBCandleStickChart class.

Top

expandingProperties

 

Name

Description

published property

DataFieldAverage

Specifies the field name whose value is used for the  Average property of the data-aware chart values. Use DataFieldAverage to bind each data-aware chart value to a field object in the dataset. To fully specify a database field, both the dataset and the field within the dataset must be defined. The     DataSource property of the chart specifies the dataset that contains the data field. The field object needs to be convertable to a floating-point value.

Use the other DataFieldXXX properties to specify the field names for other properties of the chart value (e.g.,     DataFieldCaption specifies the field for the  Caption property of the value). For chart value properties that don't have a corresponding DataFieldXXX property, you can use the     OnGetChartValue event to change their values.
 

published property

DataFieldCaption

Specifies the field name whose value is used for the  Caption property of the data-aware chart values. Use DataFieldCaption to bind each data-aware chart value to a field object in the dataset. To fully specify a database field, both the dataset and the field within the dataset must be defined. The     DataSource property of the chart specifies the dataset that contains the data field.

Use the other DataFieldXXX properties to specify the field names for other properties of the chart value (e.g., DataFieldX specifies the field for the X property of the value). For chart value properties that don't have a corresponding DataFieldXXX property, you can use the     OnGetChartValue event to change their values.
 

published property

DataFieldClose

Specifies the field name whose value is used for the  Close property of the data-aware chart values. Use DataFieldClose to bind each data-aware chart value to a field object in the dataset. To fully specify a database field, both the dataset and the field within the dataset must be defined. The     DataSource property of the chart specifies the dataset that contains the data field. The field object needs to be convertable to a floating-point value.

Use the other DataFieldXXX properties to specify the field names for other properties of the chart value (e.g.,     DataFieldCaption specifies the field for the  Caption property of the value). For chart value properties that don't have a corresponding DataFieldXXX property, you can use the     OnGetChartValue event to change their values.
 

published property

DataFieldHigh

Specifies the field name whose value is used for the  High property of the data-aware chart values. Use DataFieldHigh to bind each data-aware chart value to a field object in the dataset. To fully specify a database field, both the dataset and the field within the dataset must be defined. The     DataSource property of the chart specifies the dataset that contains the data field. The field object needs to be convertable to a floating-point value.

Use the other DataFieldXXX properties to specify the field names for other properties of the chart value (e.g.,     DataFieldCaption specifies the field for the  Caption property of the value). For chart value properties that don't have a corresponding DataFieldXXX property, you can use the     OnGetChartValue event to change their values.
 
 

published property

DataFieldLow

Specifies the field name whose value is used for the  Low property of the data-aware chart values. Use DataFieldLow to bind each data-aware chart value to a field object in the dataset. To fully specify a database field, both the dataset and the field within the dataset must be defined. The     DataSource property of the chart specifies the dataset that contains the data field. The field object needs to be convertable to a floating-point value.

Use the other DataFieldXXX properties to specify the field names for other properties of the chart value (e.g.,     DataFieldCaption specifies the field for the  Caption property of the value). For chart value properties that don't have a corresponding DataFieldXXX property, you can use the     OnGetChartValue event to change their values.
 

published property

DataFieldOpen

Specifies the field name whose value is used for the  Open property of the data-aware chart values. Use DataFieldOpen to bind each data-aware chart value to a field object in the dataset. To fully specify a database field, both the dataset and the field within the dataset must be defined. The     DataSource property of the chart specifies the dataset that contains the data field. The field object needs to be convertable to a floating-point value.

Use the other DataFieldXXX properties to specify the field names for other properties of the chart value (e.g.,     DataFieldCaption specifies the field for the  Caption property of the value). For chart value properties that don't have a corresponding DataFieldXXX property, you can use the     OnGetChartValue event to change their values.
 

published property

DataFieldX

Specifies the field name whose value is used for the  X property of the data-aware chart values. Use DataFieldX to bind each data-aware chart value to a field object in the dataset. To fully specify a database field, both the dataset and the field within the dataset must be defined. The     DataSource property of the chart specifies the dataset that contains the data field. The field object needs to be convertable to a floating-point value.

Use the other DataFieldXXX properties to specify the field names for other properties of the chart value (e.g.,     DataFieldCaption specifies the field for the  Caption property of the value). For chart value properties that don't have a corresponding DataFieldXXX property, you can use the     OnGetChartValue event to change their values.
 

protected property

DataLink

Returns the data link that manages the mapping of chart values to field values

published property

DataSource

Identifies the link to the dataset where the data-aware chart finds its data. Use the DataSource property to set the TDataSource object where the data-aware chart should fetch its data. Each record of the dataset corresponds to one chart value item in the chart's collection.

The DataFieldXXX properties specifies which TField objects of the dataset are used to populate the corresponding properties in the chart value. Any chart value property that doesn't have a TField linked to it uses its defaults. However, you can use the     OnGetChartValue event to change any aspect of a chart value after its field values have been fetched from the dataset.
 

published property

OnGetChartValue

Occurs when the data-aware chart creates a new chart value based on the     DataSource. For each record in the dataset, the data-aware chart creates a chart value, populates it based on DataFieldXXX fields and then call this event.

Write an OnGetChartValue event handler to take action when a chart value is created by a record, either to update other information based on the chart value or to modify a chart value for each record before they are displayed in the chart.

Top

expandingMethods

 

Name

Description

protected method

GetChartValue(TObject,TRSChartValue)

Represents method GetChartValue(TObject,TRSChartValue).

protected method

InitializeChangeEvents

Represents method InitializeChangeEvents.

protected method

InitializeChart

Represents method InitializeChart.

Top

expandingExamples

To display a chart, you drop the component on a form and optionally connect its Panel property to the TRSChartPanel component where you want it to be displayed. Next, connect the DataSource property to the a TDataSource component on your form. Use the DataFieldXXX properties to connect a field to the corresponding XXX property of the chart value The following example links a dataset and some fields to the db-aware chart:

Delphi

begin
   RSDBCandleStickChart1.DataSource := DataSource1;
   RSDBCandleStickChart1.DataFieldX := DataSource1.DataSet.FieldByName('TIMESTAMP');
   RSDBCandleStickChart1.DataFieldCaption := DataSource1.DataSet.FieldByName('COMPANY_NAME');
   RSDBCandleStickChart1.DataFieldOpen := DataSource1.DataSet.FieldByName('STOCK_OPEN');
   RSDBCandleStickChart1.DataFieldClose := DataSource1.DataSet.FieldByName('STOCK_CLOSE');
 end;

expandingSee Also

Reference

TRSChartPanel
TRSCandleStickChart

Comments (0)

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