Class Layer

public RESOLUTION_PROPERTIES: Array<string>

The properties that are used for calculating resolutions information.

public alpha: boolean

The layer's images have an alpha channel. Default is false.

public alwaysInRange: boolean

If a layer's display should not be scale-based, this should be set to true. This will cause the layer, as an overlay, to always be 'active', by always returning true from the calculateInRange() function.

If not explicitly specified for a layer, its value will be determined on startup in initResolutions() based on whether or not any scale-specific properties have been set as options on the layer. If no scale-specific options have been set on the layer, we assume that it should always be in range.

public attribution: string

Attribution string, displayed when an has been added to the map.

public displayInLayerSwitcher: boolean

Display the layer's name in the layer switcher. Default is true

public displayOutsideMaxExtent: boolean

Request map tiles that are completely outside of the max extent for this layer. Defaults to false.

public div: HTMLElement

public eventListeners: Object

An optional object whose properties will be set on the layer. Any of the layer properties can be set as a property of the options object and sent to the constructor when the layer is created.

public events: Events

APIProperty: events {}

Register a listener for a particular event with the following syntax: (code) layer.events.register(type, obj, listener); (end)

Listeners will be called with a reference to an event object. The properties of this event depends on exactly what happened.

All event objects have at least the following properties: object - {Object} A reference to layer.events.object. element - {DOMElement} A reference to layer.events.element.

Supported map event types: loadstart - Triggered when layer loading starts. When using a Vector layer with a Fixed or BBOX strategy, the event object includes a filter property holding the OpenLayers.Filter used when calling read on the protocol. loadend - Triggered when layer loading ends. When using a Vector layer with a Fixed or BBOX strategy, the event object includes a response property holding an OpenLayers.Protocol.Response object. visibilitychanged - Triggered when the layer's visibility property is changed, e.g. by turning the layer on or off in the layer switcher. Note that the actual visibility of the layer can also change if it gets out of range (see ). If you also want to catch these cases, register for the map's 'changelayer' event instead. move - Triggered when layer moves (triggered with every mousemove during a drag). moveend - Triggered when layer is done moving, object passed as argument has a zoomChanged boolean property which tells that the zoom has changed. added - Triggered after the layer is added to a map. Listeners will receive an object with a map property referencing the map and a layer property referencing the layer. removed - Triggered after the layer is removed from the map. Listeners will receive an object with a map property referencing the map and a layer property referencing the layer.

public gutter: number

Determines the width (in pixels) of the gutter around image tiles to ignore. By setting this property to a non-zero value, images will be requested that are wider and taller than the tile size by a value of 2 x gutter. This allows artifacts of rendering at tile edges to be ignored. Set a gutter value that is equal to half the size of the widest symbol that needs to be displayed. Defaults to zero. Non-tiled layers always have zero gutter.

public id: string

public imageSize: Size

For layers with a gutter, the image is larger than the tile by twice the gutter in each dimension.

public inRange: boolean

The current map resolution is within the layer's min/max range. This is set in whenever the zoom changes.

public isBaseLayer: boolean

Whether or not the layer is a base layer. This should be set individually by all subclasses. Default is false

public map: Map

This variable is set when the layer is added to the map, via the accessor function setMap()

public maxExtent: Bounds

The maximum extent for the layer. Defaults to null.

public maxResolution: number

Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps. Specify a different value in the layer options if you are not using the default and displaying the whole world.

public maxScale: number

public metadata: Object

This object can be used to store additional information on a layer object.

public minExtent: Bounds

The minimum extent for the layer. Defaults to null.

public minResolution: number

public minScale: number

public name: string

public numZoomLevels: number

public opacity: number

The layer's opacity. Float number between 0.0 and 1.0.

public options: Object

An optional object whose properties will be set on the layer. Any of the layer properties can be set as a property of the options object and sent to the constructor when the layer is created.

public params: Object

Property: params {Object} Hashtable of key/value parameters

public projection: Projection

Specifies the projection of the layer. Can be set in the layer options. If not specified in the layer options, it is set to the default projection specified in the map, when the layer is added to the map. Projection along with default maxExtent and resolutions are set automatically with commercial baselayers in EPSG:3857, such as Google, Bing and OpenStreetMap, and do not need to be specified. Otherwise, if specifying projection, also set maxExtent, maxResolution or resolutions as appropriate. When using vector layers with strategies, layer projection should be set to the projection of the source data if that is different from the map default.

public reproject: boolean

APIProperty: reproject Deprecated. See http://docs.openlayers.org/library/spherical_mercator.html for information on the replacement for this functionality. {Boolean} Whether layer should reproject itself based on base layer locations. This allows reprojection onto commercial layers. Default is false: Most layers can't reproject, but layers which can create non-square geographic pixels can, like WMS.

public resolutions: Array<any>

A list of map resolutions (map units per pixel) in descending order. If this is not set in the layer constructor, it will be set based on other resolution related properties (maxExtent, maxResolution, maxScale, etc.).

public scales: Array<any>

An array of map scales in descending order. The values in the array correspond to the map scale denominator. Note that these values only make sense if the display (monitor) resolution of the client is correctly guessed by whomever is configuring the application. In addition, the units property must also be set. Use instead wherever possible.

public units: string

The layer map units. Defaults to null. Possible values are 'degrees' (or 'dd'), 'm', 'ft', 'km', 'mi', 'inches'. Normally taken from the projection. Only required if both map and layers do not define a projection, or if they define a projection which does not define units.

