Class Globe

Displays a Globe.

The API is mostly identical to the Map entity.

The globe uses the ECEF reference frame, and the WGS84 spheroid (Ellipsoid.WGS84) by default.

The 3 axes of the 3D scene are the following:

X-axis: the axis that crosses the earth at the (0, 0) geographic position (the intersection between the greenwich meridian and the equator)
Y-axis: the axis that crosses the earth at the (90, 0) geographic position (the intersection between the 90° meridian and the equator).
Z-axis: The rotation axis of the earth (south/north axis).

Hierarchy (view full)

entities.Map
- Globe

Index

Constructors

constructor

new Globe(options?): Globe
Parameters
- Optionaloptions: GlobeConstructorOptions
Returns Globe
Overrides Map.constructor
- Defined in entities/Globe.ts:141

Properties

`Protected`_distance

_distance: {
max: number;
min: number;
}

`Readonly`extent

extent: Extent

`Readonly`hasDefaultPointOfView

hasDefaultPointOfView: true = ...

Readonly flag to check if a given object implements HasDefaultPointOfView.

`Readonly`hasLayers

hasLayers: true = ...

Read-only flag to check if a given object is of type HasLayers.

`Readonly`id

id: string

The unique identifier of this entity.

`Readonly`isEntity

isEntity: boolean = ...

Read-only flag to check if a given object is of type Entity.

`Readonly`isEntity3D

isEntity3D: boolean = ...

Read-only flag to check if a given object is of type Entity3D.

`Readonly`isGlobe

isGlobe: true = ...

`Readonly`isMap

isMap: true = ...

`Readonly`isMemoryUsage

isMemoryUsage: true = ...

Readonly flag to indicate that his object implements MemoryUsage.

`Readonly`isPickable

isPickable = true

`Readonly`isPickableFeatures

isPickableFeatures: true = ...

`Readonly`maxSubdivisionLevel

maxSubdivisionLevel: number

name

name: undefined | string

The name of this entity.

`Readonly`type

type: string = ...

The name of the type of this object.

`Readonly`userData

userData: EntityUserData

An object that can be used to store custom data about the Entity.

Accessors

backgroundColor

get backgroundColor(): Color
Gets or sets the background color.

Returns Color
Inherited from Map.backgroundColor
- Defined in entities/Map.ts:820
set backgroundColor(c): void
Parameters
- c: ColorRepresentation
Returns void
Inherited from Map.backgroundColor
- Defined in entities/Map.ts:824

backgroundOpacity

get backgroundOpacity(): number
Gets or sets the background opacity.

Returns number
Inherited from Map.backgroundOpacity
- Defined in entities/Map.ts:755
set backgroundOpacity(opacity): void
Parameters
- opacity: number
Returns void
Inherited from Map.backgroundOpacity
- Defined in entities/Map.ts:759

castShadow

get castShadow(): boolean
Toggles the .castShadow property on objects generated by this entity.

Returns boolean
Inherited from Map.castShadow
- Defined in entities/Map.ts:857
set castShadow(v): void
Parameters
- v: boolean
Returns void
Inherited from Map.castShadow
- Defined in entities/Map.ts:861

clippingPlanes

get clippingPlanes(): null | Plane[]
Gets or sets the clipping planes set on this entity. Default is null (no clipping planes).

Note: custom entities must ensure that the materials and shaders used do support the clipping plane feature of three.js. Refer to the three.js documentation for more information.

Returns null | Plane[]
Inherited from Map.clippingPlanes
- Defined in entities/Entity3D.ts:173
set clippingPlanes(planes): void
Parameters
- planes: null | Plane[]
Returns void
Inherited from Map.clippingPlanes
- Defined in entities/Entity3D.ts:177

colorimetry

get colorimetry(): Required<ColorimetryOptions>
Gets or sets colorimetry options.

Returns Required<ColorimetryOptions>
Inherited from Map.colorimetry
- Defined in entities/Map.ts:892
set colorimetry(opts): void
Parameters
- opts: ColorimetryOptions
Returns void
Inherited from Map.colorimetry
- Defined in entities/Map.ts:896

contourLines

get contourLines(): Required<ContourLineOptions>
Gets or sets contour line options.

Returns Required<ContourLineOptions>
Inherited from Map.contourLines
- Defined in entities/Map.ts:936
set contourLines(opts): void
Parameters
- opts: ContourLineOptions
Returns void
Inherited from Map.contourLines
- Defined in entities/Map.ts:940

depthTest

get depthTest(): boolean
Gets or sets depth testing on materials.

Returns boolean
Inherited from Map.depthTest
- Defined in entities/Map.ts:744
set depthTest(v): void
Parameters
- v: boolean
Returns void
Inherited from Map.depthTest
- Defined in entities/Map.ts:748

discardNoData

get discardNoData(): boolean
Toggles discard no-data pixels.

