Class: AbstractLayer

AbstractLayer

Abstract class for creating layer.

new AbstractLayer(type, options)

Parameters:
Name Type Description
type LAYER layer type
options AbstractLayer.configuration Layer Configuration
Implements:

Extends

Methods


getGlobe()

Implements:

getID()

Implements:

getName()

Implements:

getAttribution()

Implements:

getCopyrightUrl()

Implements:

getAck()

Implements:

getIcon()

Implements:

getDescription()

Implements:

isVisible()

Implements:

setVisible()

Implements:

getOpacity()

Implements:

setOpacity()

Implements:

getProperties()

Implements:

getType()

Implements:

isPickable()

Implements:

isType()

Implements:

getServices()

Implements:

getCoordinateSystem()

Implements:

_attach()

Implements:

_detach()

Implements:

getBaseURl()

Implements:

getDataType()

Implements:

getFormat()

Implements:

isDeletable()

Implements:

getColor()

Implements:

getStyle()

Implements:

getAvailableServices()

Implements:

Type Definitions


configuration

AbstactLayer configuration
Type:
  • Object
Properties:
Name Type Argument Default Description
name String <optional>
"" Layer name
attribution String <optional>
"" Attribution
copyrightUrl String <optional>
"" Copyright URL
ack String <optional>
"" ack
icon String <optional>
a default image An icon to represent the layer
description String <optional>
"" A description
visible boolean <optional>
true A boolean flag to display the layer
properties Object <optional>
{} properties
pickable boolean <optional>
false Sets to true to make the layer pickable
service boolean <optional>
[] List of services related to the layer
dataType GEOMETRY the data type for vector layers
background
category

atmosphere_configuration

Atmosphere layer configuration
Type:
Properties:
Name Type Argument Default Description
kr float <optional>
0.0025 the rayleigh parameter
km float <optional>
0.0015 the mie parameter
sunBrightness float <optional>
15 The Sun brightness
exposure float <optional>
2.0 the exposure, use for basic high dynamic range
wavelength Array.<float> <optional>
[0.650, 0.570, 0.475] the RGB color of the sun
lightDir Array.<float> <optional>
[1, 0, 0] The location of the light in (x,y,z)

coordinateGrid_configuration

CoordinateGridLayer configuration
Type:
Properties:
Name Type Argument Default Description
longitudeSample float <optional>
15 Longitude sampling in decimal degree
latitudeSample float <optional>
10 Latitude sampling in decimal degree
coordinateSystem AbstractProjection.configuration | AbstractProjection.azimuth_configuration | AbstractProjection.mercator_configuration The coordinate system of the grid
longFormat String <optional>
"Deg" Representation of longitude axe(HMS, DMS, Deg)
latFormat String <optional>
"Deg" Representation of latitude axe(HMS, DMS, Deg)
tesselation Integer <optional>
2 Tesselation order (only for latitude bands currently)

geojson_configuration

GeoJson layer configuration
Type:
Properties:
Name Type Argument Default Description
url string the url of json data to load when attaching to globe
minLevel int <optional>
0 minimum rendering level depending on tile level
maxLevel int <optional>
15 maximum rendering level depending on tile level
callback function <optional>
the callback function called when data are loaded. Data loaded are passed in parameter of the function.

groundOverlay_configuration

GroundOverlay Layer configuration
Type:

hipsCat_configuration

Hips catalogue configuration
Type:
Properties:
Name Type Argument Default Description
serviceUrl string Endpoint to reach the Hips catalogue
minOrder int <optional>
2 min order
maxRequests int <optional>
4 Max requests in parallel
invertY boolean <optional>
false

moc_configuration

MocLayer configuration
Type:
Properties:
Name Type Argument Default Description
serviceUrl string service URL
startOrder int <optional>
2 Starting order of HEALPix tiling
style Object <optional>
See FeatureStyle description

tileWireFrame_configuration

TileWireFrameLayer configuration
Type:
Properties:
Name Type Argument Default Description
outline <optional>
false

vector_configuration

Vector layer configuration
Type:
Properties:
Name Type Argument Default Description
url string the url of json data to load when attaching to globe
minLevel int <optional>
0 minimum rendering level depending on tile level
maxLevel int <optional>
15 maximum rendering level depending on tile level
callback function <optional>
the callback function called when data are loaded. Data loaded are passed in parameter of the function.