User Interaction and Control Properties
Interaction
Object containing properties for various interactions and interaction modes.
| Name |
Description |
Property Type |
| mode |
Determines which additional chart functionality is enabled. At most one mode may be selected at a time. |
Mode |
| menu |
propertiesProperties for the cog icon menumenu. |
Menu |
| playPause |
allowsAllows the user to play/pause the chart scrolling scrolling. |
playPause |
| panAndZoom |
Enables click-and-drag panning as well as pinch-zoomingzooming. |
Pan and Zoom |
| slope |
Allows the user to draw lines and view their slopeslope. |
Slope |
| xtrace |
Enables mouse coordinate information when hovered over and the placement of labels with information regarding each pen at a chosen x coordinate. |
X Trace |
| rangeBrush |
Enables range-the drawing functionalityof rectangular ranges on the graph. |
Range Brush |
| annotation |
Allows the user to add custom annotation to the chartchart. |
Object |
| mouseWheelZoom |
Allows the user to use the mouse wheel to zoom in and outout. |
Mouse Wheel Zoom |
| overview |
|
Overview |
| zoomToArea |
Allows the user to draw ana rectangular area to zoom in toto. |
Zoom to Area |
ADD GRAPHIC SHOWING THE ANNOTATION????
Mode
The mode enumeration determines which interaction mode is active. The interaction menu sets this property on each mode button click. The user may choose to hide the interaction menu and script the change of this property instead.
Can be one of:
- None
- PanZoom
- Slope
- XTrace
- RangeBrush
- Annotate
- ZoomToArea
Object containing properties for the cog icon menu.
| Name |
Description |
Property Type |
| visible |
Toggles visibility of the menu |
Boolean |
PlayPause
Object containing properties for the play/pause button.
| Name |
Description |
Property Type |
| visible |
Toggles the visibility of the play/pause button |
Boolean |
Download as SVG, PNG
Allows the user to download an image of the chart as an SVG file.
RangeBrush
Object containing properties for the rangeBrush mode
| Name |
Description |
Property Type |
| visible |
Toggles the visibility of the range brush mode button in the menu. |
Boolean |
| maxInstances |
The maximum number of concurrent ranges. When this number is exceeded, the oldest ranges are deleted first. |
Integer |
| brush |
Object containing properties for the rangeappearance brushof ranges. |
Brush |
| ranges |
An array of 2-element arrays containing x values representing each rangerange. |
Range[] |
Brush
| Name |
Description |
Property Type |
brush |
Object containing properties for the range brush |
Object |
fill |
The color of the interior of the range brushranges. |
Color |
| stroke |
The color of the stroke (outline) of the range brushranges. |
Color |
| thickness |
The thickness of the rangeoutline brushof ranges. |
Integer |
| opacity |
The opacity of the range brushranges (1: opaque, 0: invisible). |
Float |
Ranges
| Name |
Description |
Property Type |
| xAxis |
The x axis ofthat thethis range is located on. |
String |
| start |
The x coordinate of the leftmost side of the rangerange. |
Integer |
| end |
The x coordinate of the rightmost side of the rangerange. |
Integer |
Range properties are stored on a per-axis basis as an array of property objects.
XTrace
Object containing properties for the xTrace mode.
| Name |
Description |
Property Type |
| visible |
Toggles the visibility of allthe xTrace mode functionalitybutton in the menu. |
Boolean |
| showToolTip |
Toggles the visibility of the tooltip that follows the cursor. |
Boolean |
| showAxisLabels |
Toggles the visibility of the coordinate labels following the cursor along the axisaxis. |
Boolean |
| showXLine |
Toggles the visibility of the vertical line showing the x coordinate of the mousemouse. |
Boolean |
| showYLine |
Toggles the visibility of the horizontal line showing the y coordinates of the mousemouse. |
Boolean |
| maxInstances |
The maximum number of x-traces allowed on the chartchart. When this number is exceeded, the oldest traces are removed first. |
Integer |
| trace |
Object containing properties for tracingthe functionalityappearance of all xTrace functionality. |
Trace |
Trace
| Name |
Description |
Property Type |
| stroke |
The color of the outline of the lines representing the coordinates of the mousemouse, as well as the text within the tooltip and within the axes labels. |
Color |
| thickness |
The thickness of the lines representing the coordinates of the mousemouse. |
Integer |
| lineDash |
An array holding numeric values representing line dashing. Add an even amount of numbers to the array to create a repeating pattern. |
Array |
| fill |
The color of the fill of the lines representing the coordinates of the mousemouse. |
Color |
| font |
The font for theall text present in xTrace modemode. |
Font |
| fontSize |
The size of theall text present in xTrace modemode. |
Float |
Slope
Object containing properties for the slope mode.
| Name |
Description |
Property Type |
| visible |
togglesToggles the visibility forof allthe slope mode functionalitybutton in the menu. |
Boolean |
| maxInstances |
The maximum number of concurrent lines allowedallowed. When this number is exceeded, the oldest lines will be removed first. |
Integer |
| line |
Object containing properties for the appearance of all presentslope linesmode lines. |
SlopeLineLine |
| label |
Object containing properties for the appearance of all slope mode line labellabels. |
Slope Label |
| axisHighlight |
Object containing properties for the highlights applied to each axis when selectedselected. |
AxisHighlight |
SlopeLineSlope.Line
| Name |
Description |
Property Type |
| stroke |
The color of the outline of slope mode lines |
Color |
| thickness |
The thickness of slope mode lines |
Integer |
| lineDash |
An array holding numeric values representing line dashingdashing. Enter an even amount of numbers to create a recurring pattern. |
Array |
| opacity |
The opacity of slope mode lines (1: opaque, 0: invisible) |
Integer |
Slope.Label
| Name |
Description |
Property Type |
| stroke |
The color of the outline of the line label |
Color |
| fill |
The color of the interior of the line label |
Color |
| fontFamily |
The font family of the text in the line label |
String |
| fontSize |
The size of the text in the line label |
Float |
Slope.AxisHighlight
| Name |
Description |
Property Type |
| fill |
The color of the axis highlight interior |
Color |
| stroke |
The color of the axis highlight outline |
Color |
| thickness |
The thickness of axis highlight outline |
Integer |
Finding the slope between 2 points on the chart is easy using the slope mode
ZoomToArea
Object containing properties for the zoomToArea mode.
| Name |
Description |
Property Type |
| axisHighlight |
Toggles the visibility of all zoomToArea functionality |
Boolean |
| animated |
Toggles whether the zoom is animated or instant |
Boolean |
PanAndZoom
Object containing properties for mouse/touch panning and pinch-zooming.
| Name |
Description |
Property Type |
| pinchZoom |
Object containing properties for pinch-zooming |
PinchZoom |
| zoomPan |
Object containing properties for zooming and panning |
ZoomPan |
| visible |
toggles the visibility for all zoomPan mode functionality |
Boolean |
| xAxisDrag |
Object containing properties |
Object |
| enabled |
Determines whether dragging on the x axis is enabled |
Boolean |
| yAxisDrag |
Object containing properties |
Object |
| enabled |
Determines whether dragging on the y axis is enabled |
Boolean |
| zoomExtents |
Object containing properties |
Object |
| enabled |
Determines whether zoom extents are enabled |
Boolean |
ZoomPan
| Name |
Description |
Property Type |
| enabled |
Toggles panning functionality |
Boolean |
| axes |
Object containing all axes with zoomPan functionality enabled. |
Axes |
| executeOn |
The input that triggers panning |
Enum (add ref) |
| xyDirection |
Object containing properties that allow panning and zooming to be limited by the x or y axes. |
xyDirection |
ZoomPan.PinchZoom
| Name |
Description |
Property Type |
| enabled |
Toggles pinch-zooming functionality |
Boolean |
| horizontalGrowthFactor |
Affects the zoom rate |
Float |
| verticalGrowthFactor |
Affects the zoom rate |
Float |
ZoomPan.axes
| Name |
Description |
Property Type |
| x |
All x axes with zoomPan enabled |
Array |
| y |
All y axes with zoomPan enabled |
Array |
If the axes prop is left empty, Ignition will behave as though it contains all axes.
ZoomPan.xyDirection
| Name |
Description |
Property Type |
| xDirection |
Allows panning only on the x axis |
String |
| yDirection |
Allows panning only on the y axis |
String |
| xyDirection |
Allows free panning on both axes |
String |
MouseWheelZoom
Object containing properties for mouse wheel zooming.
| Name |
Description |
Property Type |
Default |
| enabled |
Determines whether mouse wheel zooming is enabled |
Boolean |
true |
| growFactor |
Determines the rate of mouse wheel zooming (Should be set to a small numbernumber) |
Float |
0.001 |
| axes |
An object containing all axes with zoomPan functionality enabled. |
ObjectAxes |
{} |
Axes
| Name |
Description |
Property Type |
| x |
All x axes with mouse wheel zooming enabledenabled. |
Array |
[] |
| y |
All y axes with mouse wheel zooming enabledenabled. |
Array |
[] |
Overview
| Name |
Description |
Property Type |
| overview |
Object containing basic properties |
Object |
| visible |
Determines visibility |
Boolean |
| height |
??? |
Integer |
| axes |
??? |
Object |
| x |
|
Array |
| y |
|
Array |
Annotation
| Name |
Description |
Property Type |
| annotation |
Sets the annotation properties |
Object |
