Stores info about active pointerdown events
The helper property to get and set the list of included renderable series
The helper property to get and set the list of included X axes
The helper property to get and set the list of included Y axes
Direction to which the modifier can be applied
Suppresses normal annotation selection/hover while this drawing tool is active.
Gets drawing mode state.
Gets or sets freehand point sampling distance (CSS pixels). Lower values make smoother lines.
Gets or sets freehand point sampling distance (CSS pixels). Lower values make smoother lines.
Checks execute condition
Checks execute primary and secondary conditions
Gets all series on the parent surface.
Returns all visible and included renderable series. The list also contains included visible stacked renderable series This calls this.testIsIncludedSeries so it is best to customise the including check behaviour there.
Returns the list of included X axes
Returns the list of included Y axes
Checks if event conditions should trigger the modifier action
current event info as {@link ModifierMouseArgs}
Grows the Axis by a fraction around the mouse point
the X,Y location of the mouse at the time of the operation
the Axis to grow or shrink
the fraction, e.g. 0.1 grows the axis by 10%
Includes all X and Y axes
Includes renderable series. Returns True if the included items list has changed after the operation.
Includes or excludes X axis
Includes or excludes Y axis
Starts drawing mode and optionally updates annotation options.
Stops drawing mode. Set cancelCurrent=false to keep an in-progress stroke.
Generated using TypeDoc
Chart modifier that turns pointer input into FreehandDrawingAnnotation instances.
While drawing is active, pointer-down creates a new annotation, pointer-move appends sampled points and pointer-up finalizes the stroke. The modifier can keep drawing mode active for repeated strokes, cap the maximum point count and simplify the finished path in screen space. It also activates the annotation interaction bypass so normal annotation hover and selection do not interfere while a stroke is being captured.