Skip to main content

MarkupArrow

Class representing a markup arrow in the markup API.

Hierarchy

Implements

Index

Properties

arrowHeight

arrowHeight: number

arrowPoint

arrowPoint: Vertex3

arrowWidth

arrowWidth: number

bluntPoint

bluntPoint: Vertex3

publicreadonlyid

id: string

lineThickness

lineThickness: number

publicreadonlyproperties

properties: Map<string, MarkupProperty> = ...

style

style: { backgroundColor: Color4 } = ...

Type declaration

  • backgroundColor: Color4

Accessors

isEnabled

  • get isEnabled(): boolean
  • set isEnabled(b: boolean): void
  • Returns true if the entity and the sheet it belongs to are both enabled, otherwise false.


    Returns boolean

  • Sets if entity is enabled


    Parameters

    • b: boolean

    Returns void

sheet

  • Returns the markup sheet that the entity is attached to


    Returns MarkupSheet2D

Methods

clone

  • Makes a deep copy of this entity


    Returns MarkupArrow

copyFrom

copyTo

  • Copy the arrow to another markup sheet.


    Parameters

    Returns MarkupArrow

    The new markup arrow entity.

isEqual

  • Compares if this entity is equal to another entity


    Parameters

    Returns boolean

markAsDeleted

  • markAsDeleted(): boolean
  • Marks the entity as deleted in the MarkupSheet2D.


    Returns boolean

    true if object was deleted. Otherwise false.

markAsUpdated

  • markAsUpdated(): boolean
  • Sets the entity as updated in the layer API.


    Returns boolean

    true if object did exist, otherwise false

onAdded

onDelete

onUpdate