OgcMapLayerOptions interface

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Package:

azure-maps-spatial-io

Options for an OGC layer.

Extends

MediaLayerOptions

Properties

activeLayers	Specifies the sublayers in the service to render.
bringIntoView	Indicates if the map should set the map view to the bounding box of the layer. Not persistent.
contrast	A number between -1 and 1 that increases or decreases the contrast of the overlay. Default 0.
debug	Indicates if errors related to accessing the service should be logged to the console.
dimensions	Custom dimensions to add to tile requests.
fadeDuration	The duration in milliseconds of a fade transition when a new tile is added. Must be greater or equal to 0. Default 300.
filter	An expression specifying conditions on source features. Only features that match the filter are displayed.
hueRotation	Rotates hues around the color wheel. A number in degrees. Default 0.
maxBrightness	A number between 0 and 1 that increases or decreases the maximum brightness of the overlay. Default 1.
maxZoom	An integer specifying the maximum zoom level to render the layer at. This value is exclusive, i.e. the layer will be visible at maxZoom > zoom >= minZoom. Default 24.
minBrightness	A number between 0 and 1 that increases or decreases the minimum brightness of the overlay. Default 0.
minZoom	An integer specifying the minimum zoom level to render the layer at. This value is inclusive, i.e. the layer will be visible at maxZoom > zoom >= minZoom. Default 0.
opacity	A number between 0 and 1 that indicates the opacity at which the overlay will be drawn. Default 1.
proxyService	A URL to a proxy service that can have a URL to an external service appended it. This will be needed to access services that are hosted on non-CORs enabled endpoints.
saturation	A number between -1 and 1 that increases or decreases the saturation of the overlay. Default 0.
service	Specifies the type of web mapping service to connect to. If not specified, will try and determine based on the URL. Defaults to 'WMTS' if not specified or if can't be determined from the URL.
styles	The styles of the active layers.
url	The URL that points to the service.
version	The version of the service to target. If not specified, will automatically try and determine this.
visible	Specifies if the layer is visible or not. Default true.

Property Details

activeLayers

Specifies the sublayers in the service to render.

activeLayers?: Array<string | OgcSublayer>

Property Value

Array<string | OgcSublayer>

bringIntoView

Indicates if the map should set the map view to the bounding box of the layer. Not persistent.

bringIntoView?: boolean

Property Value

boolean

contrast

A number between -1 and 1 that increases or decreases the contrast of the overlay. Default 0.

contrast?: number

Property Value

number

debug

Indicates if errors related to accessing the service should be logged to the console.

debug?: boolean

Property Value

boolean

dimensions

Custom dimensions to add to tile requests.

dimensions?: Record<string, string>

Property Value

Record<string, string>

fadeDuration

The duration in milliseconds of a fade transition when a new tile is added. Must be greater or equal to 0. Default 300.

fadeDuration?: number

Property Value

number

filter

An expression specifying conditions on source features. Only features that match the filter are displayed.

filter?: Expression

Property Value

Expression

hueRotation

Rotates hues around the color wheel. A number in degrees. Default 0.

hueRotation?: number

Property Value

number

maxBrightness

A number between 0 and 1 that increases or decreases the maximum brightness of the overlay. Default 1.

maxBrightness?: number

Property Value

number

maxZoom

An integer specifying the maximum zoom level to render the layer at. This value is exclusive, i.e. the layer will be visible at maxZoom > zoom >= minZoom. Default 24.

maxZoom?: number

Property Value

number

minBrightness

A number between 0 and 1 that increases or decreases the minimum brightness of the overlay. Default 0.

minBrightness?: number

Property Value

number

minZoom

An integer specifying the minimum zoom level to render the layer at. This value is inclusive, i.e. the layer will be visible at maxZoom > zoom >= minZoom. Default 0.

minZoom?: number

Property Value

number

opacity

A number between 0 and 1 that indicates the opacity at which the overlay will be drawn. Default 1.

opacity?: number

Property Value

number

proxyService

A URL to a proxy service that can have a URL to an external service appended it. This will be needed to access services that are hosted on non-CORs enabled endpoints.

proxyService?: string

Property Value

string

saturation

A number between -1 and 1 that increases or decreases the saturation of the overlay. Default 0.

saturation?: number

Property Value

number

service

Specifies the type of web mapping service to connect to. If not specified, will try and determine based on the URL. Defaults to 'WMTS' if not specified or if can't be determined from the URL.

service?: "WMS" | "WMTS"

Property Value

"WMS" | "WMTS"

styles

The styles of the active layers.

styles?: Array<string | OgcStyle>

Property Value

Array<string | OgcStyle>

url

The URL that points to the service.

url?: string

Property Value

string

version

The version of the service to target. If not specified, will automatically try and determine this.

version?: string

Property Value

string

visible

Specifies if the layer is visible or not. Default true.

visible?: boolean

Property Value

boolean