Interface GeoJsonAdapterOptions<F, L, A, N>

interface GeoJsonAdapterOptions<F, L, A, N> {
    adapter?: string;
    attribution?: string;
    baselayer?: boolean;
    cluster?: boolean;
    clusterMaxZoom?: number;
    clusterRadius?: number;
    crossOrigin?: "anonymous";
    data?: GeoJsonObject;
    featureIdName?: string;
    fields?: null | false | (keyof ExtractFeatureProperties<F>)[];
    filter?: DataLayerFilter<F, L>;
    fit?: boolean;
    headers?: Record<string, any>;
    heightOffset?: number;
    id?: string;
    interactive?: boolean;
    intersects?: string | LngLatBoundsArray | LngLatArray[];
    label?: ((e: LayerDefinition<F, L>) => string);
    labelField?: keyof ExtractFeatureProperties<F> extends null
        ? string
        : keyof ExtractFeatureProperties<F>;
    labelOnHover?: boolean;
    labelVisibility?: boolean;
    layers?: string;
    layout?: any;
    limit?: number;
    maxScale?: number;
    maxZoom?: number;
    minScale?: number;
    minZoom?: number;
    multiselect?: boolean;
    name?: string;
    nativeFilter?: unknown;
    nativeOptions?: N;
    nativePaint?: boolean | Record<string, any>;
    offset?: number;
    onAdded?: ((layer: LayerAdapter<any, any, AdapterOptions<Record<string, any>, Record<string, any>>>) => void);
    opacity?: null | number;
    order?: number;
    orderBy?: (string | keyof ExtractFeatureProperties<F>)[];
    paint?: Paint<F>;
    popup?: boolean;
    popupOnHover?: boolean;
    popupOnSelect?: boolean;
    popupOptions?: PopupOptions<F, L>;
    propertiesFilter?: PropertiesFilter<ExtractFeatureProperties<F>>;
    props?: A;
    ratio?: number;
    selectable?: boolean;
    selectedLayout?: any;
    selectedPaint?: Paint<F>;
    selectOnHover?: boolean;
    setViewDelay?: number;
    source?: unknown;
    srs?: number;
    strategy?: "BBOX" | "BBOX+";
    type?: VectorAdapterLayerType;
    unselectOnClick?: boolean;
    unselectOnSecondClick?: boolean;
    visibility?: boolean;
    waitFullLoad?: boolean;
    withCredentials?: boolean;
    onClick?(opt: OnLayerMouseOptions<F, L>): void;
    onDoubleClick?(opt: OnLayerMouseOptions<F, L>): void;
    onLayerClick?(opt: OnLayerMouseOptions<F, L>): Promise<any>;
    onLayerSelect?(opt: OnLayerSelectOptions<F, L>): Promise<any>;
    onMouseOut?(opt: Omit<OnLayerMouseOptions<F, L>, keyof FeaturePosition>): void;
    onMouseOver?(opt: OnLayerMouseOptions<F, L>): void;
    onSelect?(opt: OnLayerSelectOptions<F, L>): void;
}

Type Parameters

Hierarchy (view full)

Properties

adapter? attribution? baselayer? cluster? clusterMaxZoom? clusterRadius? crossOrigin? data? featureIdName? fields? filter? fit? headers? heightOffset? id? interactive? intersects? label? labelField? labelOnHover? labelVisibility? layers? layout? limit? maxScale? maxZoom? minScale? minZoom? multiselect? name? nativeFilter? nativeOptions? nativePaint? offset? onAdded? opacity? order? orderBy? paint? popup? popupOnHover? popupOnSelect? popupOptions? propertiesFilter? props? ratio? selectable? selectedLayout? selectedPaint? selectOnHover? setViewDelay? source? srs? strategy? type? unselectOnClick? unselectOnSecondClick? visibility? waitFullLoad? withCredentials?

Methods

onClick? onDoubleClick? onLayerClick? onLayerSelect? onMouseOut? onMouseOver? onSelect?

Properties

Optionaladapter

adapter?: string

Optionalattribution

attribution?: string

String to be shown in the attribution control. It describes the layer data and is often a legal obligation towards copyright holders and tile providers.

Optionalbaselayer

baselayer?: boolean

Indicate on a cartographic base layer.

Optionalcluster

cluster?: boolean

OptionalclusterMaxZoom

clusterMaxZoom?: number

Max zoom to cluster points on

OptionalclusterRadius

clusterRadius?: number

Radius of each cluster when clustering points

Default Value

50

OptionalcrossOrigin

crossOrigin

Parameter added when forming a request for layer data. This is needed if you want to access tile pixel data. Refer to CORS Settings for valid String values.

Optionaldata

data?: GeoJsonObject

Geojson data

OptionalfeatureIdName

featureIdName?: string

Optionalfields

fields?: null | false | (keyof ExtractFeatureProperties<F>)[]

Optionalfilter

filter?: DataLayerFilter<F, L>

Optionalfit

fit?: boolean

Fit map to layer extent

Default Value

false

Optionalheaders

headers?: Record<string, any>

OptionalheightOffset

heightOffset?: number

Optionalid

id?: string

Unique Layer ID. If not specified, will be added automatically.

Remarks

If the layer adapter is asynchronous, its id will be assigned only after the promise is resolved. While adapter is loading, methods for obtaining layers will ignore the added layer.

Optionalinteractive

interactive?: boolean

Optionalintersects

intersects?: string | LngLatBoundsArray | LngLatArray[]

WKT polygon geometry

Optionallabel

label?: ((e: LayerDefinition<F, L>) => string)

OptionallabelField

labelField?: keyof ExtractFeatureProperties<F> extends null
    ? string
    : keyof ExtractFeatureProperties<F>

