Class pvc.options.VisualRole
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
The options documentation class of a visual role.
|
| Field Attributes | Field Name and Description |
|---|---|
|
A list of dimension names and respective
sort orders.
|
|
|
The
name of another visual role
whose dimensions are to be used by this one.
|
|
|
Indicates that the visual role's data
should be ordered in reverse order
in relation to the sort orders specified in
#dimensions.
|
|
|
The legend options of a visual role.
|
Where a visual role argument is expected, a string value is also accepted, with the content of what would be specified in the property #dimensions.
A dimensions string is similar to an SQL 'order by' clause, like the following examples show:
- "productType"
- the visual role is bound to the single dimension named "productType", and data will be sorted in ascending order
- "sales"
- the visual role is bound to the single dimension named "sales", and data will be sorted in ascending order
- "country, productType"
- the visual role is bound to the dimensions named "country" and "productType", and data will be sorted first by "country", in ascending order, and then by "productType", in ascending order
- "country desc, productType asc"
- the visual role is bound to the dimensions named "country" and "productType", and data will be sorted first by "country", in descending order, and then by "productType", in ascending order
This property takes precedence over VisualRole#dimensions.
If the source role is reversed, this visual role's VisualRole#isReversed is toggled.
If this is a plot visual role and it is being specified from within charts.BasicChart#plots, then VisualRole#from is relative to the enclosing plot.
To refer to a visual role of the main plot, prefix the local name of the visual role with "main.", to obtain, for example, "main.series".
To refer, unambiguously, to a visual role of the chart, prefix its local name with "$.", to obtain, for example, "$.multiChart".
This option provides a quick way to reverse the order of the whole visual role, without changing any partial sort orders assigned to each dimension of the visual role.
This option can be used to reverse the order of the data that is shown in a discrete axis.
See also VisualRole#from.
- Default Value:
- false