graph » guide
guide
[ root » graph » guide ]
Use the guide object to set the styling attribute that applies to all the guide elements across the chart scales. overridden with local attributes in the individual scale object(s).
| Attribute | Type | Description |
|---|---|---|
| alpha | Number | Sets the opacity on the marker, with 0 being fully transparent and 1 being fully opaque. Note that decimal value requires the leading 0. Default Value: 1 |
| class | String | Sets a class value on the object. Default Value: null |
| dataN data-n | Any | Prefix attribute or array using "data-" to define a custom token. |
| exact | Boolean | Set to `true` to highlight plot nodes only when guide is directly next to the node. Set to `false` (default) to highlight plot nodes closest to guide. |
| id | String | Sets the id of the object. Default Value: '' |
| lineCap line-cap | String | Sets the stroke-linecap attribute on SVGs Accepted Values: ['butt', 'round', 'square'] Default Value: 'butt' |
| lineColor line-color | String | Sets the line color of the object, applicable on non-closed shapes. See also border-color for closed shapes. Default Value: '#000' |
| lineGapSize line-gap-size | Number | Can be used to create custom dashed or dotted lines when used with line-segment-size. This will control the size of the gaps between each line segment. Default Value: 0 |
| lineJoin line-join | String | Sets the stroke-linejoin attribute on SVGs Accepted Values: ['round', 'miter'] Default Value: 'round' |
| lineSegmentSize line-segment-size | Number | Can be used to create custom dashed or dotted lines when used with line-gap-size. This will control the size of the visible segment of line. Default Value: 0 |
| lineStyle line-style | String | Sets the line style of the object. Accepted Values: ['dashdot', 'dashed', 'dotted', 'solid'] Default Value: '' |
| lineWidth line-width | Number | Sets the line width of the object, applicable on non-closed shapes. See also border-width for closed shapes. Default Value: 0 |
| marker | Object | Sets the styling for markers. |
| mediaRules media-rules | Array.<Object> | Configure media rules. |
| plotLabel plot-label | Object | Configure crosshair plot label |
| reverseSeries reverse-series | Boolean | Reserves the order of items in plotLabel of stacked charts. Chart types: Stacked Bar |
| scaleLabel scale-label | Object | Configure crosshair scale label |
| shadow | Boolean | Sets whether the object's shadow is visible or not. Has limited effect on HTML5 implementation. Default Value: false |
| shadowAlpha shadow-alpha | Number | Sets the transparency of the shadow of the object. The higher the value, the less transparent the shadow will be. Default Value: 0.75 |
| shadowAngle shadow-angle | Number | Sets the angle of the shadow underneath the object. Default Value: 45 |
| shadowBlur shadow-blur | Number | Sets the blur effect size for the shadow of the object. Has limited effect on HTML5 implementation. Default Value: 0 |
| shadowColor shadow-color | String | Sets the color of the shadow of the object. Default Value: '#999' |
| shadowDistance shadow-distance | Number | Sets the distance between the shadow and the object. Default Value: 2 |
| shared | Boolean | Enables shared crosshairs when there are multiple charts in graphset. |
| singleLine single-line | Boolean | Used with `exact: false` to show all plot labels through only one crosshair line and scale label.
Typically used when null values are present and mulitple guide are showing. Default Value: false Introduced in: v2.6.1 |
| sticky | Boolean | Creates sticky object.
Use this with `timeout` to specify how long for object to stick to chart. Default Value: null |
| timeout | Number | Time in milliseconds for object to remain sticky.
Use this with `sticky` to specify whether object should stick to chart. Default Value: null |
| trigger | String | Sets the mode used to display crosshair plotLabels.
The "move" setting displays plotLabel for all nodes.
The "hover" setting displays plotLabel when node is hovered. Accepted Values: ['move', 'hover'] Default Value: 'move' |
| visible | Boolean | Sets the visibility of the object. Allows you to turn off the object without removing lines of JSON. Default Value: true |