Timeline Class Methods
In this section, the Timeline class methods are presented in alphabetical order.
Syntax
SetData({Record_Name | &Rowset})
Description
Use the SetData method to specify where the data for the chart is coming from.
You can use either a record name or an already instantiated, populated rowset. In general, specify a record when building a chart from page data and a rowset when building a chart from a standalone rowset.
If you make a change to the underlying data of a chart, call the SetData method again to update the chart.
Parameters
|
Field or Control |
Definition |
|---|---|
| Record_Name |
Specify the name of a record to be used to populate the timeline with data. |
| &Rowset |
Specify the name of an already instantiated rowset to populate the timeline with data. This is generally a standalone rowset. |
Returns
None.
Example
&oChart.SetData(Record.QE_COL_MULTI_2Y);Syntax
SetDataSeries(Record_Name.Field_Name)
Description
Use the SetDataSeries method to specify the identifier for the timeline series. Every distinct value in this field is considered a unique series. Only a maximum of two series is allowed.
Parameters
|
Field or Control |
Definition |
|---|---|
| Record_Name.Field_Name |
Specify the name of the record and the field on that record that contains the series values for a timeline item. |
Returns
None.
Example
&oChart.SetDataSeries(RECORD.FIELD);Syntax
SetDataItemID(Record_Name.Field_Name)
Description
Use the SetDataItemID method to specify the field in the record that defines the unique identifier for a timeline item.
Parameters
|
Field or Control |
Definition |
|---|---|
| Record_Name.Field_Name |
Specify the name of the record and the field on that record that contains the unique identifier for a timeline item. |
Returns
None.
Example
&oChart.SetDataItemID(RECORD.FIELD);Syntax
SetDataItemStart(Record_Name.Field_Name)
Description
Use the SetDataItemStart method to specify the field in the record that defines the start time for a timeline item.
Parameters
|
Field or Control |
Definition |
|---|---|
| Record_Name.Field_Name |
Specify the name of the record and the field on that record that contains the start time value for a timeline item. |
Returns
None.
Example
&oChart.SetDataItemStart(RECORD.FIELD);Syntax
SetDataItemDescription(Record_Name.Field_Name)
Description
Use the SetDataItemDescription method to specify the description for a timeline item.
Parameters
|
Field or Control |
Definition |
|---|---|
| Record_Name.Field_Name |
Specify the name of the record and the field on that record, which contains the description of a timeline item. |
Returns
None.
Example
&oChart.SetDataItemDescription(RECORD.FIELD);Syntax
SetDataItemTitle(Record_Name.Field_Name)
Description
Use the SetDataItemTitle method to specify the title text to display for a time line item.
Parameters
|
Field or Control |
Definition |
|---|---|
| Record_Name.Field_Name |
Specify the name of the record and the field on that record, which contains the title for a time line item. |
Returns
None.
Example
&oChart.SetDataItemTitle(RECORD.FIELD);Syntax
SetSeriesEmptyText(&Array_of_String)
Description
Use the SetSeriesEmptyText method to specify the text to display for an empty timeline series. For a timeline with only one series, use the SeriesEmptyText property.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Array_of_String |
Specify an already instantiated array of string containing the text that you want to display for an empty timeline series. |
Returns
None.
Example
&oChart.SetSeriesEmptyText(CreateArray("Timeline Empty 1", "Timeline Empty 2"));Syntax
SetSeriesLabels(&Array_of_String)
Description
Use the SetSeriesLabels method to specify the labels to display for a timeline series. For a timeline with only one series, use the SeriesLabel property.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Array_of_String |
Specify an already instantiated array of string containing the labels to display for the timeline series. |
Returns
None.
Example
&oChart.SetSeriesLabels(CreateArray("TimeLine Series 1", "TimeLine Series 2"));