actions/brush

6 notes, read out of this brain and free to use. Each one was extracted from a source and is re-checked against its exam.

brush action - set select-boxes

The brush action sets select-boxes (areas) in the chart when the brush behavior is performing. myChart.dispatchAction({type: 'brush', areas: [{geoIndex?: number, xAxisIndex?: number, yAxisIndex?: number, brushType?: 'polygon' | 'rect' | 'lineX' | 'lineY', range?: [...], coordRange?: [...]}]}). An empty areas array deletes all select-boxes. For global areas use range in pixels. For coordinate system areas use coordRange in coordinate units. For rect: range/coordRange is [[minX, maxX], [minY, maxY]]. For lineX/lineY: range/coordRange is [min, max]. For polygon: range/coordRange is [[point1X, point1Y], [point2X, point2Y], ...].

brushEnd action - version 4.5.0+

The brushEnd action is dispatched when the brush behavior finished. Parameters are the same as the brush action.

takeGlobalCursor action - brush

The takeGlobalCursor action enables or disables brush behavior. api.dispatchAction({type: 'takeGlobalCursor', key: 'brush', brushOption: {brushType?: string, brushMode?: string}}). Set brushType to false to disable brush. Triggers globalCursorTaken event.

brush action - set or delete selection boxes

The brush action sets or deletes chart selection boxes during brush interactions. Parameter: areas (array of selection box objects). Each box object contains: geoIndex/xAxisIndex/yAxisIndex (optional, specifies coordinate system), brushType ('polygon', 'rect', 'lineX', 'lineY'), range (for global boxes, pixel coordinates), coordRange (for coordinate system boxes). For 'rect': [[minX, maxX], [minY, maxY]]. For 'lineX'/'lineY': [min, max]. For 'polygon': [[x1, y1], [x2, y2], ...]. Empty areas array deletes all boxes. This is a full replacement interface, not incremental. Requires brush component to be enabled.

brushEnd action - auto-triggered after brush selection

The brushEnd action (v4.5.0+) is automatically triggered when a brush selection completes. Its parameters are identical to the brush action.

brush takeGlobalCursor action - toggle brush mode

The takeGlobalCursor action toggles brush selection mode. When key is 'brush', enables brush mode. Parameters: key ('brush'), brushOption (optional, contains brushType (string or false to disable), brushMode (string, defaults to brush component setting)). Triggers globalCursorTaken event. Requires brush component to be enabled.

Give your agent this brain