Class MapPlugin

Adds a minimap on the viewer

Hierarchy (view full)

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

Index

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:83

Properties

`Readonly`component

component: MapComponent

`Readonly`config

config: ParsedMapPluginConfig

`Protected`viewer

viewer: Viewer

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

`Static` `Readonly`VERSION

VERSION: string = PKG_VERSION

Expected version of the core DO NOT USE on custom plugins

Methods

addEventListener

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

clearHotspots

clearHotspots(): void
Removes all hotspots

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

close

close(): void
Closes the map

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

dispatchEvent

dispatchEvent(e): 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: MapPluginEvents
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:168

maximize

maximize(): void
Maximizes the map

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

minimize

minimize(): void
Minimizes the map

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

open

open(): void
Open the map

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

removeEventListener

removeEventListener<T, E>(type, callback, options?): void
Type Parameters
- T extends "select-hotspot" | "view-changed"
  the name of event
- E extends MapPluginEvents & {
  type: T;
  }
  the class of the event
Parameters
- type: "select-hotspot" | "view-changed"
- callback: EventListenerObject | ((e: E) => void)
- Optionaloptions: boolean | EventListenerOptions
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:279

setCenter

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

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:248

setImage

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

setOption

setOption<T>(option, value): void
Update options
Type Parameters
- T extends
      | "center"
      | "size"
      | "position"
      | "rotation"
      | "shape"
      | "overlayImage"
      | "pinImage"
      | "pinSize"
      | "coneColor"
      | "coneSize"
      | "spotStyle"
      | "static"
      | "minZoom"
      | "maxZoom"
      | "hotspots"
      | "minimizeOnHotspotClick"
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:152

setZoom

setZoom(level): void
Changes the current zoom level
Parameters
- level: number
Returns void
- Defined in packages/map-plugin/src/MapPlugin.ts:182

show

show(): void
Shows the map

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