You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/guide/options.md
+1
Original file line number
Diff line number
Diff line change
@@ -118,6 +118,7 @@ In addition to [chart](#chart)
118
118
119
119
*`id`: the annotation id
120
120
*`element`: the annotation element
121
+
*`elements`: the array which contains the already created annotation elements.
121
122
*`type`: `'annotation'`
122
123
123
124
The [annotation](#annotation) option context is passed to scriptable options in all other cases, except when resolving `id`, `type` or adjusting scale ranges. The same values resolved in `afterDataLimits` with [chart](#chart) context are again evaluated in `afterUpdate` with [annotation](#annotation) context.
| `height` | `number`\|`string` | `undefined` | Overrides the height of the image or canvas element. Could be set in pixel by a number, or in percentage of current height of image or canvas element by a string. If undefined, uses the height of the image or canvas element. It is used only when the content is an image or canvas element.
15
+
| `hitTolerance` | `number` | `undefined` | Amount of pixels to interact with annotations within some distance of the mouse point.
15
16
| `opacity` | `number` | `undefined` | Overrides the opacity of the image or canvas element. Could be set a number in the range 0.0 to 1.0, inclusive. If undefined, uses the opacity of the image or canvas element. It is used only when the content is an image or canvas element.
16
17
| `padding` | [`Padding`](../options.md#padding) | `6` | The padding to add around the text label.
17
18
| [`position`](#position) | `string`\|`{x: string, y: string}` | `'center'` | Anchor position of label in the annotation.
Copy file name to clipboardexpand all lines: docs/guide/types/box.md
+1
Original file line number
Diff line number
Diff line change
@@ -71,6 +71,7 @@ If one of the axes does not match an axis in the chart, the box will take the en
71
71
| `adjustScaleRange` | Should the scale range be adjusted if this annotation is out of range.
72
72
| `display` | Whether or not this annotation is visible.
73
73
| `drawTime` | See [drawTime](../options.md#draw-time).
74
+
| `hitTolerance` | Amount of pixels to interact with annotations within some distance of the mouse point.
74
75
| `id` | Identifies a unique id for the annotation and it will be stored in the element context. When the annotations are defined by an object, the id is automatically set using the key used to store the annotations in the object. When the annotations are configured by an array, the id, passed by this option in the annotation, will be used.
75
76
| `rotation` | Rotation of the box in degrees.
76
77
| `xMax` | Right edge of the box in units along the x axis.
Copy file name to clipboardexpand all lines: docs/guide/types/ellipse.md
+1
Original file line number
Diff line number
Diff line change
@@ -68,6 +68,7 @@ If one of the axes does not match an axis in the chart, the ellipse will take th
68
68
| `adjustScaleRange` | Should the scale range be adjusted if this annotation is out of range.
69
69
| `display` | Whether or not this annotation is visible.
70
70
| `drawTime` | See [drawTime](../options.md#draw-time).
71
+
| `hitTolerance` | Amount of pixels to interact with annotations within some distance of the mouse point.
71
72
| `id` | Identifies a unique id for the annotation and it will be stored in the element context. When the annotations are defined by an object, the id is automatically set using the key used to store the annotations in the object. When the annotations are configured by an array, the id, passed by this option in the annotation, will be used.
72
73
| `rotation` | Rotation of the ellipse in degrees, default is 0.
73
74
| `xMax` | Right edge of the ellipse in units along the x axis.
Copy file name to clipboardexpand all lines: docs/guide/types/label.md
+1
Original file line number
Diff line number
Diff line change
@@ -92,6 +92,7 @@ The 4 coordinates, xMin, xMax, yMin, yMax are optional. If not specified, the bo
92
92
| `display` | Whether or not this annotation is visible.
93
93
| `drawTime` | See [drawTime](../options.md#draw-time).
94
94
| `height` | Overrides the height of the image or canvas element. Could be set in pixel by a number, or in percentage of current height of image or canvas element by a string. If undefined, uses the height of the image or canvas element. It is used only when the content is an image or canvas element.
95
+
| `hitTolerance` | Amount of pixels to interact with annotations within some distance of the mouse point.
95
96
| `id` | Identifies a unique id for the annotation and it will be stored in the element context. When the annotations are defined by an object, the id is automatically set using the key used to store the annotations in the object. When the annotations are configured by an array, the id, passed by this option in the annotation, will be used.
96
97
| `padding` | The padding to add around the text label.
Copy file name to clipboardexpand all lines: docs/guide/types/line.md
+3
Original file line number
Diff line number
Diff line change
@@ -89,6 +89,8 @@ If `scaleID` is unset, then `xScaleID` and `yScaleID` are used to draw a line fr
89
89
| `display` | Whether or not this annotation is visible.
90
90
| `drawTime` | See [drawTime](../options.md#draw-time).
91
91
| `endValue` | End two of the line when a single scale is specified.
92
+
| `hitTolerance` | Amount of pixels to interact with annotations within some distance of the mouse point.
93
+
| `id` | Identifies a unique id for the annotation and it will be stored in the element context. When the annotations are defined by an object, the id is automatically set using the key used to store the annotations in the object. When the annotations are configured by an array, the id, passed by this option in the annotation, will be used.
92
94
| `scaleID` | ID of the scale in single scale mode. If unset, `xScaleID` and `yScaleID` are used.
93
95
| `value` | End one of the line when a single scale is specified.
94
96
| `xMax` | X coordinate of end two of the line in units along the x axis.
@@ -137,6 +139,7 @@ All of these options can be [Scriptable](../options.md#scriptable-options)
137
139
| `drawTime` | `string`\|`number` | `options.drawTime` | See [drawTime](../options#draw-time). Defaults to the line annotation draw time if unset.
| `height` | `number`\|`string` | `undefined` | Overrides the height of the image or canvas element. Could be set in pixel by a number, or in percentage of current height of image or canvas element by a string. If undefined, uses the height of the image or canvas element. It is used only when the content is an image or canvas element.
142
+
| `hitTolerance` | `number` | `undefined` | Amount of pixels to interact with annotations within some distance of the mouse point.
140
143
| `opacity` | `number` | `undefined` | Overrides the opacity of the image or canvas element. Could be set a number in the range 0.0 to 1.0, inclusive. If undefined, uses the opacity of the image or canvas element. It is used only when the content is an image or canvas element.
141
144
| `padding` | [`Padding`](../options.md#padding) | `6` | The padding to add around the text label.
142
145
| `position` | `string` | `'center'` | Anchor position of label on line. Possible options are: `'start'`, `'center'`, `'end'`. It can be set by a string in percentage format `'number%'` which are representing the percentage on the width of the line where the label will be located.
Copy file name to clipboardexpand all lines: docs/guide/types/point.md
+1
Original file line number
Diff line number
Diff line change
@@ -73,6 +73,7 @@ The 4 coordinates, xMin, xMax, yMin, yMax are optional. If not specified, the bo
73
73
| `adjustScaleRange` | Should the scale range be adjusted if this annotation is out of range.
74
74
| `display` | Whether or not this annotation is visible.
75
75
| `drawTime` | See [drawTime](../options.md#draw-time).
76
+
| `hitTolerance` | Amount of pixels to interact with annotations within some distance of the mouse point.
76
77
| `id` | Identifies a unique id for the annotation and it will be stored in the element context. When the annotations are defined by an object, the id is automatically set using the key used to store the annotations in the object. When the annotations are configured by an array, the id, passed by this option in the annotation, will be used.
Copy file name to clipboardexpand all lines: docs/guide/types/polygon.md
+1
Original file line number
Diff line number
Diff line change
@@ -78,6 +78,7 @@ The 4 coordinates, xMin, xMax, yMin, yMax are optional. If not specified, the bo
78
78
| `adjustScaleRange` | Should the scale range be adjusted if this annotation is out of range.
79
79
| `display` | Whether or not this annotation is visible.
80
80
| `drawTime` | See [drawTime](../options.md#draw-time).
81
+
| `hitTolerance` | Amount of pixels to interact with annotations within some distance of the mouse point.
81
82
| `id` | Identifies a unique id for the annotation and it will be stored in the element context. When the annotations are defined by an object, the id is automatically set using the key used to store the annotations in the object. When the annotations are configured by an array, the id, passed by this option in the annotation, will be used.
0 commit comments