public url: Array<string>

Property: url {Array(String) or String} This is either an array of url strings or a single url string.

public visibility: boolean

The layer should be displayed in the map. Default is true.

public wrapDateLine: boolean

Wraps the world at the international dateline, so the map can be panned infinitely in longitudinal direction. Only use this on the base layer, and only if the layer's maxExtent equals the world bounds.

public RESOLUTION_PROPERTIES: Array<string>

The properties that are used for calculating resolutions information.

public alpha: boolean

The layer's images have an alpha channel. Default is false.

public alwaysInRange: boolean

If a layer's display should not be scale-based, this should be set to true. This will cause the layer, as an overlay, to always be 'active', by always returning true from the calculateInRange() function.

If not explicitly specified for a layer, its value will be determined on startup in initResolutions() based on whether or not any scale-specific properties have been set as options on the layer. If no scale-specific options have been set on the layer, we assume that it should always be in range.

public attribution: string

Attribution string, displayed when an has been added to the map.

public displayInLayerSwitcher: boolean

Display the layer's name in the layer switcher. Default is true

public displayOutsideMaxExtent: boolean

Request map tiles that are completely outside of the max extent for this layer. Defaults to false.

public div: HTMLElement

public eventListeners: Object

An optional object whose properties will be set on the layer. Any of the layer properties can be set as a property of the options object and sent to the constructor when the layer is created.

public events: Events

APIProperty: events {}

Register a listener for a particular event with the following syntax: (code) layer.events.register(type, obj, listener); (end)

Listeners will be called with a reference to an event object. The properties of this event depends on exactly what happened.

All event objects have at least the following properties: object - {Object} A reference to layer.events.object. element - {DOMElement} A reference to layer.events.element.

Supported map event types: loadstart - Triggered when layer loading starts. When using a Vector layer with a Fixed or BBOX strategy, the event object includes a filter property holding the OpenLayers.Filter used when calling read on the protocol. loadend - Triggered when layer loading ends. When using a Vector layer with a Fixed or BBOX strategy, the event object includes a response property holding an OpenLayers.Protocol.Response object. visibilitychanged - Triggered when the layer's visibility property is changed, e.g. by turning the layer on or off in the layer switcher. Note that the actual visibility of the layer can also change if it gets out of range (see ). If you also want to catch these cases, register for the map's 'changelayer' event instead. move - Triggered when layer moves (triggered with every mousemove during a drag). moveend - Triggered when layer is done moving, object passed as argument has a zoomChanged boolean property which tells that the zoom has changed. added - Triggered after the layer is added to a map. Listeners will receive an object with a map property referencing the map and a layer property referencing the layer. removed - Triggered after the layer is removed from the map. Listeners will receive an object with a map property referencing the map and a layer property referencing the layer.

public gutter: number

Determines the width (in pixels) of the gutter around image tiles to ignore. By setting this property to a non-zero value, images will be requested that are wider and taller than the tile size by a value of 2 x gutter. This allows artifacts of rendering at tile edges to be ignored. Set a gutter value that is equal to half the size of the widest symbol that needs to be displayed. Defaults to zero. Non-tiled layers always have zero gutter.

public id: string

public imageSize: Size

For layers with a gutter, the image is larger than the tile by twice the gutter in each dimension.

public inRange: boolean

The current map resolution is within the layer's min/max range. This is set in whenever the zoom changes.

public isBaseLayer: boolean

Whether or not the layer is a base layer. This should be set individually by all subclasses. Default is false

public map: Map

This variable is set when the layer is added to the map, via the accessor function setMap()

public maxExtent: Bounds

The maximum extent for the layer. Defaults to null.

public maxResolution: number

Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps. Specify a different value in the layer options if you are not using the default and displaying the whole world.

public maxScale: number

public metadata: Object

This object can be used to store additional information on a layer object.

public minExtent: Bounds

The minimum extent for the layer. Defaults to null.

public minResolution: number

public minScale: number

public name: string

public numZoomLevels: number

public opacity: number

The layer's opacity. Float number between 0.0 and 1.0.

public options: Object

An optional object whose properties will be set on the layer. Any of the layer properties can be set as a property of the options object and sent to the constructor when the layer is created.

public projection: Projection

Specifies the projection of the layer. Can be set in the layer options. If not specified in the layer options, it is set to the default projection specified in the map, when the layer is added to the map. Projection along with default maxExtent and resolutions are set automatically with commercial baselayers in EPSG:3857, such as Google, Bing and OpenStreetMap, and do not need to be specified. Otherwise, if specifying projection, also set maxExtent, maxResolution or resolutions as appropriate. When using vector layers with strategies, layer projection should be set to the projection of the source data if that is different from the map default.

public resolutions: Array<any>

A list of map resolutions (map units per pixel) in descending order. If this is not set in the layer constructor, it will be set based on other resolution related properties (maxExtent, maxResolution, maxScale, etc.).

public scales: Array<any>

An array of map scales in descending order. The values in the array correspond to the map scale denominator. Note that these values only make sense if the display (monitor) resolution of the client is correctly guessed by whomever is configuring the application. In addition, the units property must also be set. Use instead wherever possible.

public units: string

The layer map units. Defaults to null. Possible values are 'degrees' (or 'dd'), 'm', 'ft', 'km', 'mi', 'inches'. Normally taken from the projection. Only required if both map and layers do not define a projection, or if they define a projection which does not define units.

public visibility: boolean

The layer should be displayed in the map. Default is true.

