@inweb/viewer-visualize
    Preparing search index...

    Interface IMarkupCloud

    2D markup Cloud object interface.

    interface IMarkupCloud {
        delete(): void;
        enableMouseEditing(value: boolean): void;
        getColor(): string;
        getHeigth(): number;
        getLineWidth(): number;
        getPosition(): { x: number; y: number };
        getRotation(): number;
        getWidth(): number;
        getZIndex(): number;
        id(): string;
        ref(): any;
        setColor(hex: string): void;
        setHeight(h: number): void;
        setLineWidth(size: number): void;
        setPosition(x: number, y: number): void;
        setRotation(degrees: number): void;
        setWidth(w: number): void;
        setZIndex(zIndex: number): void;
        type(): string;
    }

    Hierarchy (View Summary)

    Index

    Methods

    delete enableMouseEditing getColor getHeigth getLineWidth getPosition getRotation getWidth getZIndex id ref setColor setHeight setLineWidth setPosition setRotation setWidth setZIndex type

    Methods

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

      Parameters

      • value: boolean

      Returns void

    • Returns the foreground color of an object's line or text as a string in hexadecimal color syntax #RGB using its primary color components (red, green, blue) written as hexadecimal numbers.

      Returns string

    • Returns the height of the cloud.

      Returns number

    • Returns the line width of the cloud.

      Returns number

    • Returns the coordinates of the top-left point (position) of the cloud.

      Returns { x: number; y: number }

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

      Returns number

    • Returns the width of the cloud.

      Returns 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

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

      Returns string

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

      Returns any

    • Sets the foreground color of an object's line or text.

      Parameters

      • hex: string

        Color in hexadecimal color syntax #RGB.

      Returns void

    • Sets the height of the cloud.

      Parameters

      • h: number

      Returns void

    • Sets the line width of the cloud.

      Parameters

      • size: number

      Returns void

    • Sets the coordinates of the top-left point (position) of the cloud.

      Parameters

      • x: number
      • y: number

      Returns void

    • Sets the rotation angle of the object.

      Parameters

      • degrees: number

        Number of degress to rotate.

      Returns void

    • Sets the width of the cloud.

      Parameters

      • w: number

      Returns 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

    • Returns the type of the object.

      Returns string

    Settings

    Member Visibility

    On This Page

    Methods