Class PinModel

Index

Constructors

Methods

addPin clearPins getPinById getPins getSelectedPinId onEntitiesChanged onEntityAdded onEntityUpdated onSelectionChange removePin setPin setPins setSelectedPin updatePin

Constructors

constructor

new PinModel(): PinModel
Returns PinModel

Methods

addPin

addPin(pin: Pin, suppressEvent?: boolean): boolean
Registers an entity to be drawn in the canvas
Parameters
- pin: Pin
  A pin entity to draw.
- suppressEvent: boolean = false
Returns boolean
true if the entity has been added.
- Defined in packages/viewer/src/lib/pins/model.ts:95

clearPins

clearPins(): void
Clears all registered entities from the model.

Returns void
- Defined in packages/viewer/src/lib/pins/model.ts:115

getPinById

getPinById(id: string): Pin | undefined
Returns single entity by id if present in the model.
Parameters
- id: string
Returns Pin | undefined
- Defined in packages/viewer/src/lib/pins/model.ts:129

getPins

getPins(): Pin[]
Returns all the entities registered with the model.

Returns Pin[]
- Defined in packages/viewer/src/lib/pins/model.ts:122

getSelectedPinId

getSelectedPinId(): string | undefined
Returns string | undefined
- Defined in packages/viewer/src/lib/pins/model.ts:133

onEntitiesChanged

onEntitiesChanged(listener: Listener<Pin[]>): Disposable
Registers an event listener that will be invoked when the model's pin entities change.
Parameters
- listener: Listener<Pin[]>
  The listener to add.
Returns Disposable
A disposable that can be used to remove the listener.
- Defined in packages/viewer/src/lib/pins/model.ts:217

onEntityAdded

onEntityAdded(listener: Listener<Pin>): Disposable
Registers an event listener that will be invoked when a new pin is added to the model.
Parameters
- listener: Listener<Pin>
  The listener to add.
Returns Disposable
A disposable that can be used to remove the listener.
- Defined in packages/viewer/src/lib/pins/model.ts:228

onEntityUpdated

onEntityUpdated(listener: Listener<Pin>): Disposable
Registers an event listener that will be invoked when a pin is updated in the model.
Parameters
- listener: Listener<Pin>
  The listener to add.
Returns Disposable
A disposable that can be used to remove the listener.
- Defined in packages/viewer/src/lib/pins/model.ts:239

onSelectionChange

onSelectionChange(listener: Listener<string | undefined>): Disposable
Registers an event listener that will be invoked when the model's pin selection changes
Parameters
- listener: Listener<string | undefined>
  The listener to add.
Returns Disposable
A disposable that can be used to remove the listener.
- Defined in packages/viewer/src/lib/pins/model.ts:250

removePin

removePin(entity: Pin): boolean
Unregisters an entity from the model.
Parameters
- entity: Pin
  The entity to remove.
Returns boolean
true if the entity was removed.
- Defined in packages/viewer/src/lib/pins/model.ts:143

setPin

setPin(pin: Pin): boolean
Sets the set of entities to be placed with the model.
Parameters
- pin: Pin
  A pin to set
Returns boolean
true if the entity has been set
- Defined in packages/viewer/src/lib/pins/model.ts:173

setPins

setPins(pins: Set<Pin>): boolean
Sets the set of entities to be placed with the model.
Parameters
- pins: Set<Pin>
Returns boolean
true if the entity has been added.
- Defined in packages/viewer/src/lib/pins/model.ts:159

setSelectedPin

setSelectedPin(pinId?: string): void
Sets the selected pin id
Parameters
- OptionalpinId: string
Returns void
- Defined in packages/viewer/src/lib/pins/model.ts:258

updatePin

updatePin(pin: Pin): boolean
Updates a pin in the model.
Parameters
- pin: Pin
  A pin to update
Returns boolean
true if the entity has been updated
- Defined in packages/viewer/src/lib/pins/model.ts:195