Interface TextProps

interface TextProps {
    anchorX?: number;
    anchorY?: number;
    anid?: string;
    batch?: boolean;
    clipPath?: Path<PathProps>;
    culling?: boolean;
    cursor?: string;
    draggable?: boolean | "horizontal" | "vertical";
    drift?: ((dx, dy, e?) => void);
    extra?: Dictionary<unknown>;
    globalScaleRatio?: number;
    ignore?: boolean;
    ignoreClip?: boolean;
    ignoreCoarsePointer?: boolean;
    incremental?: boolean;
    invisible?: boolean;
    isGroup?: boolean;
    name?: string;
    onclick?: ElementEventCallback<unknown, unknown>;
    oncontextmenu?: ElementEventCallback<unknown, unknown>;
    ondblclick?: ElementEventCallback<unknown, unknown>;
    ondrag?: ElementEventCallback<unknown, unknown>;
    ondragend?: ElementEventCallback<unknown, unknown>;
    ondragenter?: ElementEventCallback<unknown, unknown>;
    ondragleave?: ElementEventCallback<unknown, unknown>;
    ondragover?: ElementEventCallback<unknown, unknown>;
    ondragstart?: ElementEventCallback<unknown, unknown>;
    ondrop?: ElementEventCallback<unknown, unknown>;
    onmousedown?: ElementEventCallback<unknown, unknown>;
    onmousemove?: ElementEventCallback<unknown, unknown>;
    onmouseout?: ElementEventCallback<unknown, unknown>;
    onmouseover?: ElementEventCallback<unknown, unknown>;
    onmouseup?: ElementEventCallback<unknown, unknown>;
    onmousewheel?: ElementEventCallback<unknown, unknown>;
    originX?: number;
    originY?: number;
    progressive?: boolean;
    rectHover?: boolean;
    rotation?: number;
    scaleX?: number;
    scaleY?: number;
    silent?: boolean;
    skewX?: number;
    skewY?: number;
    style?: TextStyleProps;
    textConfig?: ElementTextConfig;
    textContent?: Text;
    x?: number;
    y?: number;
    z?: number;
    z2?: number;
    zlevel?: number;
}

Hierarchy (view full)

Properties

anchorX? anchorY? anid? batch? clipPath? culling? cursor? draggable? drift? extra? globalScaleRatio? ignore? ignoreClip? ignoreCoarsePointer? incremental? invisible? isGroup? name? onclick? oncontextmenu? ondblclick? ondrag? ondragend? ondragenter? ondragleave? ondragover? ondragstart? ondrop? onmousedown? onmousemove? onmouseout? onmouseover? onmouseup? onmousewheel? originX? originY? progressive? rectHover? rotation? scaleX? scaleY? silent? skewX? skewY? style? textConfig? textContent? x? y? z? z2? zlevel?

Properties

Optional anchorX

anchorX?: number

Will translated the element to the anchor position before applying other transforms.

Optional anchorY

anchorY?: number

Optional anid

anid?: string

Optional batch

batch?: boolean

Optional clipPath

clipPath?: Path<PathProps>

Optional culling

culling?: boolean

Optional cursor

cursor?: string

Optional draggable

draggable?: boolean | "horizontal" | "vertical"

Optional drift

drift?: ((dx, dy, e?) => void)

Type declaration

    • (dx, dy, e?): void

    • Drift element

      Parameters

      • dx: number

        dx on the global space

      • dy: number

        dy on the global space

      • Optional e: ElementEvent

      Returns void

Optional extra

extra?: Dictionary<unknown>

Optional globalScaleRatio

globalScaleRatio?: number

Optional ignore

ignore?: boolean

Optional ignoreClip

ignoreClip?: boolean

Optional ignoreCoarsePointer

ignoreCoarsePointer?: boolean

Optional incremental

incremental?: boolean

Optional invisible

invisible?: boolean

Optional isGroup

isGroup?: boolean

Optional name

name?: string

Optional onclick

onclick?: ElementEventCallback<unknown, unknown>

Optional oncontextmenu

oncontextmenu?: ElementEventCallback<unknown, unknown>

Optional ondblclick

ondblclick?: ElementEventCallback<unknown, unknown>

Optional ondrag

ondrag?: ElementEventCallback<unknown, unknown>

Optional ondragend

ondragend?: ElementEventCallback<unknown, unknown>

Optional ondragenter

ondragenter?: ElementEventCallback<unknown, unknown>

Optional ondragleave

ondragleave?: ElementEventCallback<unknown, unknown>

Optional ondragover

ondragover?: ElementEventCallback<unknown, unknown>

Optional ondragstart

ondragstart?: ElementEventCallback<unknown, unknown>

Optional ondrop

ondrop?: ElementEventCallback<unknown, unknown>

Optional onmousedown

onmousedown?: ElementEventCallback<unknown, unknown>

Optional onmousemove

onmousemove?: ElementEventCallback<unknown, unknown>

Optional onmouseout

onmouseout?: ElementEventCallback<unknown, unknown>

Optional onmouseover

onmouseover?: ElementEventCallback<unknown, unknown>

Optional onmouseup

onmouseup?: ElementEventCallback<unknown, unknown>

Optional onmousewheel

onmousewheel?: ElementEventCallback<unknown, unknown>

Optional originX

originX?: number

Origin of scale, rotation, skew

Optional originY

originY?: number

Optional progressive

progressive?: boolean

Optional rectHover

rectHover?: boolean

Optional rotation

rotation?: number

Optional scaleX

scaleX?: number

Optional scaleY

scaleY?: number

Optional silent

silent?: boolean

Optional skewX

skewX?: number

Optional skewY

skewY?: number

Optional style

style?: TextStyleProps

Optional textConfig

textConfig?: ElementTextConfig

Optional textContent

textContent?: Text

Optional x

x?: number

Optional y

y?: number

Optional z

z?: number

Optional z2

z2?: number

Optional zlevel

zlevel?: number

Settings

Member Visibility

Theme

On This Page