Class MarkupCircle

Class representing a markup circle in the markup API.

Hierarchy (View Summary)

MarkupEntity
- MarkupCircle

Implements

MarkupStyle<MarkupCircleStyle>

Index

Properties

circlePoint id lineThickness properties radiusPoint style

Accessors

isEnabled sheet

Methods

clone copyFrom copyTo isEqual markAsDeleted markAsUpdated onAdded onDelete onUpdate

Properties

circlePoint

circlePoint: Vertex3

`Readonly`id

id: string

lineThickness

lineThickness: number

`Readonly`properties

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

radiusPoint

radiusPoint: Vertex3

style

style: { backgroundColor: Color4 } = ...

Accessors

isEnabled

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

Returns boolean
Inherited from MarkupEntity.isEnabled
set isEnabled(b: boolean): void
Sets if entity is enabled
Parameters
- b: boolean
Returns void
Inherited from MarkupEntity.isEnabled

sheet

get sheet(): MarkupSheet2D
Returns the markup sheet that the entity is attached to

Returns MarkupSheet2D
Inherited from MarkupEntity.sheet

Methods

clone

clone(): MarkupCircle
Makes a deep copy of this entity

Returns MarkupCircle
Overrides MarkupEntity.clone

copyFrom

copyFrom(circle: MarkupCircle): void
Parameters
- circle: MarkupCircle
Returns void

copyTo

copyTo(sheet: MarkupSheet2D): MarkupCircle
Copy the circle to another markup sheet.
Parameters
- sheet: MarkupSheet2D
  Markup sheet to copy the circle to.
Returns MarkupCircle
The new markup circle entity.

Overrides MarkupEntity.copyTo

isEqual

isEqual(o: MarkupCircle): boolean
Compares if this entity is equal to another entity
Parameters
- o: MarkupCircle
Returns boolean
Overrides MarkupEntity.isEqual

markAsDeleted

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

Returns boolean
true if object was deleted. Otherwise false.

Inherited from MarkupEntity.markAsDeleted

markAsUpdated

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

Returns boolean
true if object did exist, otherwise false

Inherited from MarkupEntity.markAsUpdated

onAdded

onAdded(o: MergableObjectEventArgs<MarkupEntity>): void
Called when this entity is added
Parameters
- o: MergableObjectEventArgs<MarkupEntity>
Returns void
Inherited from MarkupEntity.onAdded

onDelete

onDelete(o: MergableObjectEventArgs<MarkupEntity>): void
Called when this entity is deleted
Parameters
- o: MergableObjectEventArgs<MarkupEntity>
Returns void
Inherited from MarkupEntity.onDelete

onUpdate

onUpdate(o: MergableObjectEventArgs<MarkupCircle>): void
Called when this entity is updated
Parameters
- o: MergableObjectEventArgs<MarkupCircle>
Returns void
Overrides MarkupEntity.onUpdate