Interface IMarkupEllipse

2D markup Ellipse object interface.

interface IMarkupEllipse {
    delete(): void;
    enableMouseEditing(value: boolean): void;
    getColor(): string;
    getLineWidth(): number;
    getPosition(): { x: number; y: number };
    getRadiusX(): number;
    getRadiusY(): number;
    getRotation(): number;
    getZIndex(): number;
    id(): string;
    ref(): any;
    setColor(hex: string): void;
    setLineWidth(size: number): void;
    setPosition(x: number, y: number): void;
    setRadiusX(r: number): void;
    setRadiusY(r: number): void;
    setRotation(degrees: number): void;
    setZIndex(zIndex: number): void;
    type(): string;
    updateScreenCoordinates(): void;
}

Hierarchy (View Summary)

Methods

delete enableMouseEditing getColor getLineWidth getPosition getRadiusX getRadiusY getRotation getZIndex id ref setColor setLineWidth setPosition setRadiusX setRadiusY setRotation setZIndex type updateScreenCoordinates

Methods

delete

enableMouseEditing

  • enableMouseEditing(value: boolean): void

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

    Parameters

    • value: boolean

    Returns void

getColor

  • getColor(): string

  • 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

getLineWidth

  • getLineWidth(): number

  • Returns the line width of the ellipse.

    Returns number

getPosition

  • getPosition(): { x: number; y: number }

  • Returns the screen coordinates of the center point (position) of the ellipse.

    Returns { x: number; y: number }

getRadiusX

  • getRadiusX(): number

  • Returns the X radius of the ellipse.

    Returns number

getRadiusY

  • getRadiusY(): number

  • Returns the Y radius of the ellipse.

    Returns number

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

setColor

  • setColor(hex: string): void

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

    Parameters

    • hex: string

      Color in hexadecimal color syntax #RGB.

    Returns void

setLineWidth

  • setLineWidth(size: number): void

  • Sets the line width of the ellipse.

    Parameters

    • size: number

    Returns void

setPosition

  • setPosition(x: number, y: number): void

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

    Parameters

    • x: number
    • y: number

    Returns void

setRadiusX

  • setRadiusX(r: number): void

  • Sets the X radius of the ellipse.

    Parameters

    • r: number

    Returns void

setRadiusY

  • setRadiusY(r: number): void

  • Sets the X radius of the ellipse.

    Parameters

    • r: number

    Returns void

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

Settings

Member Visibility

On This Page

Methods