public wrapDateLine: boolean

Wraps the world at the international dateline, so the map can be panned infinitely in longitudinal direction. Only use this on the base layer, and only if the layer's maxExtent equals the world bounds.

public RESOLUTION_PROPERTIES: Array<string>

The properties that are used for calculating resolutions information.

public alpha: boolean

The layer's images have an alpha channel. Default is false.

public alwaysInRange: boolean

If a layer's display should not be scale-based, this should be set to true. This will cause the layer, as an overlay, to always be 'active', by always returning true from the calculateInRange() function.

If not explicitly specified for a layer, its value will be determined on startup in initResolutions() based on whether or not any scale-specific properties have been set as options on the layer. If no scale-specific options have been set on the layer, we assume that it should always be in range.

public backBuffer: HTMLElement

Property: backBuffer {DOMElement} The back buffer.

public backBufferLonLat: { lon: number; lat: number; }

Property: backBufferLonLat {Object} The top-left corner of the current back buffer. Includes lon and lat properties. This object is updated each time a back buffer is created.

public backBufferResolution: number

Property: backBufferResolution {Number} The resolution of the current back buffer. This property is updated each time a back buffer is created.

public backBufferTimerId: number

Property: backBufferTimerId {Number} The id of the back buffer timer. This timer is used to delay the removal of the back buffer, thereby preventing flash effects caused by tile animation.

public buffer: number

APIProperty: buffer {Integer} Used only when in gridded mode, this specifies the number of extra rows and columns of tiles on each side which will surround the minimum grid tiles to cover the map. For very slow loading layers, a larger value may increase performance somewhat when dragging, but will increase bandwidth use significantly.

public className: string

APIProperty: className {String} Name of the class added to the layer div. If not set in the options passed to the constructor then className defaults to "olLayerGridSingleTile" for single tile layers (see ), and "olLayerGrid" for non single tile layers.

Note:

The displaying of tiles is not animated by default for single tile layers - OpenLayers' default theme (style.css) includes this: (code) .olLayerGrid .olTileImage { -webkit-transition: opacity 0.2s linear; -moz-transition: opacity 0.2s linear; -o-transition: opacity 0.2s linear; transition: opacity 0.2s linear; } (end) To animate tile displaying for any grid layer the following CSS rule can be used: (code) .olTileImage { -webkit-transition: opacity 0.2s linear; -moz-transition: opacity 0.2s linear; -o-transition: opacity 0.2s linear; transition: opacity 0.2s linear; } (end) In that case, to avoid flash effects, should not be zero.

public displayInLayerSwitcher: boolean

Display the layer's name in the layer switcher. Default is true

public displayOutsideMaxExtent: boolean

Request map tiles that are completely outside of the max extent for this layer. Defaults to false.

public div: HTMLElement

public eventListeners: Object

An optional object whose properties will be set on the layer. Any of the layer properties can be set as a property of the options object and sent to the constructor when the layer is created.

public events: Events

APIProperty: events {}

Register a listener for a particular event with the following syntax: (code) layer.events.register(type, obj, listener); (end)

Listeners will be called with a reference to an event object. The properties of this event depends on exactly what happened.

All event objects have at least the following properties: object - {Object} A reference to layer.events.object. element - {DOMElement} A reference to layer.events.element.

Supported map event types: loadstart - Triggered when layer loading starts. When using a Vector layer with a Fixed or BBOX strategy, the event object includes a filter property holding the OpenLayers.Filter used when calling read on the protocol. loadend - Triggered when layer loading ends. When using a Vector layer with a Fixed or BBOX strategy, the event object includes a response property holding an OpenLayers.Protocol.Response object. visibilitychanged - Triggered when the layer's visibility property is changed, e.g. by turning the layer on or off in the layer switcher. Note that the actual visibility of the layer can also change if it gets out of range (see ). If you also want to catch these cases, register for the map's 'changelayer' event instead. move - Triggered when layer moves (triggered with every mousemove during a drag). moveend - Triggered when layer is done moving, object passed as argument has a zoomChanged boolean property which tells that the zoom has changed. added - Triggered after the layer is added to a map. Listeners will receive an object with a map property referencing the map and a layer property referencing the layer. removed - Triggered after the layer is removed from the map. Listeners will receive an object with a map property referencing the map and a layer property referencing the layer.

public grid: Array<OpenLayers.Tile[]>

Property: grid {Array(Array())} This is an array of rows, each row is an array of tiles.

public gridLayout: { tilelon: number; tilelat: number; startcol: number; startrow: number; }

Property: gridLayout {Object} Object containing properties tilelon, tilelat, startcol, startrow

public gridResolution: number

Property: gridResolution {Number} The resolution of the current grid. Used for backbuffer and client zoom. This property is updated every time the grid is initialized.

public gutter: number

Determines the width (in pixels) of the gutter around image tiles to ignore. By setting this property to a non-zero value, images will be requested that are wider and taller than the tile size by a value of 2 x gutter. This allows artifacts of rendering at tile edges to be ignored. Set a gutter value that is equal to half the size of the widest symbol that needs to be displayed. Defaults to zero. Non-tiled layers always have zero gutter.

public id: string

public imageSize: Size

For layers with a gutter, the image is larger than the tile by twice the gutter in each dimension.

public inRange: boolean

The current map resolution is within the layer's min/max range. This is set in whenever the zoom changes.

public isBaseLayer: boolean

APIProperty: isBaseLayer Default is true, as this is designed to be a base tile source.