Returns boolean
Inherited from Map.discardNoData
- Defined in entities/Map.ts:809
set discardNoData(opacity): void
Parameters
- opacity: boolean
Returns void
Inherited from Map.discardNoData
- Defined in entities/Map.ts:813

distance

get distance(): {
max: number;
min: number;
}
Returns {
max: number;
min: number;
}
- max: number
- min: number
Inherited from Map.distance
- Defined in entities/Entity3D.ts:63

elevationRange

get elevationRange(): null | ElevationRange
Gets or sets elevation range.

Returns null | ElevationRange
Inherited from Map.elevationRange
- Defined in entities/Map.ts:903
set elevationRange(range): void
Parameters
- range: null | ElevationRange
Returns void
Inherited from Map.elevationRange
- Defined in entities/Map.ts:907

ellipsoid

get ellipsoid(): Ellipsoid
The ellipsoid used to draw this globe.

Returns Ellipsoid
- Defined in entities/Globe.ts:125

frozen

get frozen(): boolean
Gets or sets the frozen status of this entity. A frozen entity is still visible but will not be updated automatically.

Useful for debugging purposes.

Returns boolean
Inherited from Map.frozen
- Defined in entities/Entity.ts:144
set frozen(v): void
Parameters
- v: boolean
Returns void
Inherited from Map.frozen
- Defined in entities/Entity.ts:148

graticule

get graticule(): Required<GraticuleOptions>
Gets or sets graticule options.

Returns Required<GraticuleOptions>
Inherited from Map.graticule
- Defined in entities/Map.ts:831
set graticule(opts): void
Parameters
- opts: GraticuleOptions
Returns void
Inherited from Map.graticule
- Defined in entities/Map.ts:835

helperColor

get helperColor(): ColorRepresentation
Shows volumes of tiles.

Returns ColorRepresentation
Inherited from Map.helperColor
- Defined in entities/Map.ts:975
set helperColor(color): void
Parameters
- color: ColorRepresentation
Returns void
Inherited from Map.helperColor
- Defined in entities/Map.ts:979

horizonCulling

get horizonCulling(): boolean
Enables or disable horizon culling.

Returns boolean
Default Value
```
true
```
- Defined in entities/Globe.ts:133
set horizonCulling(v): void
Parameters
- v: boolean
Returns void
- Defined in entities/Globe.ts:137

instance

get instance(): Instance
Returns Instance
Inherited from Map.instance
- Defined in entities/Entity.ts:96

`Protected`isEllipsoidal

get isEllipsoidal(): boolean
Returns boolean
Overrides Map.isEllipsoidal
- Defined in entities/Globe.ts:256

layerCount

get layerCount(): number
Returns the number of layers currently in this object.

Returns number
Inherited from Map.layerCount
- Defined in entities/Map.ts:1810

lighting

get lighting(): Required<MapLightingOptions>
Gets or sets lighting options.

Returns Required<MapLightingOptions>
Inherited from Map.lighting
- Defined in entities/Map.ts:881
set lighting(opts): void
Parameters
- opts: MapLightingOptions
Returns void
Inherited from Map.lighting
- Defined in entities/Map.ts:885

loading

get loading(): boolean
Returns true if this map is currently processing data.

Returns boolean
Inherited from Map.loading
- Defined in entities/Map.ts:695

object3d

get object3d(): Object3D<Object3DEventMap>
Returns the root object of this entity.

Returns Object3D<Object3DEventMap>
Inherited from Map.object3d
- Defined in entities/Entity3D.ts:116

opacity

get opacity(): number
Gets or sets the opacity of this entity.

Returns number
Inherited from Map.opacity
- Defined in entities/Entity3D.ts:154
set opacity(v): void
Parameters
- v: number
Returns void
Inherited from Map.opacity
- Defined in entities/Entity3D.ts:158

progress

get progress(): number
Gets the loading progress (between 0 and 1) of the map. This is the average progress of all layers in this map. Note: if no layer is present, this will always be 1. Note: This value is only meaningful is loading is true.

Returns number
Inherited from Map.progress
- Defined in entities/Map.ts:732

ready

get ready(): boolean
Determine if this entity is ready to use.

Returns boolean
Inherited from Map.ready
- Defined in entities/Entity.ts:92

receiveShadow

get receiveShadow(): boolean
Toggles the .receiveShadow property on objects generated by this entity.

Note that map tiles will receive shadows only if lighting mode is set to MapLightingMode.LightBased.

Returns boolean
Inherited from Map.receiveShadow
- Defined in entities/Map.ts:870
set receiveShadow(v): void
Parameters
- v: boolean
Returns void
Inherited from Map.receiveShadow
- Defined in entities/Map.ts:874

renderOrder

get renderOrder(): number
Gets or sets the render order of this entity.

