Class MapPlugin

Adds a minimap on the viewer

Hierarchy (View Summary)

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

Index

Constructors

constructor

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

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 extends "select-hotspot"
    | "view-changed",
    E extends MapPluginEvents & { type: T },
>(
    type: T,
    callback: EventListenerObject | ((e: E) => void),
    options?: boolean | AddEventListenerOptions,
): 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:286

close

close(): void
Closes the map

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

dispatchEvent

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

maximize

maximize(): void
Maximizes the map

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

minimize

minimize(): void
Minimizes the map

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

open

open(): void
Open the map

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

removeEventListener

removeEventListener<
    T extends "select-hotspot"
    | "view-changed",
    E extends MapPluginEvents & { type: T },
>(
    type: "select-hotspot" | "view-changed",
    callback: EventListenerObject | ((e: E) => void),
    options?: boolean | EventListenerOptions,
): 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: string): void
Changes the highlighted hotspot
Parameters
- hotspotId: string
Returns void
- Defined in packages/map-plugin/src/MapPlugin.ts:293

setCenter

setCenter(center: Point, resetView?: boolean): void
Changes the position on the map
Parameters
- center: Point
- resetView: boolean = true
Returns void
- Defined in packages/map-plugin/src/MapPlugin.ts:246

setHotspots

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

setImage

setImage(url: string, center?: Point, rotation?: string | number): 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:233

setOption

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

setZoom

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

show

show(): void
Shows the map

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

`Static`withConfig

withConfig(config: MapPluginConfig): [PluginConstructor, any]
Parameters
- config: MapPluginConfig
Returns [PluginConstructor, any]
- Defined in packages/map-plugin/src/MapPlugin.ts:85

Class MapPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MapPlugin

Properties

Readonlycomponent

Readonlyconfig

Protectedviewer

Static ReadonlyconfigParser

Static Readonlyid

Static ReadonlyreadonlyOptions

Static ReadonlyVERSION

Methods

addEventListener

Type Parameters

Parameters

Returns void

clearHotspots

Returns void

close

Returns void

dispatchEvent

Parameters

Returns boolean

hide

Returns void

maximize

Returns void

minimize

Returns void

open

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

setActiveHotspot

Parameters

Returns void

setCenter

Parameters

Returns void

setHotspots

Parameters

Returns void

setImage

Parameters

Returns void

setOption

Type Parameters

Parameters

Returns void

setOptions

Parameters

Returns void

setZoom

Parameters

Returns void

show

Returns void

StaticwithConfig

Parameters

Returns [PluginConstructor, any]

Settings

On This Page

`Readonly`component

`Readonly`config

`Protected`viewer

`Static` `Readonly`configParser

`Static` `Readonly`id

`Static` `Readonly`readonlyOptions

`Static` `Readonly`VERSION

`Static`withConfig