public loading: boolean

Property: loading {Boolean} Indicates if tiles are being loaded.

public map: Map

This variable is set when the layer is added to the map, via the accessor function setMap()

public maxExtent: Bounds

The maximum extent for the layer. Defaults to null.

public maxResolution: number

Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps. Specify a different value in the layer options if you are not using the default and displaying the whole world.

public maxScale: number

public metadata: Object

This object can be used to store additional information on a layer object.

public minExtent: Bounds

The minimum extent for the layer. Defaults to null.

public minResolution: number

public minScale: number

public numLoadingTiles: number

APIProperty: numLoadingTiles {Integer} How many tiles are still loading?

public numZoomLevels: number

public opacity: number

The layer's opacity. Float number between 0.0 and 1.0.

public options: Object

An optional object whose properties will be set on the layer. Any of the layer properties can be set as a property of the options object and sent to the constructor when the layer is created.

public params: Object

Property: params {Object} Hashtable of key/value parameters

public projection: Projection

Specifies the projection of the layer. Can be set in the layer options. If not specified in the layer options, it is set to the default projection specified in the map, when the layer is added to the map. Projection along with default maxExtent and resolutions are set automatically with commercial baselayers in EPSG:3857, such as Google, Bing and OpenStreetMap, and do not need to be specified. Otherwise, if specifying projection, also set maxExtent, maxResolution or resolutions as appropriate. When using vector layers with strategies, layer projection should be set to the projection of the source data if that is different from the map default.

public ratio: number

APIProperty: ratio {Float} Used only when in single-tile mode, this specifies the ratio of the size of the single tile to the size of the map. Default value is 1.5.

public removeBackBufferDelay: number

APIProperty: removeBackBufferDelay {Number} Delay for removing the backbuffer when all tiles have finished loading. Can be set to 0 when no css opacity transitions for the olTileImage class are used. Default is 0 for layers, 2500 for tiled layers. See for more information on tile animation.

public reproject: boolean

APIProperty: reproject Deprecated. See http://docs.openlayers.org/library/spherical_mercator.html for information on the replacement for this functionality. {Boolean} Whether layer should reproject itself based on base layer locations. This allows reprojection onto commercial layers. Default is false: Most layers can't reproject, but layers which can create non-square geographic pixels can, like WMS.

public resolutions: Array<any>

A list of map resolutions (map units per pixel) in descending order. If this is not set in the layer constructor, it will be set based on other resolution related properties (maxExtent, maxResolution, maxScale, etc.).

public rowSign: number

Property: rowSign {Number} 1 for grids starting at the top, -1 for grids starting at the bottom. This is used for several grid index and offset calculations.

public scales: Array<any>

An array of map scales in descending order. The values in the array correspond to the map scale denominator. Note that these values only make sense if the display (monitor) resolution of the client is correctly guessed by whomever is configuring the application. In addition, the units property must also be set. Use instead wherever possible.

public serverResolutions: Array<number>

APIProperty: serverResolutions {Array} A list of all resolutions available on the server. Only set this property if the map resolutions differ from the server. This property serves two purposes. (a) can include resolutions that the server supports and that you don't want to provide with this layer; you can also look at , which is an alternative to for that specific purpose. (b) The map can work with resolutions that aren't supported by the server, i.e. that aren't in . When the map is displayed in such a resolution data for the closest server-supported resolution is loaded and the layer div is stretched as necessary.

public singleTile: boolean

APIProperty: singleTile {Boolean} Moves the layer into single-tile mode, meaning that one tile will be loaded. The tile's size will be determined by the 'ratio' property. When the tile is dragged such that it does not cover the entire viewport, it is reloaded.

public tileClass: Tile

APIProperty: tileClass {} The tile class to use for this layer. Defaults is OpenLayers.Tile.Image.

public tileOrigin: LonLat

APIProperty: tileOrigin {} Optional origin for aligning the grid of tiles. If provided, requests for tiles at all resolutions will be aligned with this location (no tiles shall overlap this location). If not provided, the grid of tiles will be aligned with the layer's

. Default is null.

public tileOriginCorner: string

Property: tileOriginCorner {String} If the property is not provided, the tile origin will be derived from the layer's . The corner of the

used is determined by this property. Acceptable values are "tl" (top left), "tr" (top right), "bl" (bottom left), and "br" (bottom right). Default is "bl".

public tileSize: Size

APIProperty: tileSize {}

public transitionEffect: string

APIProperty: transitionEffect {String} The transition effect to use when the map is zoomed. Two posible values:

"resize" - Existing tiles are resized on zoom to provide a visual effect of the zoom having taken place immediately. As the new tiles become available, they are drawn on top of the resized tiles (this is the default setting). "map-resize" - Existing tiles are resized on zoom and placed below the base layer. New tiles for the base layer will cover existing tiles. This setting is recommended when having an overlay duplicated during the transition is undesirable (e.g. street labels or big transparent fills). null - No transition effect.

Using "resize" on non-opaque layers can cause undesired visual effects. Set transitionEffect to null in this case.

public transitionendEvents: Array<string>

Property: transitionendEvents {Array} Event names for transitionend

public units: string

The layer map units. Defaults to null. Possible values are 'degrees' (or 'dd'), 'm', 'ft', 'km', 'mi', 'inches'. Normally taken from the projection. Only required if both map and layers do not define a projection, or if they define a projection which does not define units.

public visibility: boolean

The layer should be displayed in the map. Default is true.

public zoomOffset: number

