Variable seActionsConst

Type Declaration

• brush: ActionCreator<"brush">

  Sets brush selection areas programmatically.

  Param: payload

  areas defines the selection regions. Requires the BrushComponent to be registered via seSetup.

  Example

  dispatch(seActions.brush({ areas: [{ brushType: 'rect', range: [[10, 50], [20, 60]] }] }));
  Copy

• dataZoom: ActionCreator<"dataZoom">

  Programmatically sets the dataZoom range.

  Param: payload

  Use start/end for percentage-based range (0–100), or startValue/endValue for data value-based range. dataZoomIndex targets a specific dataZoom component.

  Example

  // Percentage range
  dispatch(seActions.dataZoom({ start: 20, end: 80 }));
  
  // Reset to full range
  dispatch(seActions.dataZoom({ start: 0, end: 100 }));
  Copy

• downplay: ActionCreator<"downplay">

  Reverses a highlight - restores all elements to their normal state.

  Param: payload

  Optional. Omitting all fields downplays the entire chart.

  Example

  // Downplay a specific item
  dispatch(seActions.downplay({ seriesIndex: 0, dataIndex: 3 }));
  
  // Downplay everything
  dispatch(seActions.downplay({}));
  Copy

• focusNodeAdjacency: ActionCreator<"focusNodeAdjacency">

  Highlights the adjacency of a node in a graph series.

  Param: payload

  seriesIndex + dataIndex identify the node.

  Example

  dispatch(seActions.focusNodeAdjacency({ seriesIndex: 0, dataIndex: 3 }));
  Copy

• geoRoam: ActionCreator<"geoRoam">

  Triggers a geo component roam (pan/zoom) action.

  Param: payload

  Optional. name targets a specific geo component by name.

  Example

  dispatch(seActions.geoRoam());
  Copy

• hideTip: ActionCreator<"hideTip">

  Hides the tooltip.

  Example

  dispatch(seActions.hideTip());
  Copy

• highlight: ActionCreator<"highlight">

  Highlights specified data graphics. Other elements are blurred unless notBlur is true.

  Param: payload

  Target by seriesIndex/seriesId/seriesName + dataIndex/name. All fields optional - omitting all highlights the entire series.

  Example

  // Highlight a single bar
  dispatch(seActions.highlight({ seriesIndex: 0, dataIndex: 3 }));
  
  // Highlight without blurring others
  dispatch(seActions.highlight({ seriesIndex: 0, dataIndex: 3, notBlur: true }));
  Copy

• legendAllSelect: ActionCreator<"legendAllSelect">

  Selects all legend items - makes all series visible.

  Example

  dispatch(seActions.legendAllSelect());
  Copy

• legendInverseSelect: ActionCreator<"legendInverseSelect">

  Inverts the selected state of all legend items.

  Example

  dispatch(seActions.legendInverseSelect());
  Copy

• legendSelect: ActionCreator<"legendSelect">

  Selects (shows) a legend item by name.

  Param: payload

  name must match a series name exactly.

  Example

  dispatch(seActions.legendSelect({ name: 'Revenue' }));
  Copy

• legendToggleSelect: ActionCreator<"legendToggleSelect">

  Toggles the selected state of a legend item by name.

  Param: payload

  name must match a series name exactly.

  Example

  dispatch(seActions.legendToggleSelect({ name: 'Revenue' }));
  Copy

• legendUnSelect: ActionCreator<"legendUnSelect">

  Unselects (hides) a legend item by name.

  Param: payload

  name must match a series name exactly.

  Example

  dispatch(seActions.legendUnSelect({ name: 'Expenses' }));
  Copy

• restore: ActionCreator<"restore">

  Resets the chart to its initial state - reverses all user interactions including zoom, legend selections, and data selections.

  Example

  dispatch(seActions.restore());
  Copy

• select: ActionCreator<"select">

  Selects specified data. Requires selectedMode on the series option ("single", "multiple", or true) - without it the action fires but has no visual effect.

  Param: payload

  Target by seriesIndex + dataIndex or name. dataIndex accepts an array for bulk selection.

  Example

  dispatch(seActions.select({ seriesIndex: 0, dataIndex: 2 }));
  
  // Bulk select
  dispatch(seActions.select({ seriesIndex: 0, dataIndex: [0, 1, 2] }));
  Copy

• showTip: ActionCreator<"showTip">

  Shows the tooltip at a specific data point or pixel coordinate.

  Param: payload

  Use seriesIndex + dataIndex to position at a data point, or x + y for pixel coordinates.

  Example

  // Show at data point
  dispatch(seActions.showTip({ seriesIndex: 0, dataIndex: 3 }));
  
  // Show at pixel coordinates
  dispatch(seActions.showTip({ x: 100, y: 200 }));
  Copy

• timelineChange: ActionCreator<"timelineChange">

  Changes the current timeline index.

  Param: payload

  currentIndex is the zero-based index to jump to.

  Example

  dispatch(seActions.timelineChange({ currentIndex: 2 }));
  Copy

• timelinePlayChange: ActionCreator<"timelinePlayChange">

  Sets the timeline play state.

  Param: payload

  playState - true to play, false to pause.

  Example

  dispatch(seActions.timelinePlayChange({ playState: true }));
  Copy

• toggleSelect: ActionCreator<"toggleSelect">

  Toggles selection state on specified data. Selects if unselected, deselects if selected. Requires selectedMode on the series.

  Param: payload

  Target by seriesIndex + dataIndex or name.

  Example

  dispatch(seActions.toggleSelect({ seriesIndex: 0, dataIndex: 5 }));
  Copy

• unfocusNodeAdjacency: ActionCreator<"unfocusNodeAdjacency">

  Clears the adjacency highlight on a graph series node.

  Param: payload

  Optional. seriesIndex targets a specific graph series.

  Example

  dispatch(seActions.unfocusNodeAdjacency({ seriesIndex: 0 }));
  Copy

• unselect: ActionCreator<"unselect">

  Clears selection on specified data. dataIndex accepts an array for bulk unselect - pass all indices to clear the entire series.

  Param: payload

  Optional. Target by seriesIndex + dataIndex or name.

  Example

  // Unselect all items in a series
  dispatch(seActions.unselect({ seriesIndex: 0, dataIndex: [...data.keys()] }));
  Copy