Returns number
Inherited from Map.renderOrder
- Defined in entities/Entity3D.ts:139
set renderOrder(v): void
Parameters
- v: number
Returns void
Inherited from Map.renderOrder
- Defined in entities/Entity3D.ts:143

rootTiles

get rootTiles(): readonly TileMesh[]
Gets the tiles at the root of the hierarchy (i.e LOD 0).

Returns readonly TileMesh[]
Inherited from Map.rootTiles
- Defined in entities/Map.ts:688

segments

get segments(): number
Returns number
Inherited from Map.segments
- Defined in entities/Map.ts:1000
set segments(v): void
Parameters
- v: number
Returns void
Inherited from Map.segments
- Defined in entities/Map.ts:1004

showBoundingBoxes

get showBoundingBoxes(): boolean
Shows volumes of tiles.

Returns boolean
Inherited from Map.showBoundingBoxes
- Defined in entities/Map.ts:947
set showBoundingBoxes(show): void
Parameters
- show: boolean
Returns void
Inherited from Map.showBoundingBoxes
- Defined in entities/Map.ts:951

showBoundingSpheres

get showBoundingSpheres(): boolean
Shows volumes of tiles.

Returns boolean
Inherited from Map.showBoundingSpheres
- Defined in entities/Map.ts:961
set showBoundingSpheres(show): void
Parameters
- show: boolean
Returns void
Inherited from Map.showBoundingSpheres
- Defined in entities/Map.ts:965

showColliderMeshes

get showColliderMeshes(): boolean
Shows meshes used for raycasting purposes.

Returns boolean
Inherited from Map.showColliderMeshes
- Defined in entities/Map.ts:989
set showColliderMeshes(show): void
Parameters
- show: boolean
Returns void
Inherited from Map.showColliderMeshes
- Defined in entities/Map.ts:993

showTileOutlines

get showTileOutlines(): boolean
Shows tile outlines.

Returns boolean
Inherited from Map.showTileOutlines
- Defined in entities/Map.ts:914
set showTileOutlines(show): void
Parameters
- show: boolean
Returns void
Inherited from Map.showTileOutlines
- Defined in entities/Map.ts:918

side

get side(): Side
Gets or sets the sidedness of the map surface:
- FrontSide will only display the "above ground" side of the map (in cartesian maps), or the outer shell of the map (in globe settings).
- BackSide will only display the "underground" side of the map (in cartesian maps), or the inner shell of the map (in globe settings).
- DoubleSide will display both sides of the map.
Returns Side
Default Value
FrontSide
Inherited from Map.side
- Defined in entities/Map.ts:798
set side(newSide): void
Parameters
- newSide: Side
Returns void
Inherited from Map.side
- Defined in entities/Map.ts:802

subdivisionThreshold

get subdivisionThreshold(): number
The global factor that drives SSE (screen space error) computation. The lower this value, the sooner a tile is subdivided. Note: changing this scale to a value less than 1 can drastically increase the number of tiles displayed in the scene, and can even lead to WebGL crashes.

Returns number
Default Value
DEFAULT_SUBDIVISION_THRESHOLD
Inherited from Map.subdivisionThreshold
- Defined in entities/Map.ts:781
set subdivisionThreshold(v): void
Parameters
- v: number
Returns void
Inherited from Map.subdivisionThreshold
- Defined in entities/Map.ts:785

terrain

get terrain(): Required<TerrainOptions>
Gets or sets the terrain options.

Returns Required<TerrainOptions>
Inherited from Map.terrain
- Defined in entities/Map.ts:766
set terrain(terrain): void
Parameters
- terrain: TerrainOptions
Returns void
Inherited from Map.terrain
- Defined in entities/Map.ts:770

tileIndex

get tileIndex(): Readonly<TileIndex<TileMesh>>
Returns Readonly<TileIndex<TileMesh>>
Inherited from Map.tileIndex
- Defined in entities/Map.ts:681

tileOutlineColor

get tileOutlineColor(): Color
Gets or sets tile outline color.

Returns Color
Inherited from Map.tileOutlineColor
- Defined in entities/Map.ts:925
set tileOutlineColor(color): void
Parameters
- color: ColorRepresentation
Returns void
Inherited from Map.tileOutlineColor
- Defined in entities/Map.ts:929

visible

get visible(): boolean
Gets or sets the visibility of this entity. A non-visible entity will not be automatically updated.

Returns boolean
Inherited from Map.visible
- Defined in entities/Entity3D.ts:124
set visible(v): void
Parameters
- v: boolean
Returns void
Inherited from Map.visible
- Defined in entities/Entity3D.ts:128

wireframe

get wireframe(): boolean
Displays the map tiles in wireframe.

Returns boolean
Inherited from Map.wireframe
- Defined in entities/Map.ts:1029
set wireframe(v): void
Parameters
- v: boolean
Returns void
Inherited from Map.wireframe
- Defined in entities/Map.ts:1033

