ESM
import { ActionModes, CursorRange } from "@arcgis/charts-components/utils/cursor/interfaces.js";

Variables

ActionModes

Variable

Specifies how user interactions on the chart are handled.

  • monoSelection: Select one data point or series at a time. Each new selection replaces the previous selection.
  • multiSelection: Select multiple data points or series. Each new selection is added to the existing selection.
  • multiSelectionWithCtrlKey: Select multiple data points or series only while holding Ctrl (or Cmd on macOS). Without the key, selection behaves like monoSelection.
  • zoom: Zoom into an area of the chart.
  • none: Disable interaction-driven selection and zoom actions.

Note: Not applicable to gauges.

Type
{ readonly MonoSelection: "monoSelection"; readonly MultiSelection: "multiSelection"; readonly MultiSelectionWithCtrlKey: "multiSelectionWithCtrlKey"; readonly Zoom: "zoom"; readonly None: "none"; }

CursorRange

Variable

Defines how the cursor selection rectangle is constrained when actionMode is zoom, multiSelection, or multiSelectionWithCtrlKey.

  • multi-axes: Allows drawing a free rectangle across both axes.
  • x-axis: Constrains the rectangle to the x-axis direction.
  • y-axis: Constrains the rectangle to the y-axis direction.
  • undefined: Uses the default behavior for the current chart type and action mode.

Note: Not applicable to gauges.

Type
{ readonly MultiAxes: "multi-axes"; readonly XAxis: "x-axis"; readonly YAxis: "y-axis"; }

Type definitions

ActionModes

Type definition
Type
(typeof ActionModes)[keyof typeof ActionModes]

CursorRange

Type definition
Type
(typeof CursorRange)[keyof typeof CursorRange]