components/PointsEditor
Interfaces
PointProps
Defined in: components/PointsEditor/Point.tsx:29
Type Parameters
| Type Parameter |
|---|
T extends PointBaseType |
Properties
color?
optional color?: string;
Defined in: components/PointsEditor/Point.tsx:37
disabled?
optional disabled?: boolean;
Defined in: components/PointsEditor/Point.tsx:39
height?
optional height?: string | number;
Defined in: components/PointsEditor/Point.tsx:36
max?
optional max?: Partial<PointBaseType>;
Defined in: components/PointsEditor/Point.tsx:32
min?
optional min?: Partial<PointBaseType>;
Defined in: components/PointsEditor/Point.tsx:31
onChange?
optional onChange?: (value) => void;
Defined in: components/PointsEditor/Point.tsx:42
Parameters
| Parameter | Type |
|---|---|
value | PointBaseType |
Returns
void
onDragEnd?
optional onDragEnd?: (value) => void;
Defined in: components/PointsEditor/Point.tsx:44
Parameters
| Parameter | Type |
|---|---|
value | PointBaseType |
Returns
void
onDragStart?
optional onDragStart?: (value) => void;
Defined in: components/PointsEditor/Point.tsx:43
Parameters
| Parameter | Type |
|---|---|
value | PointBaseType |
Returns
void
readonly?
optional readonly?: boolean;
Defined in: components/PointsEditor/Point.tsx:40
size?
optional size?: string | number;
Defined in: components/PointsEditor/Point.tsx:34
value
value: T;
Defined in: components/PointsEditor/Point.tsx:30
width?
optional width?: string | number;
Defined in: components/PointsEditor/Point.tsx:35
PointsEditorProps
Defined in: components/PointsEditor/index.tsx:46
Properties
disabled?
optional disabled?: boolean;
Defined in: components/PointsEditor/index.tsx:54
externalStyles?
optional externalStyles?: object;
Defined in: components/PointsEditor/index.tsx:57
cursor?
optional cursor?: "none" | "move" | "grabbing" | "grab" | "pointer";
userSelectNone?
optional userSelectNone?: boolean;
grid?
optional grid?: number | PointBaseType;
Defined in: components/PointsEditor/index.tsx:51
height?
optional height?: string | number;
Defined in: components/PointsEditor/index.tsx:48
keyboard?
optional keyboard?: InputEventOption | null;
Defined in: components/PointsEditor/index.tsx:72
keyboard control option If null, no event will be triggered
readonly?
optional readonly?: boolean;
Defined in: components/PointsEditor/index.tsx:55
wheel?
optional wheel?: InputEventOption | null;
Defined in: components/PointsEditor/index.tsx:67
wheel control option If null, no event will be triggered
width?
optional width?: string | number;
Defined in: components/PointsEditor/index.tsx:47
Type Aliases
PointBaseType
type PointBaseType = object;
Defined in: components/PointsEditor/Point.tsx:16
Properties
x
x: number;
Defined in: components/PointsEditor/Point.tsx:16
y
y: number;
Defined in: components/PointsEditor/Point.tsx:16
Variables
PointsEditor
const PointsEditor: object;
Defined in: components/PointsEditor/index.tsx:121
Multiple Point Controller
Type Declaration
Background
Background: (__namedParameters) => Element;
Parameters
| Parameter | Type |
|---|---|
__namedParameters | ComponentPropsWithoutRef<"div"> |
Returns
Element
Container
Container: (__namedParameters) => Element;
Parameters
| Parameter | Type |
|---|---|
__namedParameters | ComponentPropsWithoutRef<"div"> |
Returns
Element
Point
Point: <T>(__namedParameters) => Element;
Type Parameters
| Type Parameter |
|---|
T extends PointBaseType |
Parameters
| Parameter | Type |
|---|---|
__namedParameters | PointProps<T> & Omit<Omit<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, keyof PointProps<T>> |
Returns
Element
Root
Root: ForwardRefExoticComponent<PointsEditorProps & Omit<Omit<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, keyof PointsEditorProps> & RefAttributes<HTMLDivElement>>;
Functions
clampPoint()
function clampPoint(
point,
min?,
max?): object;
Defined in: components/PointsEditor/Point.tsx:18
Parameters
| Parameter | Type |
|---|---|
point | PointBaseType |
min? | Partial<PointBaseType> |
max? | Partial<PointBaseType> |
Returns
object
x
x: number = newX;
y
y: number = newY;
usePointsEditorContext()
function usePointsEditorContext<T>(selector): T;
Defined in: components/PointsEditor/context.tsx:84
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
selector | (state) => T |
Returns
T