Class CompassPlugin

Adds a compass on the viewer

Hierarchy

AbstractConfigurablePlugin<CompassPluginConfig, ParsedCompassPluginConfig, UpdatableCompassPluginConfig>
- CompassPlugin

Index

Constructors

Properties

config viewer VERSION configParser id readonlyOptions

Methods

addEventListener clearHotspots dispatchEvent hide removeEventListener setHotspots setOption setOptions show

Constructors

constructor

new CompassPlugin(viewer, config): CompassPlugin
Parameters
- viewer: Viewer
- config: CompassPluginConfig
Returns CompassPlugin
Overrides AbstractConfigurablePlugin.constructor
- Defined in compass-plugin/src/CompassPlugin.ts:43

Properties

`Readonly` config

config: ParsedCompassPluginConfig

`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<CompassPluginConfig, ParsedCompassPluginConfig> = getConfig

`Static` `Readonly` id

id: "compass" = 'compass'

Unique identifier of the plugin

`Static` `Readonly` readonlyOptions

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

Methods

addEventListener

addEventListener<T, E>(type, callback, options?): void
Type Parameters
- T extends never
  
  the name of event
- E extends never
  
  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 core/src/lib/TypedEventTarget.ts:29

clearHotspots

clearHotspots(): void
Removes all hotspots

Returns void
- Defined in compass-plugin/src/CompassPlugin.ts:136

dispatchEvent

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

hide

hide(): void
Hides the compass

Returns void
- Defined in compass-plugin/src/CompassPlugin.ts:114

removeEventListener

removeEventListener<T, E>(type, callback, options?): void
Type Parameters
- T extends never
  
  the name of event
- E extends never
  
  the class of the event
Parameters
- type: never
- callback: EventListenerObject | ((e) => void)
- Optional options: boolean | EventListenerOptions
  Optional
Returns void
Inherited from AbstractConfigurablePlugin.removeEventListener
- Defined in core/src/lib/TypedEventTarget.ts:41

setHotspots

setHotspots(hotspots): void
Changes the hotspots on the compass
Parameters
- hotspots: CompassHotspot[]
Returns void
- Defined in compass-plugin/src/CompassPlugin.ts:128

setOption

setOption<T>(option, value): void
Update options
Type Parameters
- T extends "size" | "className" | "position" | "backgroundSvg" | "coneColor" | "navigationColor" | "hotspots" | "hotspotColor"
Parameters
- option: T
- value: UpdatableCompassPluginConfig[T]
Returns void
Inherited from AbstractConfigurablePlugin.setOption
- Defined in core/src/plugins/AbstractPlugin.ts:68

setOptions

setOptions(options): void
Update options
Parameters
- options: Partial<UpdatableCompassPluginConfig>
Returns void
Overrides AbstractConfigurablePlugin.setOptions
- Defined in compass-plugin/src/CompassPlugin.ts:85

show

show(): void
Shows the compass

Returns void
- Defined in compass-plugin/src/CompassPlugin.ts:121

Generated using TypeDoc