abstractMarkupEntity

Super class for markup entities in the markup API.

Hierarchy

• MarkupEntityBase
  • MarkupEntity
    • MarkupArea
    • MarkupLine
    • MarkupText
    • MarkupArrow
    • MarkupCircle

Index

Properties

• id
• properties

Accessors

• isEnabled
• sheet

Methods

• clone
• copyTo
• isEqual
• markAsDeleted
• markAsUpdated
• onAdded
• onDelete
• onUpdate

Properties

publicreadonlyid

id: string

Inherited from MarkupEntityBase.id

publicreadonlyproperties

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

Inherited from MarkupEntityBase.properties

Accessors

isEnabled

• get isEnabled(): boolean
• set isEnabled(b: boolean): void

• Overrides MarkupEntityBase.isEnabled

  Returns true if the entity and the sheet it belongs to are both enabled, otherwise false.

  ---

  Returns boolean

• Overrides MarkupEntityBase.isEnabled

  Sets if entity is enabled

  ---

  Parameters

  • b: boolean

  Returns void

sheet

• get sheet(): MarkupSheet2D

• Returns the markup sheet that the entity is attached to

  ---

  Returns MarkupSheet2D

Methods

abstractclone

• clone(): MarkupEntityBase

• Overrides MarkupEntityBase.clone

  Makes a deep copy of this entity

  ---

  Returns MarkupEntityBase

abstractcopyTo

• copyTo(sheet: MarkupSheet2D): MarkupEntity

• Copy the entity to another markup sheet.

  ---

  Parameters

  • sheet: MarkupSheet2D

    Markup sheet to copy the entity to.

  Returns MarkupEntity

  The new markup entity.

abstractisEqual

• isEqual(o: MarkupEntityBase): boolean

• Overrides MarkupEntityBase.isEqual

  Compares if this entity is equal to another entity

  ---

  Parameters

  • o: MarkupEntityBase

  Returns boolean

markAsDeleted

• markAsDeleted(): boolean

• Overrides MarkupEntityBase.markAsDeleted

  Marks the entity as deleted in the MarkupSheet2D.

  ---

  Returns boolean

  true if object was deleted. Otherwise false.

markAsUpdated

• markAsUpdated(): boolean

• Overrides MarkupEntityBase.markAsUpdated

  Sets the entity as updated in the layer API.

  ---

  Returns boolean

  true if object did exist, otherwise false

onAdded

• onAdded(o: MergableObjectEventArgs<MarkupEntity>): void

• Overrides MarkupEntityBase.onAdded

  Called when this entity is added

  ---

  Parameters

  • o: MergableObjectEventArgs<MarkupEntity>

  Returns void

onDelete

• onDelete(o: MergableObjectEventArgs<MarkupEntity>): void

• Overrides MarkupEntityBase.onDelete

  Called when this entity is deleted

  ---

  Parameters

  • o: MergableObjectEventArgs<MarkupEntity>

  Returns void

onUpdate

• onUpdate(o: MergableObjectEventArgs<MarkupEntity>): void

• Overrides MarkupEntityBase.onUpdate

  Called when this entity is updated

  ---

  Parameters

  • o: MergableObjectEventArgs<MarkupEntity>

  Returns void