MarkupArea

Class representing a markup area in the markup API.

Hierarchy

• MarkupEntity
  • MarkupArea

Implements

• MarkupStyle<MarkupAreaStyle>

Index

Properties

• id
• points
• properties
• style

Accessors

• isEnabled
• sheet

Methods

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

Properties

publicreadonlyid

id: string

Inherited from MarkupEntity.id

points

points: Vertex3[]

publicreadonlyproperties

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

Inherited from MarkupEntity.properties

style

style: { backgroundColor: Color4 } = ...

Implementation of MarkupStyle.style

Type declaration

• backgroundColor: Color4

Accessors

isEnabled

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

• Inherited from MarkupEntity.isEnabled

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

  ---

  Returns boolean

• Inherited from MarkupEntity.isEnabled

  Sets if entity is enabled

  ---

  Parameters

  • b: boolean

  Returns void

sheet

• get sheet(): MarkupSheet2D

• Inherited from MarkupEntity.sheet

  Returns the markup sheet that the entity is attached to

  ---

  Returns MarkupSheet2D

Methods

clone

• clone(): MarkupArea

• Overrides MarkupEntity.clone

  Makes a deep copy of this entity

  ---

  Returns MarkupArea

copyFrom

• copyFrom(area: MarkupArea): void

• Parameters

  • area: MarkupArea

  Returns void

copyTo

• copyTo(sheet: MarkupSheet2D): MarkupArea

• Overrides MarkupEntity.copyTo

  Copy the area to another markup sheet.

  ---

  Parameters

  • sheet: MarkupSheet2D

    Markup sheet to copy the area to.

  Returns MarkupArea

  The new markup area entity.

isEqual

• isEqual(o: MarkupArea): boolean

• Overrides MarkupEntity.isEqual

  Compares if this entity is equal to another entity

  ---

  Parameters

  • o: MarkupArea

  Returns boolean

markAsDeleted

• markAsDeleted(): boolean

• Inherited from MarkupEntity.markAsDeleted

  Marks the entity as deleted in the MarkupSheet2D.

  ---

  Returns boolean

  true if object was deleted. Otherwise false.

markAsUpdated

• markAsUpdated(): boolean

• Inherited from MarkupEntity.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

• Inherited from MarkupEntity.onAdded

  Called when this entity is added

  ---

  Parameters

  • o: MergableObjectEventArgs<MarkupEntity>

  Returns void

onDelete

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

• Inherited from MarkupEntity.onDelete

  Called when this entity is deleted

  ---

  Parameters

  • o: MergableObjectEventArgs<MarkupEntity>

  Returns void

onUpdate

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

• Overrides MarkupEntity.onUpdate

  Called when this entity is updated

  ---

  Parameters

  • o: MergableObjectEventArgs<MarkupArea>

  Returns void