Class PlanPlugin

Readonlyconfig

addEventListener

• addEventListener<
      T extends "select-hotspot"
      | "view-changed",
      E extends PlanPluginEvents & { 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 PlanPluginEvents & { type: T }

    the class of the event

  Parameters

  • type: T
  • callback: EventListenerObject | (e: E) => void
  • Optionaloptions: boolean | AddEventListenerOptions

  Returns void

dispatchEvent

• dispatchEvent(e: PlanPluginEvents): 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: PlanPluginEvents

  Returns boolean

removeEventListener

• removeEventListener<
      T extends "select-hotspot"
      | "view-changed",
      E extends PlanPluginEvents & { 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 PlanPluginEvents & { type: T }

    the class of the event

  Parameters

  • type: "select-hotspot" | "view-changed"
  • callback: EventListenerObject | (e: E) => void
  • Optionaloptions: boolean | EventListenerOptions

  Returns void

setOption

• setOption<
      T extends
          | "size"
          | "position"
          | "pinImage"
          | "pinSize"
          | "spotStyle"
          | "hotspots"
          | "minimizeOnHotspotClick"
          | "bearing"
          | "coordinates",
  >(
      option: T,
      value: UpdatablePlanPluginConfig[T],
  ): void

• Update options

  Type Parameters

  • T extends
        | "size"
        | "position"
        | "pinImage"
        | "pinSize"
        | "spotStyle"
        | "hotspots"
        | "minimizeOnHotspotClick"
        | "bearing"
        | "coordinates"

  Parameters

  • option: T
  • value: UpdatablePlanPluginConfig[T]

  Returns void