< Back to Aperture Tiles site

Class: ClientLayer

ClientLayer

A client rendered layer object. Uses JSON data retrieved from the server in conjunction with a Renderer object or html function to create interactable DOM elements.

new ClientLayer(spec)

layer/ClientLayer.js, line 85
Instantiate a ClientLayer object.
Name Type Description
spec Object The specification object. 
{
    opacity  {float}    - The opacity of the layer. Default = 1.0
    enabled  {boolean}  - Whether the layer is visible or not. Default = true
    zIndex   {integer}  - The z index of the layer. Default = 1000
    renderer {Renderer} - The tile renderer object.
}

Extends

Methods

addAggregator(id, renderer)

layer/ClientLayer.js, line 202
Adds an aggregator to the layer.
Name Type Description
id String The aggregator id.
renderer Renderer The renderer to attach to the layer.

getAggregator(id)

layer/ClientLayer.js, line 214
Gets an aggregator by id.
Name Type Description
id String The aggregator id.

inherited getChannel(){String}

layer/Layer.js, line 116
Returns the publish/subscribe channel id of this specific layer.
Returns:
publish/subscribe channel for the layer.

getLevelMinMax(The)

layer/ClientLayer.js, line 320
Get the current minimum and maximum values for the current zoom level.
Name Type Description
The Object min and max of the level.

inherited getOpacity(){float}

layer/Layer.js, line 72
Returns the opacity of the layer.
Returns:
opacity of the layer.

getQueryParamString(){String}

layer/ClientLayer.js, line 330
Generate query parameters based on state of layer
Returns:
query parameter string based on the attributes of this layer.

getTheme(){String}

layer/ClientLayer.js, line 234
Get the current theme for the layer.
Returns:
theme identifier string.

getTileTransformData(){Object}

layer/ClientLayer.js, line 310
Get the transformer data attribute.
Returns:
tile transform data attribute.

getTileTransformType(){String}

layer/ClientLayer.js, line 286
Get the layers transformer type.
Returns:
tile transform type.

inherited getUUID(){String}

layer/Layer.js, line 106
Returns the UUID that uniquely identifies this layer.
Returns:
UUID of the layer.

getZIndex(){integer}

layer/ClientLayer.js, line 262
Get the layers zIndex.
Returns:
zIndex for the layer.

inherited isEnabled(){boolean}

layer/Layer.js, line 96
Get whether or not the layer is enabled.
Returns:
the layer is visible or not.

redraw()

layer/ClientLayer.js, line 341
Redraws the entire layer.

inherited setEnabled(enabled)

layer/Layer.js, line 82
Set whether or not the layer is enabled.
Name Type Description
enabled boolean whether the layer is visible or not

inherited setOpacity(opacity)

layer/Layer.js, line 58
Set the opacity of the layer.
Name Type Description
opacity float opacity value from 0 to 1.

setRenderer(renderer)

layer/ClientLayer.js, line 190
Sets the current renderer of the layer.
Name Type Description
renderer Renderer The renderer to attach to the layer.

setTheme(theme)

layer/ClientLayer.js, line 224
Updates the theme associated with the layer.
Name Type Description
theme String The theme identifier string.

setTileTransformData(transformData)

layer/ClientLayer.js, line 296
Set the tile transform data attribute
Name Type Description
transformData Object The tile transform data attribute.

setTileTransformType(transformType)

layer/ClientLayer.js, line 272
Set the layers tile transform function type.
Name Type Description
transformType String The tile transformer type.

setZIndex(zIndex)

layer/ClientLayer.js, line 244
Set the z index of the layer.
Name Type Description
zIndex integer The new z-order value of the layer, where 0 is front.