Interface: PointsEditorPointProps<T>

Defined in: react/src/components/PointsEditor/Point.tsx:34

Type Parameters

Type Parameter
T extends PointPosition

Properties

aria-label?

optional aria-label?: string | Partial<Record<"x" | "y", string>>;

Defined in: react/src/components/PointsEditor/Point.tsx:68

The accessible name of each axis. There are two range inputs inside the point, so this takes one name per axis; a single string names them both.

---

aria-valuetext?

optional aria-valuetext?: string | Partial<Record<"x" | "y", string>>;

Defined in: react/src/components/PointsEditor/Point.tsx:70

What the value of each axis means, when the number does not say it.

---

changeEndDelay?

optional changeEndDelay?: number;

Defined in: react/src/components/PointsEditor/Point.tsx:95

How long after the last wheel notch or arrow key the change counts as over, in milliseconds. Neither has an event that says it is done.

Default

500

---

color?

optional color?: string;

Defined in: react/src/components/PointsEditor/Point.tsx:52

Sets --color, for the theme to colour the point with.

---

disabled?

optional disabled?: boolean;

Defined in: react/src/components/PointsEditor/Point.tsx:55

Overrides the disabled of PointsEditor.Root.

---

id?

optional id?: string;

Defined in: react/src/components/PointsEditor/Point.tsx:45

How the selection refers to this point. One is generated when it is left out, which lasts as long as the point is mounted — give your own if the selection has to survive a remount, or be recognised in your own state.

---

keyboard?

optional keyboard?: ModifierValue<InputEventOption> | null;

Defined in: react/src/components/PointsEditor/Point.tsx:62

Overrides the keyboard of PointsEditor.Root.

---

max?

optional max?: Partial<PointPosition>;

Defined in: react/src/components/PointsEditor/Point.tsx:49

The highest position the point can take, per axis. An axis left out is 1.

---

min?

optional min?: Partial<PointPosition>;

Defined in: react/src/components/PointsEditor/Point.tsx:47

The lowest position the point can take, per axis. An axis left out is 0.

---

onChange?

optional onChange?: (value) => void;

Defined in: react/src/components/PointsEditor/Point.tsx:76

Called with the new position when the point is dragged or moved by the arrow keys or the wheel, including when it moves along with a selection.

Parameters

Parameter	Type
value	PointPosition

Returns

void

---

onChangeEnd?

optional onChangeEnd?: (value, source) => void;

Defined in: react/src/components/PointsEditor/Point.tsx:88

Called when that change ends, with where the point is: on release, or changeEndDelay after the last wheel notch or arrow key.

Parameters

Parameter	Type
value	PointPosition
source	ChangeSource

Returns

void

---

onChangeStart?

optional onChangeStart?: (value, source) => void;

Defined in: react/src/components/PointsEditor/Point.tsx:83

Called when a change of this point starts — a drag on it, the first wheel notch or arrow key while it has the focus — with where it is and what the change is made with. The points that move along with a selection report through onChange only: the change belongs to the point being operated.

Parameters

Parameter	Type
value	PointPosition
source	ChangeSource

Returns

void

---

readOnly?

optional readOnly?: boolean;

Defined in: react/src/components/PointsEditor/Point.tsx:57

Overrides the readOnly of PointsEditor.Root.

---

style?

optional style?: CSSProperties & object & object;

Defined in: react/src/components/PointsEditor/Point.tsx:97

Type Declaration

--color?

optional --color?: string | number;

--translate?

optional --translate?: string | number;

---

value

value: T;

Defined in: react/src/components/PointsEditor/Point.tsx:39

Where the point is, as { x, y } from 0 to 1 on each axis, with y growing downwards.

---

wheel?

optional wheel?: ModifierValue<InputEventOption> | null;

Defined in: react/src/components/PointsEditor/Point.tsx:60

Overrides the wheel of PointsEditor.Root.