Methods

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends
      | "initialized"
      | "frozen-property-changed"
      | "visible-property-changed"
      | "layer-order-changed"
      | "layer-added"
      | "layer-removed"
      | "elevation-changed"
      | "paint-complete"
      | "opacity-property-changed"
      | "clippingPlanes-property-changed"
      | "renderOrder-property-changed"
      | "object-created"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<(MapEventMap & Entity3DEventMap & EntityEventMap)[T], T, Globe>
  The function that gets called when the event is fired.
Returns void
Inherited from Map.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:52

addLayer

addLayer<TLayer>(layer): Promise<TLayer>
Adds a layer, then returns the created layer. Before using this method, make sure that the map is added in an instance. If the extent or the projection of the layer is not provided, those values will be inherited from the map.
Type Parameters
- TLayer extends Layer<LayerEvents, LayerUserData>
Parameters
- layer: TLayer
  the layer to add
Returns Promise<TLayer>
a promise resolving when the layer is ready
Inherited from Map.addLayer
- Defined in entities/Map.ts:1713

`Protected`assignRenderOrder

assignRenderOrder(obj): void
Assigns the render order of this object.

This may be overriden to perform custom logic.
Parameters
- obj: Object3D<Object3DEventMap>
Returns void
Inherited from Map.assignRenderOrder
- Defined in entities/Entity3D.ts:331

contains

contains(obj): boolean
Test whether this entity contains the given object.

The object may be a component of the entity, or a 3D object.
Parameters
- obj: unknown
  The object to test.
Returns boolean
true if the entity contains the object.
Inherited from Map.contains
- Defined in entities/Map.ts:1592

`Protected`createTileVolume

createTileVolume(extent): TileVolume
Parameters
- extent: Extent
Returns TileVolume
Overrides Map.createTileVolume
- Defined in entities/Globe.ts:238

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends
      | "initialized"
      | "frozen-property-changed"
      | "visible-property-changed"
      | "layer-order-changed"
      | "layer-added"
      | "layer-removed"
      | "elevation-changed"
      | "paint-complete"
      | "opacity-property-changed"
      | "clippingPlanes-property-changed"
      | "renderOrder-property-changed"
      | "object-created"
Parameters
- event: BaseEvent<T> & (MapEventMap & Entity3DEventMap & EntityEventMap)[T]
  The event that gets fired.
Returns void
Inherited from Map.dispatchEvent
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:81

dispose

dispose(options?): void
Disposes this map and associated unmanaged resources.

Note: By default, layers in this map are not automatically disposed, except when disposeLayers is true.
Parameters
- options: {
  disposeLayers?: boolean;
  } = ...
  Options.
  - OptionaldisposeLayers?: boolean
Returns void
Inherited from Map.dispose
- Defined in entities/Map.ts:1861

filterChangeSources

filterChangeSources(updateSources): Set<unknown>
Filters what objects need to be updated, based on updatedSources. The returned objects are then passed to preUpdate and postUpdate.

Inherited classes should override shouldFullUpdate and shouldUpdate if they need to change this behavior.
Parameters
- updateSources: Set<unknown>
  Sources that triggered an update
Returns Set<unknown>
Set of objects to update
Inherited from Map.filterChangeSources
- Defined in entities/Entity.ts:254

forEachLayer

forEachLayer(callback): void
Applies the callback to each layer in the object.
Parameters
- callback: ((layer: Layer<LayerEvents, LayerUserData>) => void)
  - - (layer): void
    - Parameters
      layer: Layer<LayerEvents, LayerUserData>
      Returns void
Returns void
Inherited from Map.forEachLayer
- Defined in entities/Map.ts:1814

getBoundingBox

getBoundingBox(): null | Box3
Returns an approximated bounding box of this entity in the scene.

Returns null | Box3
the resulting bounding box, or null if it could not be computed.
Inherited from Map.getBoundingBox
- Defined in entities/Entity3D.ts:275

getColorLayers

getColorLayers(): ColorLayer<LayerUserData>[]
Gets all color layers in this map.

Returns ColorLayer<LayerUserData>[]
the color layers
Inherited from Map.getColorLayers
- Defined in entities/Map.ts:1839

`Protected`getComposerProjection

getComposerProjection(): string
Returns string
Overrides Map.getComposerProjection
- Defined in entities/Globe.ts:260

`Protected`getDefaultLightingOptions

getDefaultLightingOptions(): Readonly<Required<MapLightingOptions>>
Returns Readonly<Required<MapLightingOptions>>
Overrides Map.getDefaultLightingOptions
- Defined in entities/Globe.ts:272

getDefaultPointOfView

getDefaultPointOfView(params): null | Readonly<PointOfView>
Looks at the center of the globe from the [0°, 0°] geographic coordinate.
Parameters
- params: {
  camera: Camera;
  }
  - camera: Camera
    The camera to compute the point of view.
