Interface AdapterOptions<ANYPROPS, NATIVE>

Parameters that can be used to create any map layer adapter.

interface AdapterOptions<ANYPROPS, NATIVE> {
    adapter?: string;
    attribution?: string;
    baselayer?: boolean;
    crossOrigin?: "anonymous";
    fit?: boolean;
    headers?: Record<string, any>;
    id?: string;
    layers?: string;
    maxScale?: number;
    maxZoom?: number;
    minScale?: number;
    minZoom?: number;
    name?: string;
    nativeOptions?: NATIVE;
    onAdded?: ((layer: LayerAdapter<any, any, AdapterOptions<Record<string, any>, Record<string, any>>>) => void);
    opacity?: null | number;
    order?: number;
    props?: ANYPROPS;
    ratio?: number;
    setViewDelay?: number;
    srs?: number;
    type?: VectorAdapterLayerType;
    visibility?: boolean;
    waitFullLoad?: boolean;
    withCredentials?: boolean;
}

Type Parameters

  • ANYPROPS extends Record<string, any> = Record<string, any>
  • NATIVE extends Record<string, any> = Record<string, any>

Hierarchy (view full)

Properties

adapter? attribution? baselayer? crossOrigin? fit? headers? id? layers? maxScale? maxZoom? minScale? minZoom? name? nativeOptions? onAdded? opacity? order? props? ratio? setViewDelay? srs? type? visibility? waitFullLoad? withCredentials?

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.

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.

Optionalfit

fit?: boolean

Fit map to layer extent

Default Value

false

Optionalheaders

headers?: Record<string, any>

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.

Optionallayers

layers?: string

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.

Optionalname

name?: string

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

OptionalnativeOptions

nativeOptions?: NATIVE

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

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.

Optionalprops

props?: ANYPROPS

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

Optionalratio

ratio?: number

OptionalsetViewDelay

setViewDelay?: number

Experimental option to set the map loading delay when changing position

Optionalsrs

srs?: number

Experimental only for Ol yet

Optionaltype

type?: VectorAdapterLayerType

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

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

Settings

Member Visibility

On This Page

Properties