APIProperty: zoomOffset {Number} If your cache has more zoom levels than you want to provide access to with this layer, supply a zoomOffset. This zoom offset is added to the current map zoom level to determine the level for a requested tile. For example, if you supply a zoomOffset of 3, when the map is at the zoom 0, tiles will be requested from level 3 of your cache. Default is 0 (assumes cache level and map zoom are equivalent). Using is an alternative to setting if you only want to expose a subset of the server resolutions.

public RESOLUTION_PROPERTIES: Array<string>

The properties that are used for calculating resolutions information.

public alpha: boolean

The layer's images have an alpha channel. Default is false.

public alwaysInRange: boolean

If a layer's display should not be scale-based, this should be set to true. This will cause the layer, as an overlay, to always be 'active', by always returning true from the calculateInRange() function.

If not explicitly specified for a layer, its value will be determined on startup in initResolutions() based on whether or not any scale-specific properties have been set as options on the layer. If no scale-specific options have been set on the layer, we assume that it should always be in range.

public attribution: string

Attribution string, displayed when an has been added to the map.

public backBuffer: HTMLElement

Property: backBuffer {DOMElement} The back buffer.

public backBufferLonLat: { lon: number; lat: number; }

Property: backBufferLonLat {Object} The top-left corner of the current back buffer. Includes lon and lat properties. This object is updated each time a back buffer is created.

public backBufferResolution: number

Property: backBufferResolution {Number} The resolution of the current back buffer. This property is updated each time a back buffer is created.

public backBufferTimerId: number

Property: backBufferTimerId {Number} The id of the back buffer timer. This timer is used to delay the removal of the back buffer, thereby preventing flash effects caused by tile animation.

public buffer: number

APIProperty: buffer {Integer} Used only when in gridded mode, this specifies the number of extra rows and columns of tiles on each side which will surround the minimum grid tiles to cover the map. For very slow loading layers, a larger value may increase performance somewhat when dragging, but will increase bandwidth use significantly.

public className: string

APIProperty: className {String} Name of the class added to the layer div. If not set in the options passed to the constructor then className defaults to "olLayerGridSingleTile" for single tile layers (see ), and "olLayerGrid" for non single tile layers.

Note:

The displaying of tiles is not animated by default for single tile layers - OpenLayers' default theme (style.css) includes this: (code) .olLayerGrid .olTileImage { -webkit-transition: opacity 0.2s linear; -moz-transition: opacity 0.2s linear; -o-transition: opacity 0.2s linear; transition: opacity 0.2s linear; } (end) To animate tile displaying for any grid layer the following CSS rule can be used: (code) .olTileImage { -webkit-transition: opacity 0.2s linear; -moz-transition: opacity 0.2s linear; -o-transition: opacity 0.2s linear; transition: opacity 0.2s linear; } (end) In that case, to avoid flash effects, should not be zero.

public displayInLayerSwitcher: boolean

Display the layer's name in the layer switcher. Default is true

public displayOutsideMaxExtent: boolean

Request map tiles that are completely outside of the max extent for this layer. Defaults to false.

public div: HTMLElement

public eventListeners: Object

An optional object whose properties will be set on the layer. Any of the layer properties can be set as a property of the options object and sent to the constructor when the layer is created.

public events: Events

APIProperty: events {}

Register a listener for a particular event with the following syntax: (code) layer.events.register(type, obj, listener); (end)

Listeners will be called with a reference to an event object. The properties of this event depends on exactly what happened.

All event objects have at least the following properties: object - {Object} A reference to layer.events.object. element - {DOMElement} A reference to layer.events.element.

Supported map event types: loadstart - Triggered when layer loading starts. When using a Vector layer with a Fixed or BBOX strategy, the event object includes a filter property holding the OpenLayers.Filter used when calling read on the protocol. loadend - Triggered when layer loading ends. When using a Vector layer with a Fixed or BBOX strategy, the event object includes a response property holding an OpenLayers.Protocol.Response object. visibilitychanged - Triggered when the layer's visibility property is changed, e.g. by turning the layer on or off in the layer switcher. Note that the actual visibility of the layer can also change if it gets out of range (see ). If you also want to catch these cases, register for the map's 'changelayer' event instead. move - Triggered when layer moves (triggered with every mousemove during a drag). moveend - Triggered when layer is done moving, object passed as argument has a zoomChanged boolean property which tells that the zoom has changed. added - Triggered after the layer is added to a map. Listeners will receive an object with a map property referencing the map and a layer property referencing the layer. removed - Triggered after the layer is removed from the map. Listeners will receive an object with a map property referencing the map and a layer property referencing the layer.

public grid: Array<OpenLayers.Tile[]>

Property: grid {Array(Array())} This is an array of rows, each row is an array of tiles.

public gridLayout: { tilelon: number; tilelat: number; startcol: number; startrow: number; }

Property: gridLayout {Object} Object containing properties tilelon, tilelat, startcol, startrow

public gridResolution: number

Property: gridResolution {Number} The resolution of the current grid. Used for backbuffer and client zoom. This property is updated every time the grid is initialized.

public gutter: number

Determines the width (in pixels) of the gutter around image tiles to ignore. By setting this property to a non-zero value, images will be requested that are wider and taller than the tile size by a value of 2 x gutter. This allows artifacts of rendering at tile edges to be ignored. Set a gutter value that is equal to half the size of the widest symbol that needs to be displayed. Defaults to zero. Non-tiled layers always have zero gutter.

