Interface CreatePopupContentProps<F, L>

interface CreatePopupContentProps<F, L> {
    close: (() => void);
    feature: F;
    getBounds: (() => LngLatBoundsArray);
    getCenter: (() => LngLatArray);
    layer?: L;
    onClose: ((cb: PopupOnCloseFunction) => void);
    target: LayerAdapter<any, any, AdapterOptions<Record<string, any>, Record<string, any>>>;
    type: OnLayerSelectType;
    visible?: boolean;
}

Type Parameters

  • F extends Feature = Feature
  • L = any

Hierarchy (view full)

Properties

close feature getBounds getCenter layer? onClose target type visible?

Properties

close

close: (() => void)

Close the pop-up programmatically

feature

feature: F

A vector layer object in geojson format.

getBounds

getBounds: (() => LngLatBoundsArray)

Get the extent for the geometry on which the action was executed.

getCenter

getCenter: (() => LngLatArray)

Get the center for the geometry on which the action was executed.

Optionallayer

layer?: L

Native layer for a specific adapter layers of a specific map adapter.

onClose

onClose: ((cb: PopupOnCloseFunction) => void)

The callback function that is called when the popup is closed

Example

createPopupContent: (e) => {
  const onZoomEnd = () => e.close();
  ngwMap.emitter.on('zoomend', onZoomEnd)
  e.onClose(() => {
    ngwMap.emitter.off('zoomend', onZoomEnd)
  })
  return createContentFunc(e);
},

target

target: LayerAdapter<any, any, AdapterOptions<Record<string, any>, Record<string, any>>>

The adapter in which the layer is created.

type

type: OnLayerSelectType

The source of the event call. User click, hover, or programmatic api call

Optionalvisible

visible?: boolean

Is layer on the map

Settings

Member Visibility

On This Page

Properties