graph » crosshair-y
crosshair-y
[ root » graph » crosshair-y ]
Crosshairs are interactive labels that appear when users hover over the data points (or node values) on your chart. They can appear against the x- and/or y-axis, and are highly customizable. Crosshairs are much more efficient and performant compared to chart tooltips. Refer to the Crosshairs Tutorial for more information.
| 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. |
| 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 |
| mediaRules media-rules | Array.<Object> | Configure media rules. |
| 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 |
| 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 |
| type | String | Sets the mode for crosshair.
The "muliple" setting displays multiple plotLabels and crosshairY for all nodes.
The "single" setting displays single plotLabel for all nodes. Accepted Values: ['multiple', 'single'] Default Value: 'single' |
| visible | Boolean | Sets the visibility of the object. Allows you to turn off the object without removing lines of JSON. Default Value: true |