NOTE: Items in bold red represent patches that may or may not be added to OFC-2.
The “shape” plot type is used to plot a series of points with a color filled area and the points do not trigger the tooltip pop-up window. Enhancements allow the “shape” to draw lines and to allow gaps in the drawing. The “shape” definition must be included in the “elements” array.
{ "type": "shape", "colour": "#CC968B", "alpha": 1,
"text": "User defined key",
"line-colour": "FF0000", "line-alpha": 1, "width": 1,
"values" : [{"x":7,"y":0}, {"x":21,"y":0}, {"x":21,"y":-2.5}, {"x":7,"y":-2.5}]},
|
OBJECT |
ATTRIBUTE |
VALID VALUES |
DEFAULT |
NOTES |
|
|
|
|
|
This table defines attributes for a shape element object |
|
|
“type” |
“shape” |
undefined |
Must be set to “shape” to define a shape plot. |
|
|
“colour” |
“#RRGGBB” hex string |
“#3030d0” |
Defines the color of the line and the points |
|
|
“alpha” |
Real number 0 to 1 |
0.5 |
Specifies the opacity of the color filled area. Ranges from 0 (transparent) to 1 (totally opaque). |
|
|
“width” |
0 to n |
0 |
Width in pixels of the line. Zero (0) is a hairline. |
|
|
“line-colour” |
“#RRGGBB” hex string |
undefined |
Defines the color of the line. undefined defaults to the “colour” detailed above |
|
|
“line-alpha” |
Real number 0 to 1 |
0 |
Specifies the opacity of the line. Ranges from 0 (transparent) to 1 (totally opaque). |
|
|
“text” |
“Name of the Plot” |
“” |
The name of the plot is displayed in the Legend but is NOT available in tooltips via the #key# magic value variable |
|
|
“font-size” |
0 to n |
12 |
Specified the size of the font to use in the Keys legend |
|
|
“values” |
Array of value objects defining points to be plotted |
[...] |
Defines an array of points to be plotted. * See “values” definition table below. |
Definition of the “values” array of point objects within the “shape” type element object.
|
OBJECT |
ATTRIBUTE |
VALID VALUES |
DEFAULT |
NOTES |
|
|
|
|
|
This table defines point objects within the “values” array for a shape element object |
|
|
“x” |
Any number
null |
undefined |
Specifies the X component for the point.
If null is specified then the point will not be visible and it will generate a gap in the line. The line will pick up again with the next point. |
|
|
“y” |
Any number |
undefined |
Specifies the Y component for the point. |