Interface IMarkupObject

2D markup object interface.

interface IMarkupObject {
    delete(): void;
    enableMouseEditing(value: boolean): void;
    getRotation(): number;
    getZIndex(): number;
    id(): string;
    ref(): any;
    setRotation(degrees: number): void;
    setZIndex(zIndex: number): void;
    type(): string;
    updateScreenCoordinates(): void;
}

Hierarchy (View Summary)

Methods

delete enableMouseEditing getRotation getZIndex id ref setRotation setZIndex type updateScreenCoordinates

Methods

delete

  • delete(): void

  • Deletes the current object.

    Returns void

enableMouseEditing

  • enableMouseEditing(value: boolean): void

  • Enables or disables the ability to select and edit an object using the mouse.

    Parameters

    • value: boolean

    Returns void

getRotation

  • getRotation(): number

  • Returns the rotation angle of the object, in degress.

    Returns number

getZIndex

  • getZIndex(): number

  • Returns the Z-index of a object relative to sibling objects that are in the same group.

    Z-Index is not absolute (like in CSS). It is relative to parent object group only:

    • images - are olways at the bottom
    • texts - are olways on top
    • others - are always between images and texts

    Returns number

id

  • id(): string

  • Returns the internal identifier of the object. Not unique.

    Returns string

ref

  • ref(): any

  • Returns a reference to a core markup library object (Konva, VisualizeJS, etc.).

    Returns any

setRotation

  • setRotation(degrees: number): void

  • Sets the rotation angle of the object.

    Parameters

    • degrees: number

      Number of degress to rotate.

    Returns void

setZIndex

  • setZIndex(zIndex: number): void

  • Sets the Z-index of a object relative to sibling objects that are in the same group.

    Z-Index is not absolute (like in CSS). It is relative to parent object group only:

    • images - are olways at the bottom
    • texts - are olways on top
    • others - are always between images and texts

    Parameters

    • zIndex: number

      An integer value of Z-Index.

    Returns void

type

  • type(): string

  • Returns the type of the object.

    Returns string

updateScreenCoordinates

  • updateScreenCoordinates(): void

  • Update current screen coordinates with internal WCS-based. Only for resize.

    Returns void

Settings

Member Visibility

On This Page

Methods