public id: string

public imageSize: Size

For layers with a gutter, the image is larger than the tile by twice the gutter in each dimension.

public inRange: boolean

The current map resolution is within the layer's min/max range. This is set in whenever the zoom changes.

public loading: boolean

Property: loading {Boolean} Indicates if tiles are being loaded.

public map: Map

This variable is set when the layer is added to the map, via the accessor function setMap()

public maxExtent: Bounds

The maximum extent for the layer. Defaults to null.

public maxResolution: number

Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps. Specify a different value in the layer options if you are not using the default and displaying the whole world.

public maxScale: number

public metadata: Object

This object can be used to store additional information on a layer object.

public minExtent: Bounds

The minimum extent for the layer. Defaults to null.

public minResolution: number

public minScale: number

public name: string

public numLoadingTiles: number

APIProperty: numLoadingTiles {Integer} How many tiles are still loading?

public numZoomLevels: number

public opacity: number

The layer's opacity. Float number between 0.0 and 1.0.

public options: Object

An optional object whose properties will be set on the layer. Any of the layer properties can be set as a property of the options object and sent to the constructor when the layer is created.

public params: Object

Property: params {Object} Hashtable of key/value parameters

public projection: Projection

Specifies the projection of the layer. Can be set in the layer options. If not specified in the layer options, it is set to the default projection specified in the map, when the layer is added to the map. Projection along with default maxExtent and resolutions are set automatically with commercial baselayers in EPSG:3857, such as Google, Bing and OpenStreetMap, and do not need to be specified. Otherwise, if specifying projection, also set maxExtent, maxResolution or resolutions as appropriate. When using vector layers with strategies, layer projection should be set to the projection of the source data if that is different from the map default.

public ratio: number

APIProperty: ratio {Float} Used only when in single-tile mode, this specifies the ratio of the size of the single tile to the size of the map. Default value is 1.5.

public removeBackBufferDelay: number

APIProperty: removeBackBufferDelay {Number} Delay for removing the backbuffer when all tiles have finished loading. Can be set to 0 when no css opacity transitions for the olTileImage class are used. Default is 0 for layers, 2500 for tiled layers. See for more information on tile animation.

public reproject: boolean

APIProperty: reproject Deprecated. See http://docs.openlayers.org/library/spherical_mercator.html for information on the replacement for this functionality. {Boolean} Whether layer should reproject itself based on base layer locations. This allows reprojection onto commercial layers. Default is false: Most layers can't reproject, but layers which can create non-square geographic pixels can, like WMS.

public resolutions: Array<any>

A list of map resolutions (map units per pixel) in descending order. If this is not set in the layer constructor, it will be set based on other resolution related properties (maxExtent, maxResolution, maxScale, etc.).

public rowSign: number

Property: rowSign {Number} 1 for grids starting at the top, -1 for grids starting at the bottom. This is used for several grid index and offset calculations.

public scales: Array<any>

An array of map scales in descending order. The values in the array correspond to the map scale denominator. Note that these values only make sense if the display (monitor) resolution of the client is correctly guessed by whomever is configuring the application. In addition, the units property must also be set. Use instead wherever possible.

public serverResolutions: Array<number>

Property: serverResolutions {Array(Number}} This property is documented in subclasses as an API property.

public singleTile: boolean

APIProperty: singleTile {Boolean} Moves the layer into single-tile mode, meaning that one tile will be loaded. The tile's size will be determined by the 'ratio' property. When the tile is dragged such that it does not cover the entire viewport, it is reloaded.

public tileClass: Tile

APIProperty: tileClass {} The tile class to use for this layer. Defaults is OpenLayers.Tile.Image.

public tileOptions: Object

APIProperty: tileOptions {Object} optional configuration options for instances created by this Layer, if supported by the tile class.

public tileOrigin: LonLat

APIProperty: tileOrigin {} Optional origin for aligning the grid of tiles. If provided, requests for tiles at all resolutions will be aligned with this location (no tiles shall overlap this location). If not provided, the grid of tiles will be aligned with the layer's

. Default is null.

public tileOriginCorner: string

Property: tileOriginCorner {String} If the property is not provided, the tile origin will be derived from the layer's . The corner of the

used is determined by this property. Acceptable values are "tl" (top left), "tr" (top right), "bl" (bottom left), and "br" (bottom right). Default is "bl".

public tileSize: Size

APIProperty: tileSize {}

public transitionEffect: string

APIProperty: transitionEffect {String} The transition effect to use when the map is zoomed. Two posible values:

"resize" - Existing tiles are resized on zoom to provide a visual effect of the zoom having taken place immediately. As the new tiles become available, they are drawn on top of the resized tiles (this is the default setting). "map-resize" - Existing tiles are resized on zoom and placed below the base layer. New tiles for the base layer will cover existing tiles. This setting is recommended when having an overlay duplicated during the transition is undesirable (e.g. street labels or big transparent fills). null - No transition effect.

Using "resize" on non-opaque layers can cause undesired visual effects. Set transitionEffect to null in this case.

public transitionendEvents: Array<string>

Property: transitionendEvents {Array} Event names for transitionend

public units: string

The layer map units. Defaults to null. Possible values are 'degrees' (or 'dd'), 'm', 'ft', 'km', 'mi', 'inches'. Normally taken from the projection. Only required if both map and layers do not define a projection, or if they define a projection which does not define units.

public url: Array<string>

Property: url {Array(String) or String} This is either an array of url strings or a single url string.

