RatingBoxChart Class Methods
These methods are used by the RatingBoxChart class. The methods are described in alphabetic order.
Syntax
SetLegend(&Array_of_String)
Description
Use the SetLegend method to specify legend text. Legend text labels the images set in the RatingBoxChart class method SetLegendImg.
Note: Legend text is not automatically translated. Be sure to use translated text, such as message catalog entries.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Array_of_String |
Specify an already instantiated array of string, containing the text that you want to use for the legend. |
Returns
None.
Example
&LegendArray = CreateArray("A","B", C","D");
&oRatingBoxChart.SetLegend(&LegendArray);
Syntax
SetLegendImg(&Array_of_String)
Description
Use the SetLegendImg method to specify the legend image names.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Array_of_String |
An already instantiated array containing the names of the images that you want to use with the legend. |
Returns
None.
Syntax
SetQuadrantSchemas(&Quadrant_Array)
Description
Use the SetQuadrantSchemas method to specify an array of QuadrantSchema objects to be used with this rating box chart.
Not all quadrants within the rating box chart require a QuadrantSchema object. Moreover, the QuadrantSchema objects in the array can be specified in any order.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Quadrant_Array |
An already instantiated array of QuadrantSchema objects. |
Returns
None.
Example
&QuadrantSchemas = CreateArray(&q_schema1, &q_schema2, &q_schema3, &q_schema4, &q_schema5, &q_schema6);
&oRatingBoxChart.SetQuadrantSchemas(&QuadrantSchemas);
Syntax
SetRBNodeData(&Rowset)
Description
Use the SetRBNodeData method to specify the level 1 component rowset that is the source for the node data for the rating box chart.
If you make a change to the underlying data of a chart, call the SetRBNodeData method again to update the chart.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Rowset |
An already instantiated and populated component rowset object that references the rating chart node record. |
Returns
None.
Syntax
SetRBNodeRecord(Record.RecordName)
Description
Use the SetRBNodeRecord method to specify the record that is to contain the node data for the rating box chart.
Parameters
|
Field or Control |
Definition |
|---|---|
| Record.RecordName |
Specify the name of the record to be used as the node record. |
Returns
None.
Syntax
SetXAxisLabels(&Array_of_String)
Description
Use the SetXAxisLabels method to specify an array of labels for the x-axis.
Note: The labels will not be displayed if the ShowAxisLabels property is explicitly set to False.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Array_of_String |
Specify an already instantiated array of string that contain the labels that you want to use for the x-axis. The array size must match the value in the XAxisBoxNum property. If they do not match, the system throws a runtime error. |
Returns
None.
Syntax
SetYAxisLabels(&Array_of_String)
Description
Use the SetYAxisLabels method to specify an array of labels for the y-axis.
Note: The labels will not be displayed if the ShowAxisLabels property is explicitly set to False.
Parameters
|
Field or Control |
Definition |
|---|---|
| &Array_of_String |
Specify an already instantiated array of string that contain the labels that you want to use for the y-axis. The array size must match the value in the YAxisBoxNum property. If they do not match, the system throws a runtime error. |
Returns
None.