Class MarkersPlugin

Displays various markers on the viewer

Hierarchy

AbstractConfigurablePlugin<MarkersPluginConfig, ParsedMarkersPluginConfig, UpdatableMarkersPluginConfig, MarkersPluginEvents>
- MarkersPlugin

Constructors

constructor

new MarkersPlugin(viewer, config): MarkersPlugin
Parameters
- viewer: Viewer
- config: MarkersPluginConfig
Returns MarkersPlugin
Overrides AbstractConfigurablePlugin.constructor
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:118

Properties

`Readonly` config

config: ParsedMarkersPluginConfig

`Protected` viewer

viewer: Viewer

`Static` `Readonly` VERSION

VERSION: string = PKG_VERSION

Expected version of the core DO NOT USE on custom plugins

`Static` `Readonly` configParser

configParser: ConfigParser<MarkersPluginConfig, ParsedMarkersPluginConfig> = getConfig

`Static` `Readonly` id

id: "markers" = 'markers'

Unique identifier of the plugin

`Static` `Readonly` readonlyOptions

readonlyOptions: (keyof MarkersPluginConfig)[] = ...

Methods

addEventListener

addEventListener<T, E>(type, callback, options?): void
Type Parameters
- T extends "marker-visibility" | "goto-marker-done" | "leave-marker" | "enter-marker" | "select-marker" | "select-marker-list" | "unselect-marker" | "hide-markers" | "set-markers" | "show-markers" | "render-markers-list"
  
  the name of event
- E extends Object
  
  the class of the event
Parameters
- type: T
- callback: EventListenerObject | ((e) => void)
- Optional options: boolean | AddEventListenerOptions
  Optional
Returns void
Inherited from AbstractConfigurablePlugin.addEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:29

addMarker

addMarker(config, render?): void
Adds a new marker to viewer
Parameters
- config: MarkerConfig
- render: boolean = true
Returns void

Throws
PSVError when the marker's id is missing or already exists
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:324

clearMarkers

clearMarkers(render?): void
Removes all markers
Parameters
- render: boolean = true
Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:452

dispatchEvent

dispatchEvent(e): boolean
Parameters
- e: MarkersPluginEvents
Returns boolean
Inherited from AbstractConfigurablePlugin.dispatchEvent
- Defined in packages/core/src/lib/TypedEventTarget.ts:21

getCurrentMarker

getCurrentMarker(): Marker
Returns the last marker selected by the user

Returns Marker
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:368

getMarker

getMarker(markerId): Marker
Returns the internal marker object for a marker id
Parameters
- markerId: string | MarkerConfig
Returns Marker

Throws
PSVError when the marker cannot be found
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:355

getMarkers

getMarkers(): Marker[]
Returns all the markers

Returns Marker[]
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:316

getNbMarkers

getNbMarkers(): number
Returns the total number of markers

Returns number
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:309

gotoMarker

gotoMarker(markerId, speed?): Promise<void>
Rotate the view to face the marker
Parameters
- markerId: string | MarkerConfig
- speed: string | number = ...
Returns Promise<void>
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:465

hideAllMarkers

hideAllMarkers(): void
Hides all markers

Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:267

hideAllTooltips

hideAllTooltips(): void
Hides all tooltips

Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:298

hideMarker

hideMarker(markerId): void
Hides a marker
Parameters
- markerId: string | MarkerConfig
Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:491

hideMarkerPanel

hideMarkerPanel(): void
Closes the panel if currently showing the content of a marker

Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:548

hideMarkerTooltip

hideMarkerTooltip(markerId): void
Hides the tooltip of a marker
Parameters
- markerId: string | MarkerConfig
Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:514

hideMarkersList

hideMarkersList(): void
Closes side panel if it contains the list of markers

Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:603

removeEventListener

removeEventListener<T, E>(type, callback, options?): void
Type Parameters
- T extends "marker-visibility" | "goto-marker-done" | "leave-marker" | "enter-marker" | "select-marker" | "select-marker-list" | "unselect-marker" | "hide-markers" | "set-markers" | "show-markers" | "render-markers-list"
  
  the name of event
- E extends Object
  
  the class of the event
Parameters
- type: "marker-visibility" | "goto-marker-done" | "leave-marker" | "enter-marker" | "select-marker" | "select-marker-list" | "unselect-marker" | "hide-markers" | "set-markers" | "show-markers" | "render-markers-list"
- callback: EventListenerObject | ((e) => void)
- Optional options: boolean | EventListenerOptions
  Optional
Returns void
Inherited from AbstractConfigurablePlugin.removeEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:41

removeMarker

