Interface ImageAdapterOptions

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

Hierarchy

Properties

adapter? attribution? baselayer? crossOrigin? fit? format? headers? id? layers? maxScale? maxZoom? minScale? minZoom? name? nativeOptions? onAdded? opacity? order? params props? ratio? resourceId? setViewDelay? srs? subdomains? tileSize? transparent? type? updateWmsParams? url version? visibility? waitFullLoad?

Properties

Optional adapter

adapter?: string

Optional attribution

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.

Optional baselayer

baselayer?: boolean

Indicate on a cartographic base layer.

Optional crossOrigin

crossOrigin?: "anonymous"

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.

Optional fit

fit?: boolean

Fit map to layer extent

Default Value

false

Optional format

format?: string

Optional headers

headers?: Record<string, any>

Optional id

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.

Optional layers

layers?: string

Optional maxScale

maxScale?: number

TODO: replace by maxZoom

Deprecated

use maxZoom instead

Optional maxZoom

maxZoom?: number

Maximum zoom level of the map.

Optional minScale

minScale?: number

TODO: replace by minZoom

Deprecated

use minZoom instead

Optional minZoom

minZoom?: number

Minimum zoom level of the map.

Optional name

name?: string

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

Optional nativeOptions

nativeOptions?: Record<string, any>

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

Optional onAdded

onAdded?: ((layer) => void)

Type declaration

Optional opacity

opacity?: number

Layer transparency. From 0-transparent to 1-visible

Default Value

1

Optional order

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.

params

params: Record<string, any>

Optional props

props?: Record<string, any>

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

Optional ratio

ratio?: number

Optional resourceId

resourceId?: string | number

Deprecated

use params option instead

Optional setViewDelay

setViewDelay?: number

Experimental option to set the map loading delay when changing position

Optional srs

srs?: number

Experimental only for Ol yet

Optional subdomains

subdomains?: string | string[]

Optional tileSize

tileSize?: number

Optional transparent

transparent?: boolean

Optional type

type?: VectorAdapterLayerType

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

Optional updateWmsParams

updateWmsParams?: ((obj) => Record<string, unknown>)

Type declaration

    • (obj): Record<string, unknown>

    • Parameters

      • obj: {
            [paramName: string]: any;
        }
        • [paramName: string]: any

      Returns Record<string, unknown>

url

url: string

Optional version

version?: string

Optional visibility

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

Optional waitFullLoad

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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc