Interface PopupDefinition

Encapsulates the creation and lifecycle of PopupTemplates.

Hierarchy

PopupDefinition

Index

Methods

cleanupPopupTemplate? resolvePopupTemplate resolvePopupTemplateForStore?

Methods

`Optional` cleanupPopupTemplate

cleanupPopupTemplate(layerOrStore): void
Hook to cleanup resources cached for a given popuptemplate or layer.

Function is triggered by the custom popup engine if a layer is removed from the map.
Parameters
- layerOrStore: Layer | Store
  instance (either Layer or StoreInstance for which the popup template was created.
Returns void
- Defined in api.ts:350

resolvePopupTemplate

resolvePopupTemplate(layer): undefined | PopupTemplateDefinition
Provides a PopupTemplate (definition) for a layer. Function is triggered by the custom popup engine to resolve PopupTemplate information as soon as a layer is registered inside a map.
Parameters
- layer: Layer
  Instance for which the popup template should be created.
Returns undefined | PopupTemplateDefinition
The resolved template, see https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html.
- Defined in api.ts:326

`Optional` resolvePopupTemplateForStore

resolvePopupTemplateForStore(store, storeProperties): undefined | PopupTemplateDefinition | Promise<undefined | PopupTemplateDefinition>
Provides a PopupTemplate (definition) for a store. Function is triggered by the custom popup engine to resolve PopupTemplate information as soon as a store is registered in the system.
Parameters
- store: Store
  Instance for which the popup template should be created.
- storeProperties: Record<string, any>
  Additional information about the store instance.
Returns undefined | PopupTemplateDefinition | Promise<undefined | PopupTemplateDefinition>
The resolved template, see https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html.
- Defined in api.ts:337

Generated using TypeDoc