Class MarkersPlugin

Displays various markers on the viewer

Hierarchy (View Summary)

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

Constructors

constructor

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

Properties

`Readonly`config

config: ParsedMarkersPluginConfig

`Protected`viewer

viewer: Viewer

`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)[] = ...

`Static` `Readonly`VERSION

VERSION: string = PKG_VERSION

Expected version of the core DO NOT USE on custom plugins

Methods

addEventListener

addEventListener<
    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 MarkersPluginEvents & { type: T },
>(
    type: T,
    callback: EventListenerObject | ((e: E) => void),
    options?: boolean | AddEventListenerOptions,
): 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 MarkersPluginEvents & { type: T }
  the class of the event
Parameters
- type: T
- callback: EventListenerObject | ((e: E) => void)
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from AbstractConfigurablePlugin.addEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:29

addMarker

addMarker(config: MarkerConfig, render?: boolean): 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:345

clearMarkers

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

dispatchEvent

dispatchEvent(e: MarkersPluginEvents): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference
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:391

getMarker

getMarker(markerId: string | MarkerConfig): 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:378

getMarkers

getMarkers(): Marker[]
Returns all the markers

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

getNbMarkers

getNbMarkers(): number
Returns the total number of markers

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

gotoMarker

gotoMarker(
markerId: string | MarkerConfig,
speed?: string | number,
): 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:490

hideAllMarkers

hideAllMarkers(): void
Hides all markers

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

hideAllTooltips

hideAllTooltips(): void
Hides all tooltips

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

hideMarker

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

hideMarkerPanel

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

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

hideMarkersList

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

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

hideMarkerTooltip

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

removeEventListener

removeEventListener<
    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 MarkersPluginEvents & { type: T },
>(
    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: E) => void),
    options?: boolean | EventListenerOptions,
): 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 MarkersPluginEvents & { type: T }
  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: E) => void)
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from AbstractConfigurablePlugin.removeEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:41

removeMarker

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

removeMarkers

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

renderMarkers

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

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

setMarkers

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

setOption

setOption<
    T extends "defaultHoverScale"
    | "clickEventOnMarker"
    | "gotoMarkerSpeed",
>(
    option: T,
    value: UpdatableMarkersPluginConfig[T],
): 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: Partial<UpdatableMarkersPluginConfig>): 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:273

showAllTooltips

showAllTooltips(): void
Displays all tooltips

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

showMarker

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

showMarkerPanel

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

showMarkersList

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

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

showMarkerTooltip

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

toggleAllMarkers

toggleAllMarkers(): void
Toggles all markers

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

toggleAllTooltips

toggleAllTooltips(): void
Toggles the visibility of all tooltips

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

toggleMarker

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

toggleMarkersList

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

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

updateMarker

updateMarker(config: MarkerConfig, render?: boolean): void
Updates the existing marker with the same id Every property can be changed but you can't change its type (Eg: image to html)
Parameters
- config: MarkerConfig
- render: boolean = true
Returns void
- Defined in packages/markers-plugin/src/MarkersPlugin.ts:399

Class MarkersPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MarkersPlugin

Properties

Readonlyconfig

Protectedviewer

Static ReadonlyconfigParser

Static Readonlyid

Static ReadonlyreadonlyOptions

Static ReadonlyVERSION

Methods

addEventListener

Type Parameters

Parameters

Returns void

addMarker

Parameters

Returns void

Throws

clearMarkers

Parameters

Returns void

dispatchEvent

Parameters

Returns boolean

getCurrentMarker

Returns Marker

getMarker

Parameters

Returns Marker

Throws

getMarkers

Returns Marker[]

getNbMarkers

Returns number

gotoMarker

Parameters

Returns Promise<void>

hideAllMarkers

Returns void

hideAllTooltips

Returns void

hideMarker

Parameters

Returns void

hideMarkerPanel

Returns void

hideMarkersList

Returns void

hideMarkerTooltip

Parameters

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

removeMarker

Parameters

Returns void

removeMarkers

Parameters

Returns void

renderMarkers

Returns void

setMarkers

Parameters

Returns void

setOption

Type Parameters

Parameters

Returns void

setOptions

Parameters

`Readonly`config

`Protected`viewer

`Static` `Readonly`configParser

`Static` `Readonly`id

`Static` `Readonly`readonlyOptions

`Static` `Readonly`VERSION