OptionallabelOnHover

labelOnHover?: boolean

OptionallabelVisibility

labelVisibility?: boolean

Show set label immediately

Default Value

false

Optionallayers

layers?: string

Optionallayout

layout?: any

Deprecated

  • TODO: move to nativeOptions

Optionallimit

limit?: number

Limit (paginated) - max number of entities should be taken.

OptionalmaxScale

maxScale?: number

TODO: replace by maxZoom

Deprecated

use maxZoom instead

OptionalmaxZoom

maxZoom?: number

Maximum zoom level of the map.

OptionalminScale

minScale?: number

TODO: replace by minZoom

Deprecated

use minZoom instead

OptionalminZoom

minZoom?: number

Minimum zoom level of the map.

Optionalmultiselect

multiselect?: boolean

Indicates whether several objects can be selected in one layer.

Example

// multiselect: false
layer.select(({ feature }) => feature.properties.color === 'green'); // one feature will be selected
// multiselect: true
layer.select(({ feature }) => feature.properties.color === 'green'); // all 'green' features will be selected

Optionalname

name?: string

Non-unique name of the layer. Can be used for user interfaces.

OptionalnativeFilter

nativeFilter?: unknown

Deprecated

  • TODO: move to nativeOptions

OptionalnativeOptions

nativeOptions?: N

Map and layer adapter base options Use with care. There may be a conflict in the addLayer method by the adapter of the NextGIS Frontend library

OptionalnativePaint

nativePaint?: boolean | Record<string, any>

Deprecated

  • TODO: move to nativeOptions

Optionaloffset

offset?: number

Offset (paginated) where from entities should be taken.

OptionalonAdded

onAdded?: ((layer: LayerAdapter<any, any, AdapterOptions<Record<string, any>, Record<string, any>>>) => void)

Optionalopacity

opacity?: null | number

Layer transparency. From 0-transparent to 1-visible

Default Value

1

Optionalorder

order?: number

Indicates the map layers display sequence. A layer with a larger order value overlaps smaller ones. Zero value used to indicate baselayer. If the value is not specified explicitly, it will be assigned automatically with an increase of one for each new layer.

OptionalorderBy

orderBy?: (string | keyof ExtractFeatureProperties<F>)[]

set fields for order

Remarks

TODO: use typescript 4.1 template string type for map -${field}

Example

{ "orderBy": ["field1", "-field2"] }

Optionalpaint

paint?: Paint<F>

Determine the appearance of the vector data geometries.

Example

const circlePaint = { paint: { color: 'green', radius: 6 } };
const paintCb = (feature) => {
 return { color: 'red', opacity: feature.properties.opacity }
}

Example

// Use global paint function
// set paint function inside WebMap static property
WebMap.getPaintFunctions.customPaintFunction = customIconPaintFunction

webMap.addLayer('GEOJSON', {
  paint: {
    type: 'get-paint',
    from: 'customPaintFunction',
    options: {}
  }
}

Optionalpopup

popup?: boolean

OptionalpopupOnHover

popupOnHover?: boolean

OptionalpopupOnSelect

popupOnSelect?: boolean

OptionalpopupOptions

popupOptions?: PopupOptions<F, L>

OptionalpropertiesFilter

propertiesFilter?: PropertiesFilter<ExtractFeatureProperties<F>>

Optionalprops

props?: A

Any properties to save in layer. May be useful to get additional info from layer event.

Optionalratio

ratio?: number

Optionalselectable

selectable?: boolean

Determines whether objects are selected by mouse click.

Example

const layer = webMap.addLayer('GEOJSON', {
  paint: { color: 'red' },
  selectedPaint: { color: 'green' },
  selectable: false
});
// programmatically selection - ok, but not on mouse click
layer.select(({ feature }) => feature.properties.id === ID_FOR_SELECT);

OptionalselectedLayout

selectedLayout?: any

Deprecated

  • TODO: move to nativeOptions

OptionalselectedPaint

selectedPaint?: Paint<F>

The paint that applies to the features after it becomes selected.

Example

webMap.addLayer('GEOJSON', {
  paint: { color: 'red' },
  selectedPaint: { color: 'green' }
});

OptionalselectOnHover

selectOnHover?: boolean

Make the feature selected while mouseover.

OptionalsetViewDelay

setViewDelay?: number

Experimental option to set the map loading delay when changing position

Optionalsource

source?: unknown

Optionalsrs

srs?: number

Experimental only for Ol yet

Optionalstrategy

strategy?: "BBOX" | "BBOX+"

Optionaltype

type?: VectorAdapterLayerType

Type for geometries painting, for each layer may be only one of: point, polygon or line.

OptionalunselectOnClick

unselectOnClick?: boolean

If false, the selection will be reset when the user clicks the map.

Default Value

true

OptionalunselectOnSecondClick

unselectOnSecondClick?: boolean

Deselects layer feature by second click.

Optionalvisibility

visibility?: boolean

Show layer on the map immediately after adding. Such layers are always under others. Only one base layer can be displayed on the map at a time.

Remarks

TODO: replace by show

Default Value

true

OptionalwaitFullLoad

waitFullLoad?: boolean

Wait until the layer data is fully loaded before allowing added to the map.

Remarks

If true, addLayer promise resolve only after data loading. This is useful for GeoJson vector layer adapters when you need to process downloaded data before displaying.

OptionalwithCredentials

withCredentials?: boolean

Methods

OptionalonClick

OptionalonDoubleClick

OptionalonLayerClick

OptionalonLayerSelect

OptionalonMouseOut

OptionalonMouseOver

OptionalonSelect

Settings

Member Visibility

On This Page

Properties
Methods