A tile layer is a view on the map containing an array of rectangular content.
Composes an array of quadtiles with composition information and requestor endpoints. This can be used to create static images or print-ready versions of this tile layer at arbitrary extents (both source and target) For example: If you needed a 5x3 inch 300 dpi output you can specify extents in device units to be 1500x900. This function determines the correct zoom level so that the source extents fits in the target extents to the nearest integer zoom level.
Source extents in map units.
Target extents in pixels.
{ quadCollection: 'mapsjs'.tile.quad[]; endpointCollection: string[]; idxMinX: number; idxMinY: number; ulX: number; ulY: number; }
Composed object in the form {quadCollection, endpointCollection, idxMinX, idxMinY, ulX, ulY } where quadCollection is an array of quad objects, endpointCollection is an array of REST endpoints from which to obtain the tiled content, idxMinX and idxMinY are the minimum x and y tile indicies of the collection respectively, and ulX and ulY are the offset in pixels of the upper left tile from the upper left target extents.
Unbind all associations with this tile layer to facilitate garbage collection
Returns the tile layer's descriptor, which describes how requested content is rendered or styled.
any
The tile layer's descriptor.
Gets ID associated with this tile layer.
string
ID of the layer.
Gets the visibility state of this tile layer.
boolean
Whether or not this layer is visible.
Gets maximum zoom level where this tile layer is visible.
number
The maximum zoom level.
Gets minimum zoom level where this tile layer is visible.
number
The minimum zoom level.
Gets the opacity of this tile layer.
number
Opacity as a decimal.
Returns this tile layer's renderer if it exists, which defines how geometry data for a quadView is rendered.
The renderer object.
Returns this tile layer's requestor which defines what kind of content to get and where to get it.
This tile layer's requestor.
Determines whether this tile layer uses a backdrop.
boolean
Whether or not the layer uses a backdrop.
Notifies the tile layer to check for changes to its descriptor.
Notifies the tile layer to check for changes to its renderer.
Instructs the tile loader to populate a specified tile pyramid. This is used to fetch content (e.g. bitmap tiles) and preload it into the browser cache.
Envelope for which to fetch content.
Minimum zoom level for which to fetch content.
Maximum zoom level for which to fetch content.
Sets the tile layer's descriptor, which describes how requested content is rendered or styled.
A descriptor for this tile layer.
Enables or disables the fade in on tile content, which defaults to enabled.
Whether or not fade in on tile content should be enabled.
Sets visibility state of this tile layer.
Whether this layer should be visible or not.
Sets maximum zoom level where this tile layer is visible.
The desired maximum zoom level.
Sets minimum zoom level where this tile layer is visible.
The desired minimum zoom level.
Sets the default action to take on error.
Function to execute on error.
Sets an optional function to be called when the tile loading queue for this layer has emptied.
Callback function.
Sets the optional function to be called by this layer's tile loader during processing. The supplied progress function takes tiles loaded and tiles total parameters.
Callback of the signature action(tileLoaded, tilesTotal).
Sets opacity of this tile layer.
Opacity as a decimal.
Sets optional renderer which defines how geometry data for quadView is rendered.
The renderer delegate function with signature renderer(quadview).
Sets optional request processor for this tile layer. This is an advanced feature allowing developers to tap into tile request pipeline for purposes of customizing requests or manage custom caching. This is also the mechanism used for offline apps with frameworks such as phonegap.
Sets this tile layer's requestor, which defines what kind of content to get and where to get it.
A requestor object.
Sets whether or not to retain and display previous level tile content as you change tile levels to provide a nice zoom level change effect. Once the next level is loaded the old level content is always discarded. This should be set to false if there is translucent content to display. Defaults to true (prior to version 9.0.0001 this value had the same state as useBackdrop.)
Sets pixel bleed on quadTiles, which defaults to 1. Setting this to zero for overlay layers with translucent polygon fills is recommended. Bleed overlap can create faint lines at tile boundries when fill is not opaque.
The number of pixels to bleed.