Annotation options used when creating a new drawing.
A list of renderable series to exclude from this modifier
A list of X axes to exclude from this modifier
A list of Y axes to exclude from this modifier
The primary action execute condition that modifier should respond to
A unique Id for the {@link ChartModifierBase2D}
A list of renderable series to include to this modifier
A list of X axes to include to this modifier
A list of Y axes to include this modifier
Starts modifier in active drawing mode.
Default false.
When true, drawing mode remains active after one stroke is finished.
Default false.
Upper bound for point count in one stroke. Values <= 0 disable the cap.
Default 6000.
Minimum pointer movement (in CSS pixels) required before adding a new point.
Default 2.
Defines the Modifier Group string - a grouping by ID for sharing mouse events across charts
Controls how often freehand segments are sampled while drawing (in CSS pixels).
Lower values produce smoother lines (more points), higher values produce fewer segments.
Default 2.
The secondary action execute condition that modifier should respond to
Optional post-process simplification tolerance in CSS pixels.
Default 0 (disabled).
The XAxis Id to be used by annotations internal to the modifier. Set if you have multiple x axes and need to distinguish between horizontal/vertical, or stacked axes
Defines the {@link EXyDirection | Xy Direction} - whether the modifier works in X, Y or XY or neither direction, for vertical charts the behaviour could be inverted, for example for vertical chart with {@link RubberBandXyZoomModifier} and {@link EXyDirection.XDirection} the modifier works on Y axis
The YAxis Id to be used by annotations internal to the modifier. Set if you have multiple y axes and need the modifier to use something other than the first one.
Generated using TypeDoc
Options for FreehandDrawingModifier.