# Interface: FlowCoreMapDataSourceOptions

FlowCoreDataSource options.

# Hierarchy

  • FlowCoreMapDataSourceOptions

# Properties

# apiKey

• Optional apiKey: string

Set to override application-wide API key for this data source


# cluster

• Optional cluster: boolean

Enable GeoJSON point clustering.


# clusterMaxZoom

• Optional clusterMaxZoom: number

GeoJSON point clustering maximum zoom level.


# clusterRadius

• Optional clusterRadius: number

GeoJSON point clustering radius.


# featureId

• Optional featureId: string

Specify feature property to use as unique ID.


# flowMap

• flowMap: FlowCoreMap

Parent map.


# id

• id: string

Data source ID.


# limit

• Optional limit: number

Data source limit - applied to dataset queries.


# selectionClear

• Optional selectionClear: boolean

Set to true to clear the selected feature whenever the map is clicked (empty area or a feature from another data source).

By default, selection is only cleared when clicking on an empty area of the map.


# selectionFeatureState

• Optional selectionFeatureState: string

Set to bind feature selection to a Flo.w application state property. The application state property is:

  • single mode: an object containing the selected feature's properties.
  • multi mode: an object mapping selected feature IDs to feature properties.

Binding is one-way. The application state property is updated automatically when map feature selection changes. Setting the application state property programmatically has no effect.

reactive


# selectionMode

• Optional selectionMode: "none" | "single" | "multi"

Enable automatic feature selection support for single or multiple features.


# selectionPopup

• Optional selectionPopup: string | SelectionPopupFn

Set to automatically open a popup when a map feature from this data source is clicked. The popup can be configured by specifying the ID of a registered <flow-map-popup> or programmatically by specifying a function that returns a FlowCoreMapPopupOptions object.


# selectionState

• Optional selectionState: string

Set to bind feature selection to a Flo.w application state property. The application state property is the selected feature ID ('single' mode) or an array of selected feature IDs ('multi' mode).

Binding is two-way. Set the associated application state property to programmatically modify feature selection for this data source.

reactive


# sourceLayer

• Optional sourceLayer: string

The vector source layer to display. Defaults to 'geometry' for vector-type data sources. Omit for GeoJSON-type data sources.


# src

• src: string | FeatureCollection

Data source: dataset ID, external URL or GeoJSON FeatureCollection.


# type

• Optional type: string

Data source type: 'vector' or 'geojson'.