Returns null | Readonly<PointOfView>
Overrides Map.getDefaultPointOfView
- Defined in entities/Globe.ts:284

`Protected`getDefaultTerrainOptions

getDefaultTerrainOptions(): Readonly<TerrainOptions>
Returns Readonly<TerrainOptions>
Overrides Map.getDefaultTerrainOptions
- Defined in entities/Globe.ts:264

getElevation

getElevation(options, result?): GetElevationResult
Sample the elevation at the specified coordinate.

Note: this method does nothing if no elevation layer is present on the map, or if the sampling coordinate is not inside the map's extent.

Note: sampling might return more than one sample for any given coordinate. You can sort them by entities.ElevationSample.resolution | resolution to select the best sample for your needs.
Parameters
- options: GetElevationOptions
  The options.
- result: GetElevationResult = ...
  The result object to populate with the samples. If none is provided, a new empty result is created. The existing samples in the array are not removed. Useful to cumulate samples across different maps.
Returns GetElevationResult
The GetElevationResult containing the updated sample array. If the map has no elevation layer, this array is left untouched.
Inherited from Map.getElevation
- Defined in entities/Map.ts:1962

getElevationLayers

getElevationLayers(): ElevationLayer<LayerUserData>[]
Gets all elevation layers in this map.

Returns ElevationLayer<LayerUserData>[]
the elevation layers
Inherited from Map.getElevationLayers
- Defined in entities/Map.ts:1848

getElevationMinMax

getElevationMinMax(): ElevationRange
Returns the minimal and maximal elevation values in this map, in meters.

If there is no elevation layer present, returns { min: 0, max: 0 }.

Returns ElevationRange
The min/max value.
Inherited from Map.getElevationMinMax
- Defined in entities/Map.ts:1919

getElevationMinMaxForVisibleTiles

getElevationMinMaxForVisibleTiles(): null | ElevationRange
Gets the elevation range of visible tiles, or null if no tile is visible.

If there are no elevation layers on this map, returns null as well.

Returns null | ElevationRange
Inherited from Map.getElevationMinMaxForVisibleTiles
- Defined in entities/Map.ts:1890

`Protected`getGeometryBuilder

getGeometryBuilder(): TileGeometryBuilder<TileGeometry>
Returns TileGeometryBuilder<TileGeometry>
Overrides Map.getGeometryBuilder
- Defined in entities/Globe.ts:230

getIndex

getIndex(layer): number
Returns the position of the layer in the layer list, or -1 if it is not found.
Parameters
- layer: Layer<LayerEvents, LayerUserData>
  The layer to search.
Returns number
The index of the layer.
Inherited from Map.getIndex
- Defined in entities/Map.ts:1568

getLayers

getLayers(predicate?): Layer<LayerEvents, LayerUserData>[]
Gets all layers that satisfy the filter predicate.
Parameters
- Optionalpredicate: ((arg0: Layer<LayerEvents, LayerUserData>) => boolean)
  the optional predicate.
  - - (arg0): boolean
    - Parameters
      arg0: Layer<LayerEvents, LayerUserData>
      Returns boolean
Returns Layer<LayerEvents, LayerUserData>[]
the layers that matched the predicate or all layers if no predicate was provided.
Inherited from Map.getLayers
- Defined in entities/Map.ts:1824

getMemoryUsage

getMemoryUsage(context): void
Returns an approximation of the memory used by this object, in bytes.
Parameters
- context: GetMemoryUsageContext
  The graphics context.
Returns void
Inherited from Map.getMemoryUsage
- Defined in entities/Map.ts:622

`Protected`getRootTileMatrix

getRootTileMatrix(): {
x: number;
y: number;
}
Gets the number of vertical and horizontal subdivisions for the root tile matrix.

Returns {
x: number;
y: number;
}
- x: number
- y: number
Inherited from Map.getRootTileMatrix
- Defined in entities/Map.ts:1087

`Protected`getTextureSize

getTextureSize(extent): Vector2
Compute the best image size for tiles, taking into account the extent ratio. In other words, rectangular tiles will have more pixels in their longest side.
Parameters
- extent: Extent
  The tile extent.
Returns Vector2
Overrides Map.getTextureSize
- Defined in entities/Globe.ts:223

`Protected`getTileDimensions

getTileDimensions(extent): Vector2
Parameters
- extent: Extent
Returns Vector2
Overrides Map.getTileDimensions
- Defined in entities/Globe.ts:249

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends
      | "initialized"
      | "frozen-property-changed"
      | "visible-property-changed"
      | "layer-order-changed"
      | "layer-added"
      | "layer-removed"
      | "elevation-changed"
      | "paint-complete"
      | "opacity-property-changed"
      | "clippingPlanes-property-changed"
      | "renderOrder-property-changed"
      | "object-created"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<(MapEventMap & Entity3DEventMap & EntityEventMap)[T], T, Globe>
  The function that gets called when the event is fired.
