Skip to main content

Type Alias: PointsEditorContextValue

type PointsEditorContextValue = object;

Defined in: react/src/components/PointsEditor/context.tsx:10

Properties​

containerRef​

containerRef: RefObject<HTMLDivElement | null>;

Defined in: react/src/components/PointsEditor/context.tsx:25

Container registers its element here; Point normalizes the pointer against it, so a point is placed by its position within the container.

disabled​

disabled: boolean;

Defined in: react/src/components/PointsEditor/context.tsx:11

dragCursor​

dragCursor: CSSProperties["cursor"];

Defined in: react/src/components/PointsEditor/context.tsx:20

Inherited by every Point. See PointsEditorProps.dragCursor.

dragSensitivity​

dragSensitivity: ModifierValue<number>;

Defined in: react/src/components/PointsEditor/context.tsx:18

Inherited by every Point. See PointsEditorProps.dragSensitivity.

editor​

editor: PointsEditorInstance;

Defined in: react/src/components/PointsEditor/context.tsx:35

The selection and the moves, from createPointsEditor in @tremolo-ui/dom: every Point registers with it, and a press, a drag, a key or the wheel goes through it so that a selection moves as one.

keyboard​

keyboard: ModifierValue<InputEventOption> | null;

Defined in: react/src/components/PointsEditor/context.tsx:16

Inherited by every Point; null turns the keyboard off.

readOnly​

readOnly: boolean;

Defined in: react/src/components/PointsEditor/context.tsx:12

selectable​

selectable: boolean;

Defined in: react/src/components/PointsEditor/context.tsx:27

Whether points can be selected at all. See PointsEditorProps.selectable.

selection​

selection: readonly string[];

Defined in: react/src/components/PointsEditor/context.tsx:29

Ids of the points currently selected. Always empty while selectable is off.

selectionBox​

selectionBox: SelectionBoxRect | null;

Defined in: react/src/components/PointsEditor/context.tsx:37

The selection box, while one is being dragged.

wheel​

wheel: ModifierValue<InputEventOption> | null;

Defined in: react/src/components/PointsEditor/context.tsx:14

Inherited by every Point; null turns the wheel off.