public visibility: boolean

The layer should be displayed in the map. Default is true.

public wrapDateLine: boolean

Wraps the world at the international dateline, so the map can be panned infinitely in longitudinal direction. Only use this on the base layer, and only if the layer's maxExtent equals the world bounds.

public RESOLUTION_PROPERTIES: Array<string>

The properties that are used for calculating resolutions information.

public alpha: boolean

The layer's images have an alpha channel. Default is false.

public alwaysInRange: boolean

If a layer's display should not be scale-based, this should be set to true. This will cause the layer, as an overlay, to always be 'active', by always returning true from the calculateInRange() function.

If not explicitly specified for a layer, its value will be determined on startup in initResolutions() based on whether or not any scale-specific properties have been set as options on the layer. If no scale-specific options have been set on the layer, we assume that it should always be in range.

public attribution: string

Attribution string, displayed when an has been added to the map.

public backBuffer: HTMLElement

Property: backBuffer {DOMElement} The back buffer.

public backBufferLonLat: { lon: number; lat: number; }

Property: backBufferLonLat {Object} The top-left corner of the current back buffer. Includes lon and lat properties. This object is updated each time a back buffer is created.

public backBufferResolution: number

Property: backBufferResolution {Number} The resolution of the current back buffer. This property is updated each time a back buffer is created.

public backBufferTimerId: number

Property: backBufferTimerId {Number} The id of the back buffer timer. This timer is used to delay the removal of the back buffer, thereby preventing flash effects caused by tile animation.

public buffer: number

APIProperty: buffer {Integer} Used only when in gridded mode, this specifies the number of extra rows and columns of tiles on each side which will surround the minimum grid tiles to cover the map. For very slow loading layers, a larger value may increase performance somewhat when dragging, but will increase bandwidth use significantly.

public className: string

APIProperty: className {String} Name of the class added to the layer div. If not set in the options passed to the constructor then className defaults to "olLayerGridSingleTile" for single tile layers (see ), and "olLayerGrid" for non single tile layers.

Note:

The displaying of tiles is not animated by default for single tile layers - OpenLayers' default theme (style.css) includes this: (code) .olLayerGrid .olTileImage { -webkit-transition: opacity 0.2s linear; -moz-transition: opacity 0.2s linear; -o-transition: opacity 0.2s linear; transition: opacity 0.2s linear; } (end) To animate tile displaying for any grid layer the following CSS rule can be used: (code) .olTileImage { -webkit-transition: opacity 0.2s linear; -moz-transition: opacity 0.2s linear; -o-transition: opacity 0.2s linear; transition: opacity 0.2s linear; } (end) In that case, to avoid flash effects, should not be zero.

public displayInLayerSwitcher: boolean

Display the layer's name in the layer switcher. Default is true

public displayOutsideMaxExtent: boolean

Request map tiles that are completely outside of the max extent for this layer. Defaults to false.

public div: HTMLElement

public eventListeners: Object

An optional object whose properties will be set on the layer. Any of the layer properties can be set as a property of the options object and sent to the constructor when the layer is created.

public events: Events

APIProperty: events {}

Register a listener for a particular event with the following syntax: (code) layer.events.register(type, obj, listener); (end)

Listeners will be called with a reference to an event object. The properties of this event depends on exactly what happened.

All event objects have at least the following properties: object - {Object} A reference to layer.events.object. element - {DOMElement} A reference to layer.events.element.

Supported map event types: loadstart - Triggered when layer loading starts. When using a Vector layer with a Fixed or BBOX strategy, the event object includes a filter property holding the OpenLayers.Filter used when calling read on the protocol. loadend - Triggered when layer loading ends. When using a Vector layer with a Fixed or BBOX strategy, the event object includes a response property holding an OpenLayers.Protocol.Response object. visibilitychanged - Triggered when the layer's visibility property is changed, e.g. by turning the layer on or off in the layer switcher. Note that the actual visibility of the layer can also change if it gets out of range (see ). If you also want to catch these cases, register for the map's 'changelayer' event instead. move - Triggered when layer moves (triggered with every mousemove during a drag). moveend - Triggered when layer is done moving, object passed as argument has a zoomChanged boolean property which tells that the zoom has changed. added - Triggered after the layer is added to a map. Listeners will receive an object with a map property referencing the map and a layer property referencing the layer. removed - Triggered after the layer is removed from the map. Listeners will receive an object with a map property referencing the map and a layer property referencing the layer.

public grid: Array<OpenLayers.Tile[]>

Property: grid {Array(Array())} This is an array of rows, each row is an array of tiles.

public gridLayout: { tilelon: number; tilelat: number; startcol: number; startrow: number; }

Property: gridLayout {Object} Object containing properties tilelon, tilelat, startcol, startrow

public gridResolution: number

Property: gridResolution {Number} The resolution of the current grid. Used for backbuffer and client zoom. This property is updated every time the grid is initialized.

public gutter: number

Determines the width (in pixels) of the gutter around image tiles to ignore. By setting this property to a non-zero value, images will be requested that are wider and taller than the tile size by a value of 2 x gutter. This allows artifacts of rendering at tile edges to be ignored. Set a gutter value that is equal to half the size of the widest symbol that needs to be displayed. Defaults to zero. Non-tiled layers always have zero gutter.

public id: string

public imageSize: Size

For layers with a gutter, the image is larger than the tile by twice the gutter in each dimension.

public inRange: boolean

The current map resolution is within the layer's min/max range. This is set in whenever the zoom changes.

