Search

TileLayer

The tile layer is used with the standalone adapter to add raster tile basemaps to visualizations. See the Tile Layer docs for details.

TileLayer

new TileLayer(def)

Creates a new instance of the layer.

Parameters

def
optional
object

The layer definition object.

data

optional
string

Initial data to load into this layer. Data can be changed after instantiation via layer.data().

id

optional
string

A unique identifier for this layer. If omitted one will be generated automatically.

options

optional
TileLayerOptions

Initial options to set on this layer. Options can be changed after instantiation via layer.options() or layer.resetOptions().

visible

optional
boolean

Initial visibility of this layer. Visibility can be changed after instantiation via layer.visible().

Returns TileLayer

id

readonly
string

A unique id of the layer.

data(data)

Gets or sets the current data for this layer.

Parameters

data
optional
string

The layer data to be displayed.

Returns string

A reference to the data object it was most recently passed.

options(options)

Gets or sets the layer options while preserving any previously set options.

Parameters

options
optional
TileLayerOptions

The layer options to be set.

Returns object

An object containing all layer options and their current values.

overrideStyle(ids, style)

Temporarily overrides the style properties set in the data for the items specified.

Parameters

ids
string | string[]

The ids of the items to override.

style
any

The updated style properties to apply to the specified items.

Returns StyleReset

A reset function that removes the style overrides applied to an item.

resetOptions(options)

Sets the provided layer options while resetting any other previously set options to default values.

Parameters

options
optional
TileLayerOptions

The layer options to be set.

Returns void

visible(state)

Gets or sets the layer visibility.

Parameters

state
optional
boolean

Whether the layer is visible.

Returns boolean

TileLayerOptions

accessToken

optional
string

Access token required for any 3rd party assets (e.g. google maps 3D tiles or Cesium ION).

attribution

optional
string

The text attribution to be shown in the bottom right corner of the map.

type

optional
"raster" | "3d" default: null

The type of tiles to render. By default this will be inferred from your data.

Terms of use

These terms do not alter or supersede any existing agreements between you (or your employer) and us.

By accessing or using any Content you agree to be bound by these Terms of Use. Please review these terms carefully before using the website.

The contents of this website, including but not limited to any text, code samples, API references, schemas, interactive tools, and other materials (collectively, the 'Content'), are made available for informational and internal evaluation purposes only. All intellectual property rights in the Content are reserved. No licence is granted to use the Content for any commercial purpose, or to copy, distribute, modify, reverse-engineer, or incorporate any part of the Content into any product or service, without our prior written consent.

This Content is provided “as is” and “as available,” without any representations, warranties, or guarantees of any kind, whether express or implied, including but not limited to implied warranties of merchantability, fitness for a particular purpose, non-infringement, or accuracy. To the fullest extent permitted by applicable law, we expressly exclude and disclaim all implied warranties, conditions, and other terms that might otherwise be implied.

We disclaim all liability for any loss or damage, whether direct, indirect, incidental, consequential, or otherwise, arising from any reliance placed on the Content or from your use of it, to the fullest extent permitted by applicable law. By continuing to access or use the Content, you acknowledge and agree to these terms.