Interface: DragValueOptions
Defined in: dom/src/pointer/drag-value.ts:214
Properties
axis
axis:
| AxisOptions
| readonly [AxisOptions, AxisOptions];
Defined in: dom/src/pointer/drag-value.ts:216
Scaling of each axis; a single value applies to both.
cursor?
optional cursor?: string;
Defined in: dom/src/pointer/drag-value.ts:242
See
DragOptions.cursor
getValue?
optional getValue?: () => XY<number>;
Defined in: dom/src/pointer/drag-value.ts:225
The current value of each axis. Read when a drag starts, by mappings that move the value relative to it, such as relativeMapping.
Returns
XY<number>
mapping
mapping: DragValueMapping;
Defined in: dom/src/pointer/drag-value.ts:219
How pointer movement becomes a position.
onChange?
optional onChange?: (value, state) => void;
Defined in: dom/src/pointer/drag-value.ts:254
Parameters
| Parameter | Type |
|---|---|
value | XY<number> |
state | DragState |
Returns
void
onDragEnd?
optional onDragEnd?: (value, state) => void;
Defined in: dom/src/pointer/drag-value.ts:256
Parameters
| Parameter | Type |
|---|---|
value | XY<number> |
state | DragState |
Returns
void
onDragStart?
optional onDragStart?: (value, state) => void;
Defined in: dom/src/pointer/drag-value.ts:255
Parameters
| Parameter | Type |
|---|---|
value | XY<number> |
state | DragState |
Returns
void
pointerLock?
optional pointerLock?: boolean;
Defined in: dom/src/pointer/drag-value.ts:250
See
DragOptions.pointerLock
Only for a mapping that moves the value relative to where it stood, such as relativeMapping. elementMapping reads the pointer position, and there is none while it is locked.
shouldStart?
optional shouldStart?: (event) => boolean;
Defined in: dom/src/pointer/drag-value.ts:252
Parameters
| Parameter | Type |
|---|---|
event | PointerEvent |
Returns
boolean
See
DragOptions.shouldStart
threshold?
optional threshold?: number;
Defined in: dom/src/pointer/drag-value.ts:240
See
DragOptions.threshold
updateOnPointerDown?
optional updateOnPointerDown?: boolean;
Defined in: dom/src/pointer/drag-value.ts:237
Report the value on pointer down, before any movement.
Enable it where the pointer position is the value, so that a plain click jumps to it. Leave it off where the element being dragged is an object in its own right, so that grabbing its edge does not shift it under the pointer.
Default
false