removeMarker(markerId, render?): void
Removes a marker from the viewer
Parameters
- markerId: string | MarkerConfig
- render: boolean = true
Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:396

removeMarkers

removeMarkers(markerIds, render?): void
Removes multiple markers
Parameters
- markerIds: string[]
- render: boolean = true
Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:426

renderMarkers

renderMarkers(): void
Updates the visibility and the position of all markers

Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:610

setMarkers

setMarkers(markers, render?): void
Replaces all markers
Parameters
- markers: MarkerConfig[]
- render: boolean = true
Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:437

setOption

setOption<T>(option, value): void
Update options
Type Parameters
- T extends "defaultHoverScale" | "clickEventOnMarker" | "gotoMarkerSpeed"
Parameters
- option: T
- value: UpdatableMarkersPluginConfig[T]
Returns void
Inherited from AbstractConfigurablePlugin.setOption
- Defined in packages/core/src/plugins/AbstractPlugin.ts:68

setOptions

setOptions(options): void
Update options
Parameters
- options: Partial<UpdatableMarkersPluginConfig>
Returns void
Inherited from AbstractConfigurablePlugin.setOptions
- Defined in packages/core/src/plugins/AbstractPlugin.ts:76

showAllMarkers

showAllMarkers(): void
Shows all markers

Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:258

showAllTooltips

showAllTooltips(): void
Displays all tooltips

Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:287

showMarker

showMarker(markerId): void
Shows a marker
Parameters
- markerId: string | MarkerConfig
Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:498

showMarkerPanel

showMarkerPanel(markerId): void
Opens the panel with the content of the marker
Parameters
- markerId: string | MarkerConfig
Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:532

showMarkerTooltip

showMarkerTooltip(markerId): void
Forces the display of the tooltip of a marker
Parameters
- markerId: string | MarkerConfig
Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:505

showMarkersList

showMarkersList(): void
Opens side panel with the list of markers

Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:566

toggleAllMarkers

toggleAllMarkers(): void
Toggles all markers

Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:247

toggleAllTooltips

toggleAllTooltips(): void
Toggles the visibility of all tooltips

Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:276

toggleMarker

toggleMarker(markerId, visible?): void
Toggles a marker visibility
Parameters
- markerId: string | MarkerConfig
- Optional visible: boolean
  Optional
Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:523

toggleMarkersList

toggleMarkersList(): void
Toggles the visibility of the list of markers

Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:555

updateMarker

updateMarker(config, render?): void
Updates the existing marker with the same id
Parameters
- config: MarkerConfig
- render: boolean = true
Returns void

Description
Every property can be changed but you can't change its type (Eg: image to html)
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:376

Class MarkersPlugin

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

viewer: Viewer

config: MarkersPluginConfig

Returns MarkersPlugin

Properties

Readonly config

Protected viewer

Static Readonly VERSION

Static Readonly configParser

Static Readonly id

Static Readonly readonlyOptions

Methods

addEventListener

Type Parameters

T extends "marker-visibility" | "goto-marker-done" | "leave-marker" | "enter-marker" | "select-marker" | "select-marker-list" | "unselect-marker" | "hide-markers" | "set-markers" | "show-markers" | "render-markers-list"

E extends Object

Parameters

type: T

callback: EventListenerObject | ((e) => void)

Optional options: boolean | AddEventListenerOptions

Returns void

addMarker

Parameters

config: MarkerConfig

render: boolean = true

Returns void

Throws

clearMarkers

Parameters

render: boolean = true

Returns void

dispatchEvent

Parameters

e: MarkersPluginEvents

Returns boolean

getCurrentMarker

Returns Marker

getMarker

Parameters

markerId: string | MarkerConfig

Returns Marker

Throws

getMarkers

Returns Marker[]

getNbMarkers

Returns number

gotoMarker

Parameters

markerId: string | MarkerConfig

speed: string | number = ...

Returns Promise<void>

hideAllMarkers

Returns void

hideAllTooltips

Returns void

hideMarker

Parameters

markerId: string | MarkerConfig

Returns void

hideMarkerPanel

Returns void

hideMarkerTooltip

Parameters

markerId: string | MarkerConfig

Returns void

hideMarkersList

Returns void

removeEventListener

Type Parameters

T extends "marker-visibility" | "goto-marker-done" | "leave-marker" | "enter-marker" | "select-marker" | "select-marker-list" | "unselect-marker" | "hide-markers" | "set-markers" | "show-markers" | "render-markers-list"

E extends Object

Parameters

`Readonly` config

`Protected` viewer

`Static` `Readonly` VERSION

`Static` `Readonly` configParser

`Static` `Readonly` id

`Static` `Readonly` readonlyOptions

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | EventListenerOptions

`Optional` visible: boolean