Class CompassPlugin

Adds a compass on the viewer

Hierarchy (View Summary)

AbstractConfigurablePlugin<CompassPluginConfig, ParsedCompassPluginConfig>
- CompassPlugin

Index

Constructors

Properties

config viewer configParser id readonlyOptions VERSION

Methods

addEventListener clearHotspots dispatchEvent hide removeEventListener setHotspots setOption setOptions show withConfig

Constructors

constructor

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

Properties

`Readonly`config

config: ParsedCompassPluginConfig

`Protected`viewer

viewer: Viewer

`Static` `Readonly`configParser

configParser: ConfigParser<CompassPluginConfig, ParsedCompassPluginConfig> = getConfig

`Static` `Readonly`id

id: "compass" = 'compass'

Unique identifier of the plugin

`Static`readonlyOptions

readonlyOptions: string[] = []

`Static` `Readonly`VERSION

VERSION: string = PKG_VERSION

Expected version of the core DO NOT USE on custom plugins

Methods

addEventListener

addEventListener<T extends never, E extends never>(
    type: T,
    callback: EventListenerObject | ((e: E) => void),
    options?: boolean | AddEventListenerOptions,
): void
Type Parameters
- T extends never
  the name of event
- E extends never
  the class of the event
Parameters
- type: T
- callback: EventListenerObject | ((e: E) => void)
- Optionaloptions: boolean | AddEventListenerOptions
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:139

dispatchEvent

dispatchEvent(e: never): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

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

removeEventListener

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

setHotspots

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

setOption

setOption<T extends keyof CompassPluginConfig>(
option: T,
value: CompassPluginConfig[T],
): void
Update options
Type Parameters
- T extends keyof CompassPluginConfig
Parameters
- option: T
- value: CompassPluginConfig[T]
Returns void
Inherited from AbstractConfigurablePlugin.setOption
- Defined in core/src/plugins/AbstractPlugin.ts:68

setOptions

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

show

show(): void
Shows the compass

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

`Static`withConfig

withConfig(config: CompassPluginConfig): [PluginConstructor, any]
Parameters
- config: CompassPluginConfig
Returns [PluginConstructor, any]
- Defined in compass-plugin/src/CompassPlugin.ts:42