Returns boolean
Inherited from Map.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:62

insertLayerAfter

insertLayerAfter(layer, target): void
Moves the specified layer after the other layer in the list.
Parameters
- layer: ColorLayer<LayerUserData>
  The layer to move.
- target: null | ColorLayer<LayerUserData>
  The target layer. If null, then the layer is put at the beginning of the layer list.
Returns void
Throws
If the layer is not present in the map.
Example
```
map.addLayer(foo);
map.addLayer(bar);
map.addLayer(baz);
// Layers (back to front) : foo, bar, baz

map.insertLayerAfter(foo, baz);
// Layers (back to front) : bar, baz, foo
```
Inherited from Map.insertLayerAfter
- Defined in entities/Map.ts:1511

`Protected`isOwned

isOwned(obj): boolean
Returns true if this object belongs to this entity.
Parameters
- obj: unknown
  The object to test.
Returns boolean
Inherited from Map.isOwned
- Defined in entities/Entity3D.ts:247

moveLayerDown

moveLayerDown(layer): void
Moves the layer closer to the background.

Note: this only applies to color layers.
Parameters
- layer: ColorLayer<LayerUserData>
  The layer to move.
Returns void
Throws
If the layer is not present in the map.
Example
```
map.addLayer(foo);
map.addLayer(bar);
map.addLayer(baz);
// Layers (back to front) : foo, bar, baz

map.moveLayerDown(baz);
// Layers (back to front) : foo, baz, bar
```
Inherited from Map.moveLayerDown
- Defined in entities/Map.ts:1546

moveLayerUp

moveLayerUp(layer): void
Moves the layer closer to the foreground.

Note: this only applies to color layers.
Parameters
- layer: ColorLayer<LayerUserData>
  The layer to move.
Returns void
Throws
If the layer is not present in the map.
Example
```
map.addLayer(foo);
map.addLayer(bar);
map.addLayer(baz);
// Layers (back to front) : foo, bar, baz

map.moveLayerUp(foo);
// Layers (back to front) : bar, foo, baz
```
Inherited from Map.moveLayerUp
- Defined in entities/Map.ts:1473

`Protected`notifyChange

notifyChange(source?): void
Notifies the parent instance that a change occured in the scene.
Parameters
- Optionalsource: unknown
Returns void
Inherited from Map.notifyChange
- Defined in entities/Entity.ts:337

`Protected`onObjectCreated

onObjectCreated(obj): void
Applies entity-level setup on a new object.

Note: this method should be called from the subclassed entity to notify the parent class that a new 3D object has just been created, so that it can be setup with entity-wide parameters.
Parameters
- obj: Object3D<Object3DEventMap>
  The object to prepare.
Returns void
Example
```
// In the subclass
const obj = new Object3D();

// Notify the parent class
this.onObjectCreated(obj);
```
Inherited from Map.onObjectCreated
- Defined in entities/Entity3D.ts:311

onRenderingContextLost

onRenderingContextLost(options): void
Called when the rendering context has been lost.
Parameters
- options: {
  canvas: HTMLCanvasElement;
  }
  The options.
  - canvas: HTMLCanvasElement
Returns void
Inherited from Map.onRenderingContextLost
- Defined in entities/Entity3D.ts:104

onRenderingContextRestored

onRenderingContextRestored(): void
Called when the rendering context has been restored.

Returns void
Inherited from Map.onRenderingContextRestored
- Defined in entities/Map.ts:1489

pick

pick(coordinates, options?): MapPickResult<unknown>[]
Parameters
- coordinates: Vector2
  Coordinates on the rendering canvas
- Optionaloptions: PickOptions
  Options
Returns MapPickResult<unknown>[]
Target
Inherited from Map.pick
- Defined in entities/Map.ts:1271

pickFeaturesFrom

pickFeaturesFrom(pickedResult, options?): unknown[]
Given a PickResult, returns and assigns its features.

Implementations must set pickedResult.features to the returned result.
Parameters
- pickedResult: MapPickResult<unknown>
  Picked result
- Optionaloptions: PickOptions
  Options
Returns unknown[]
Features
Inherited from Map.pickFeaturesFrom
- Defined in entities/Map.ts:1375

postUpdate

postUpdate(context): void
Method called after Entity.update.
Parameters
- context: Context
  the update context.
Returns void
Inherited from Map.postUpdate
- Defined in entities/Map.ts:1658

preprocess

preprocess(): Promise<void>
Asynchronously preprocess the entity. This method may be overriden to perform any operation that must be done before the entity can be used in the scene, such as fetching metadata about a dataset, etc.

Returns Promise<void>
A promise that resolves when the entity is ready to be used.
Inherited from Map.preprocess
- Defined in entities/Map.ts:1091

preUpdate

preUpdate(context, changeSources): TileMesh[]
This method is called just before update() to filter and select which elements should be actually updated. For example, in the case of complex entities made of a hierarchy of elements, the entire hierarchy may not need to be updated.

