Class PlanPlugin

Adds a map on the viewer

Hierarchy

AbstractConfigurablePlugin<PlanPluginConfig, ParsedPlanPluginConfig, UpdatablePlanPluginConfig, PlanPluginEvents>
- PlanPlugin

Index

Constructors

Properties

component config viewer VERSION configParser id readonlyOptions

Methods

addEventListener clearHotspots close dispatchEvent getLeaflet hide maximize minimize open removeEventListener setActiveHotspot setCoordinates setHotspots setOption setOptions show

Constructors

constructor

new PlanPlugin(viewer, config): PlanPlugin
Parameters
- viewer: Viewer
- config: PlanPluginConfig
Returns PlanPlugin
Overrides AbstractConfigurablePlugin.constructor
- Defined in packages/plan-plugin/src/PlanPlugin.ts:76

Properties

`Readonly` component

component: PlanComponent

`Readonly` config

config: ParsedPlanPluginConfig

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

`Static` `Readonly` id

id: "plan" = 'plan'

Unique identifier of the plugin

`Static` `Readonly` readonlyOptions

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

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/plan-plugin/src/PlanPlugin.ts:236

close

close(): void
Closes the map

Returns void
- Defined in packages/plan-plugin/src/PlanPlugin.ts:170

dispatchEvent

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

getLeaflet

getLeaflet(): Map
Returns the Leaflet instance

Returns Map
- Defined in packages/plan-plugin/src/PlanPlugin.ts:250

hide

hide(): void
Hides the map

Returns void
- Defined in packages/plan-plugin/src/PlanPlugin.ts:156

maximize

maximize(): void
Maximizes the map

Returns void
- Defined in packages/plan-plugin/src/PlanPlugin.ts:197

minimize

minimize(): void
Minimizes the map

Returns void
- Defined in packages/plan-plugin/src/PlanPlugin.ts:188

open

open(): void
Open the map

Returns void
- Defined in packages/plan-plugin/src/PlanPlugin.ts:179

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/plan-plugin/src/PlanPlugin.ts:243

setCoordinates

setCoordinates(coordinates): void
Changes the position on the map
Parameters
- coordinates: GpsPosition
Returns void
- Defined in packages/plan-plugin/src/PlanPlugin.ts:206

setHotspots

setHotspots(hotspots): void
Changes the hotspots on the map
Parameters
- hotspots: PlanHotspot[]
Returns void
- Defined in packages/plan-plugin/src/PlanPlugin.ts:214

setOption

setOption<T>(option, value): void
Update options
Type Parameters
- T extends "size" | "position" | "bearing" | "coordinates" | "pinImage" | "pinSize" | "spotStyle" | "hotspots"
Parameters
- option: T
- value: UpdatablePlanPluginConfig[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<PlanPluginConfig>
Returns void
Overrides AbstractConfigurablePlugin.setOptions
- Defined in packages/plan-plugin/src/PlanPlugin.ts:131

show

show(): void
Shows the map

Returns void
- Defined in packages/plan-plugin/src/PlanPlugin.ts:163

Generated using TypeDoc