public loading: boolean

Property: loading {Boolean} Indicates if tiles are being loaded.

public map: Map

This variable is set when the layer is added to the map, via the accessor function setMap()

public maxExtent: Bounds

The maximum extent for the layer. Defaults to null.

public maxResolution: number

Default max is 360 deg / 256 px, which corresponds to zoom level 0 on gmaps. Specify a different value in the layer options if you are not using the default and displaying the whole world.

public maxScale: number

public metadata: Object

This object can be used to store additional information on a layer object.

public minExtent: Bounds

The minimum extent for the layer. Defaults to null.

public minResolution: number

public minScale: number

public name: string

public numLoadingTiles: number

APIProperty: numLoadingTiles {Integer} How many tiles are still loading?

public numZoomLevels: number

public opacity: number

The layer's opacity. Float number between 0.0 and 1.0.

public options: Object

An optional object whose properties will be set on the layer. Any of the layer properties can be set as a property of the options object and sent to the constructor when the layer is created.

public params: Object

Property: params {Object} Hashtable of key/value parameters

public projection: Projection

Specifies the projection of the layer. Can be set in the layer options. If not specified in the layer options, it is set to the default projection specified in the map, when the layer is added to the map. Projection along with default maxExtent and resolutions are set automatically with commercial baselayers in EPSG:3857, such as Google, Bing and OpenStreetMap, and do not need to be specified. Otherwise, if specifying projection, also set maxExtent, maxResolution or resolutions as appropriate. When using vector layers with strategies, layer projection should be set to the projection of the source data if that is different from the map default.

public ratio: number

APIProperty: ratio {Float} Used only when in single-tile mode, this specifies the ratio of the size of the single tile to the size of the map. Default value is 1.5.

public removeBackBufferDelay: number

APIProperty: removeBackBufferDelay {Number} Delay for removing the backbuffer when all tiles have finished loading. Can be set to 0 when no css opacity transitions for the olTileImage class are used. Default is 0 for layers, 2500 for tiled layers. See for more information on tile animation.

public reproject: boolean

APIProperty: reproject Deprecated. See http://docs.openlayers.org/library/spherical_mercator.html for information on the replacement for this functionality. {Boolean} Whether layer should reproject itself based on base layer locations. This allows reprojection onto commercial layers. Default is false: Most layers can't reproject, but layers which can create non-square geographic pixels can, like WMS.

public resolutions: Array<any>

A list of map resolutions (map units per pixel) in descending order. If this is not set in the layer constructor, it will be set based on other resolution related properties (maxExtent, maxResolution, maxScale, etc.).

public rowSign: number

Property: rowSign {Number} 1 for grids starting at the top, -1 for grids starting at the bottom. This is used for several grid index and offset calculations.

public scales: Array<any>

An array of map scales in descending order. The values in the array correspond to the map scale denominator. Note that these values only make sense if the display (monitor) resolution of the client is correctly guessed by whomever is configuring the application. In addition, the units property must also be set. Use instead wherever possible.

public singleTile: boolean

APIProperty: singleTile {Boolean} Moves the layer into single-tile mode, meaning that one tile will be loaded. The tile's size will be determined by the 'ratio' property. When the tile is dragged such that it does not cover the entire viewport, it is reloaded.

public tileClass: Tile

APIProperty: tileClass {} The tile class to use for this layer. Defaults is OpenLayers.Tile.Image.

public tileOptions: Object

APIProperty: tileOptions {Object} optional configuration options for instances created by this Layer, if supported by the tile class.

public tileOrigin: LonLat

APIProperty: tileOrigin {} Optional origin for aligning the grid of tiles. If provided, requests for tiles at all resolutions will be aligned with this location (no tiles shall overlap this location). If not provided, the grid of tiles will be aligned with the layer's

. Default is null.

public tileOriginCorner: string

Property: tileOriginCorner {String} If the property is not provided, the tile origin will be derived from the layer's . The corner of the

used is determined by this property. Acceptable values are "tl" (top left), "tr" (top right), "bl" (bottom left), and "br" (bottom right). Default is "bl".

public tileSize: Size

APIProperty: tileSize {}

public transitionEffect: string

APIProperty: transitionEffect {String} The transition effect to use when the map is zoomed. Two posible values:

"resize" - Existing tiles are resized on zoom to provide a visual effect of the zoom having taken place immediately. As the new tiles become available, they are drawn on top of the resized tiles (this is the default setting). "map-resize" - Existing tiles are resized on zoom and placed below the base layer. New tiles for the base layer will cover existing tiles. This setting is recommended when having an overlay duplicated during the transition is undesirable (e.g. street labels or big transparent fills). null - No transition effect.

Using "resize" on non-opaque layers can cause undesired visual effects. Set transitionEffect to null in this case.

public transitionendEvents: Array<string>

Property: transitionendEvents {Array} Event names for transitionend

public units: string

The layer map units. Defaults to null. Possible values are 'degrees' (or 'dd'), 'm', 'ft', 'km', 'mi', 'inches'. Normally taken from the projection. Only required if both map and layers do not define a projection, or if they define a projection which does not define units.

public url: Array<string>

Property: url {Array(String) or String} This is either an array of url strings or a single url string.

public visibility: boolean

The layer should be displayed in the map. Default is true.

public wrapDateLine: boolean

Wraps the world at the international dateline, so the map can be panned infinitely in longitudinal direction. Only use this on the base layer, and only if the layer's maxExtent equals the world bounds.