Use this method to optimize the update step by reducing the number of elements to process.

Note: if this functions returns nothing, update() will not be called.
Parameters
- context: Context
  the update context.
- changeSources: Set<unknown>
  the objects that triggered an update step. This is useful to filter out unnecessary updates if no sources are relevant to this entity. For example, if one of the sources is a camera that moved during the previous frame, any entity that depends on the camera's field of view should be updated.
Returns TileMesh[]
the elements to update during update().
Overrides Map.preUpdate
- Defined in entities/Globe.ts:177

raycast

raycast(raycaster, intersects): void
Perform raycasting on visible tiles.
Parameters
- raycaster: Raycaster
  The THREE raycaster.
- intersects: Intersection<TileMesh>[]
  The intersections array to populate with intersections.
Returns void
Inherited from Map.raycast
- Defined in entities/Map.ts:1365

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends
      | "initialized"
      | "frozen-property-changed"
      | "visible-property-changed"
      | "layer-order-changed"
      | "layer-added"
      | "layer-removed"
      | "elevation-changed"
      | "paint-complete"
      | "opacity-property-changed"
      | "clippingPlanes-property-changed"
      | "renderOrder-property-changed"
      | "object-created"
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<(MapEventMap & Entity3DEventMap & EntityEventMap)[T], T, Globe>
  The listener function that gets removed.
Returns void
Inherited from Map.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:72

removeLayer

removeLayer(layer, options?): boolean
Removes a layer from the map.
Parameters
- layer: Layer<LayerEvents, LayerUserData>
  the layer to remove
- options: {
  disposeLayer?: boolean;
  } = {}
  The options.
  - OptionaldisposeLayer?: boolean
    If true, the layer is also disposed.
Returns boolean
true if the layer was present, false otherwise.
Inherited from Map.removeLayer
- Defined in entities/Map.ts:1772

`Protected`setupMaterial

setupMaterial(material): void
Applies entity-level setup on new object's material.

Subclasses can override this to setup custom logic, for instance if the entity can produce objects that are naturally transparent.
Parameters
- material: Material
  the material of the newly created object
Returns void
Inherited from Map.setupMaterial
- Defined in entities/Entity3D.ts:288

shouldCheckForUpdate

shouldCheckForUpdate(): boolean
This method is called before update to check if the MainLoop should try to update this entity or not. For better performances, it should return false if the entity has no impact on the rendering (e.g. the element is not visible).

The inherited child can completely ignore this value if it makes sense.

Returns boolean
true if should check for update
Inherited from Map.shouldCheckForUpdate
- Defined in entities/Entity3D.ts:230

shouldFullUpdate

shouldFullUpdate(updateSource): boolean
This method is called at the beginning of the update step to determine if we should do a full render of the object. This should be the case if, for instance, the source is the camera.

You can override this depending on your needs. The inherited child should not ignore this value, it should do a boolean OR, e.g.: return super.shouldFullUpdate(updateSource) || this.contains(updateSource);
Parameters
- updateSource: unknown
  Source of change
Returns boolean
true if requires a full update of this object
Inherited from Map.shouldFullUpdate
- Defined in entities/Entity3D.ts:234

`Protected`shouldSubdivide

shouldSubdivide(context, node): boolean
Parameters
- context: Context
- node: TileMesh
Returns boolean
Overrides Map.shouldSubdivide
- Defined in entities/Globe.ts:197

shouldUpdate

shouldUpdate(updateSource): boolean
This method is called at the beginning of the update step to determine if we should re-render updateSource. Not used when shouldFullUpdate returns true.

You can override this depending on your needs. The inherited child should not ignore this value, it should do a boolean OR, e.g.: return super.shouldUpdate(updateSource) || this.contains(updateSource);
Parameters
- updateSource: unknown
  Source of change
Returns boolean
true if requires an update of updateSource
Inherited from Map.shouldUpdate
- Defined in entities/Entity3D.ts:238

sortColorLayers

sortColorLayers(compareFn): void
Sort the color layers according to the comparator function.
Parameters
- compareFn: LayerCompareFn
  The comparator function.
Returns void
Inherited from Map.sortColorLayers
- Defined in entities/Map.ts:1432

`Protected`testHorizonVisibility

testHorizonVisibility(node, context): boolean
Parameters
- node: TileMesh
- context: Context
Returns boolean
- Defined in entities/Globe.ts:183

`Protected`testVisibility

testVisibility(node, context): boolean
Parameters
- node: TileMesh
- context: Context
Returns boolean
Overrides Map.testVisibility
- Defined in entities/Globe.ts:151

traverse

traverse(callback, root?): void
Traverses all objects in the hierarchy of this entity.
Parameters
- callback: ((arg0: Object3D<Object3DEventMap>) => void)
  The callback.
  - - (arg0): void
    - Parameters
      arg0: Object3D<Object3DEventMap>
      Returns void
