API Documentation
    Preparing search index...

    Interface PopupTemplateResolver

    Resolves popup templates for layers or stores.

    Use popups.PopupTemplateResolver as service name in your manifest.json to get an PopupTemplateResolver instance.

    interface PopupTemplateResolver {
        resolvePopupTemplate(
            params: PopupTemplateResolverParams,
        ): Promise<UnknownPopupTemplate | ResolvedPopupTemplate>;
    }
    Index

    Methods

    • Resolves popup template for store or layer.

      Note that the source layer is required on a graphic (.layer property) if domain values should be resolved, even if a popup template is resolved from a store.

      The popup template resolver returns the additional layer property if the original layer could be found, which will point to the layer where the feature originates from.

      Parameters

      Returns Promise<UnknownPopupTemplate | ResolvedPopupTemplate>

      const { popupTemplate } = await resolver.resolvePopupTemplate({store: store});
      
      const { popupTemplate } = await resolver.resolvePopupTemplate({storeId: "my-store"});
      
      const { popupTemplate } = await resolver.resolvePopupTemplate({layerId: "countries"});
      
      const { popupTemplate } = await resolver.resolvePopupTemplate({layerId: "countries/2"});