Class MapPlugin

Adds a minimap on the viewer

Hierarchy

AbstractConfigurablePlugin<MapPluginConfig, ParsedMapPluginConfig, UpdatableMapPluginConfig, MapPluginEvents>
- MapPlugin

Index

Constructors

Properties

component config viewer VERSION configParser id readonlyOptions

Methods

addEventListener clearHotspots close dispatchEvent hide maximize minimize open removeEventListener setActiveHotspot setCenter setHotspots setImage setOption setOptions show

Constructors

constructor

new MapPlugin(viewer, config): MapPlugin
Parameters
- viewer: Viewer
- config: MapPluginConfig
Returns MapPlugin
Overrides AbstractConfigurablePlugin.constructor
- Defined in packages/map-plugin/src/MapPlugin.ts:82

Properties

`Readonly` component

component: MapComponent

`Readonly` config

config: ParsedMapPluginConfig

`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<MapPluginConfig, ParsedMapPluginConfig> = getConfig

`Static` `Readonly` id

id: "map" = 'map'

Unique identifier of the plugin

`Static` `Readonly` readonlyOptions

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

Methods

addEventListener

addEventListener<T, E>(type, callback, options?): void
Type Parameters
- T extends "select-hotspot"
  
  the name of event
- E extends events.SelectHotspot & {
  type: T;
  }
  
  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

clearHotspots

clearHotspots(): void
Removes all hotspots

Returns void
- Defined in packages/map-plugin/src/MapPlugin.ts:262

close

close(): void
Closes the map

Returns void
- Defined in packages/map-plugin/src/MapPlugin.ts:179

dispatchEvent

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

hide

hide(): void
Hides the map

Returns void
- Defined in packages/map-plugin/src/MapPlugin.ts:165

maximize

maximize(): void
Maximizes the map

Returns void
- Defined in packages/map-plugin/src/MapPlugin.ts:206

minimize

minimize(): void
Minimizes the map

Returns void
- Defined in packages/map-plugin/src/MapPlugin.ts:197

open

open(): void
Open the map

Returns void
- Defined in packages/map-plugin/src/MapPlugin.ts:188

removeEventListener

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

setActiveHotspot

setActiveHotspot(hotspotId): void
Changes the highlighted hotspot
Parameters
- hotspotId: string
Returns void
- Defined in packages/map-plugin/src/MapPlugin.ts:269

setCenter

setCenter(center): void
Changes the position on the map
Parameters
- center: Point
Returns void
- Defined in packages/map-plugin/src/MapPlugin.ts:230

setHotspots

setHotspots(hotspots, render?): void
Changes the hotspots on the map
Parameters
- hotspots: MapHotspot[]
- render: boolean = true
Returns void
- Defined in packages/map-plugin/src/MapPlugin.ts:238

setImage

setImage(url, center?, rotation?): void
Changes the image of the map
Parameters
- url: string
- Optional center: Point
  
  Also change the position on the map
  
  Optional
- Optional rotation: string | number
  
  Also change the image rotation
  
  Optional
Returns void
- Defined in packages/map-plugin/src/MapPlugin.ts:217

setOption

setOption<T>(option, value): void
Update options
Type Parameters
- T extends "center" | "size" | "position" | "rotation" | "overlayImage" | "pinImage" | "pinSize" | "coneColor" | "coneSize" | "spotStyle" | "static" | "minZoom" | "maxZoom" | "hotspots"
Parameters
- option: T
- value: UpdatableMapPluginConfig[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<UpdatableMapPluginConfig>
Returns void
Overrides AbstractConfigurablePlugin.setOptions
- Defined in packages/map-plugin/src/MapPlugin.ts:149

show

show(): void
Shows the map

Returns void
- Defined in packages/map-plugin/src/MapPlugin.ts:172

Generated using TypeDoc