- root: undefined | Object3D<Object3DEventMap> = undefined
  The traversal root. If undefined, the traversal starts at the root object of this entity.
Returns void
Inherited from Map.traverse
- Defined in entities/Entity3D.ts:395

traverseMaterials

traverseMaterials(callback, root?): void
Traverses all materials in the hierarchy of this entity.
Parameters
- callback: ((arg0: Material) => void)
  The callback.
  - - (arg0): void
    - Parameters
      arg0: Material
      Returns void
- root: undefined | Object3D<Object3DEventMap> = undefined
  The traversal root. If undefined, the traversal starts at the root object of this entity.
Returns void
Inherited from Map.traverseMaterials
- Defined in entities/Entity3D.ts:355

traverseMeshes

traverseMeshes(callback, root?): void
Traverses all meshes in the hierarchy of this entity.
Parameters
- callback: ((arg0: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>) => void)
  The callback.
  - - (arg0): void
    - Parameters
      arg0: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
      Returns void
- root: undefined | Object3D<Object3DEventMap> = undefined
  The raversal root. If undefined, the traversal starts at the root object of this entity.
Returns void
Inherited from Map.traverseMeshes
- Defined in entities/Entity3D.ts:378

traverseTiles

traverseTiles(callback, root?): void
Traverses all tiles in the hierarchy of this entity.
Parameters
- callback: ((arg0: TileMesh) => void)
  The callback.
  - - (arg0): void
    - Parameters
      arg0: TileMesh
      Returns void
- root: undefined | Object3D<Object3DEventMap> = undefined
  The raversal root. If undefined, the traversal starts at the root object of this entity.
Returns void
Inherited from Map.traverseTiles
- Defined in entities/Map.ts:2003

update

update(context, node): undefined | unknown[]
Performs an update on an element of the entity.

Note: this method will be called for each element returned by preUpdate().
Parameters
- context: Context
  the update context. This is the same object that the entity whose update() is being called.
- node: TileMesh
Returns undefined | unknown[]
New elements to update
Inherited from Map.update
- Defined in entities/Map.ts:1600

updateClippingPlanes

updateClippingPlanes(): void
Updates the clipping planes of all objects under this entity.

Returns void
Inherited from Map.updateClippingPlanes
- Defined in entities/Entity3D.ts:224

updateOpacity

updateOpacity(): void
Updates the opacity of the entity. Note: this method can be overriden for custom implementations.

Returns void
Inherited from Map.updateOpacity
- Defined in entities/Entity3D.ts:197

updateRenderOrder

updateRenderOrder(): void
Updates the render order of the entity. Note: this method can be overriden for custom implementations.

Returns void
Inherited from Map.updateRenderOrder
- Defined in entities/Entity3D.ts:214

updateVisibility

updateVisibility(): void
Updates the visibility of the entity. Note: this method can be overriden for custom implementations.

Returns void
Inherited from Map.updateVisibility
- Defined in entities/Entity3D.ts:188

Class Globe

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Globe

Properties

Protected_distance

Readonlyextent

ReadonlyhasDefaultPointOfView

ReadonlyhasLayers

Readonlyid

ReadonlyisEntity

ReadonlyisEntity3D

ReadonlyisGlobe

ReadonlyisMap

ReadonlyisMemoryUsage

ReadonlyisPickable

ReadonlyisPickableFeatures

ReadonlymaxSubdivisionLevel

name

Readonlytype

ReadonlyuserData

Accessors

backgroundColor

Returns Color

Parameters

Returns void

backgroundOpacity

Returns number

Parameters

Returns void

castShadow

Returns boolean

Parameters

Returns void

clippingPlanes

Returns null | Plane[]

Parameters

Returns void

colorimetry

Returns Required<ColorimetryOptions>

Parameters

Returns void

contourLines

Returns Required<ContourLineOptions>

Parameters

Returns void

depthTest

Returns boolean

Parameters

Returns void

discardNoData

Returns boolean

Parameters

Returns void

distance

Returns { max: number; min: number; }

max: number

min: number

elevationRange

Returns null | ElevationRange

Parameters

Returns void

ellipsoid

Returns Ellipsoid

frozen

Returns boolean

Parameters

Returns void

graticule

Returns Required<GraticuleOptions>

Parameters

Returns void

helperColor

`Protected`_distance

`Readonly`extent

`Readonly`hasDefaultPointOfView

`Readonly`hasLayers

`Readonly`id

`Readonly`isEntity

`Readonly`isEntity3D

`Readonly`isGlobe

`Readonly`isMap

`Readonly`isMemoryUsage

`Readonly`isPickable

`Readonly`isPickableFeatures

`Readonly`maxSubdivisionLevel

`Readonly`type

`Readonly`userData

Returns {
max: number;
min: number;
}

`Protected`isEllipsoidal