api

Modules

Animation

Mizar is able to create different types of animation on a globe :

• InertiaAnimation: Animation simulating inertia for camera navigation
• InterpolatedAnimation : Generic animation to interpolate arbitrary values
• PathAnimation : Animation defined with a path
• SegmentedAnimation : Animation defined with segments

In addition to the classes, a factory is available to help for creating animation. Once the animation is created, the client can handle it by the use of its interface.

Context

Mizar is able to handle different types of context.

A context is a concept that brings together :

• a webGL globe
• a coordinate reference system
• a navigation

	SkyContext	A context representing a sky
	PlanetContext	A context representing a planet

The context is automatically instantiated by the method createContext from Mizar.
In addition to the classes, a factory and a context manager are availables to help for creating context. Once the context is created, the client can handle it by the use of its interface.

Crs

A coordinate reference system is a coordinate system that is related to an object by a geodetic datum. Mizar currently supports the following coordinates reference systems :

	EquatorialCrs	Provides an equatorial coordinate reference system
	GalacticCrs	Provides a galactic coordinate reference system
	Mars2000Crs	Provides a coordinate reference system base on the Mars geoide
	WGS84Crs	Provides a coordinate reference system base on the Earth geoide
	ProjectedCrs	Provides a projected coordinate reference system on a map

In addition to the classes, a factory is available to help for creating coordinate reference system. Once the coordinate reference system is created, the client can handle it by the use of its interface.

Globe

Provides classes for handling a globe.

The different possible globes in MIZAR are :

• a sky
• a planet

A sky is a globe where the camera is located in it whereas the planet is a globe where the camera is located outside.
In addition to the classes, a factory is available to help for creating globe. Once the globe is created, the client can handle it by the use of its interface.

Layer

A layer is an information that can be superimposed on another information. It exists different natures of layer, which are listed as below :

• AtmosphereLayer : A layer to create an atmosphere on a planet.
• BingLayer: The Microsoft service proving a WMTS server.
• CoordinateGridLayer : A layer to create a grid on the sky
• GeoJSONLayer : A layer to add a GeoJSON on the globe
• GroundOverlayLayer : A layer to draw an image overlay draped onto the terrain
• HipsCatLayer : A layer to draw a HIPS catalogue
• HipsFitsLayer : A layer to draw an Hips Fits
• HipsGraphicLayer : A layer to draw a Hips JPEG/PNG
• MocLayer : A layer to draw a multi-order-coverage index
• OpenSearchLayer : A layer to draw the result from an open search service
• OSMLayer : A layer to display data coming from OpenStreetMap server
• PlanetLayer : A layer to save all layers of a planet
• TileWireframeLayer : A layer to draw a grid on the planet
• VectorLayer : A layer to draw a vector
• WCSElevationLayer : A layer to draw the elevation
• WMSElevationLayer : A layer to draw the elevation
• WMSLayer : A layer to draw images coming from the WMS server
• WMTSLayer : A layer to draw predefined tiles coming from a WMTS server

In addition to the classes, a factory is available to help for creating layer. Once the layer is created, the client can handle it by the use of its interface.

Navigation

Mizar owns different types of navigation to control the camera on the WebGL scene.

	AstroNavigation	Provides a camera located at the center of the scene. The camera is inside the globe. It is used to view the sky
	PlanetNavigation	Provides a camera, located outside the globe and looking at the globe. It is used to view a planet
	FlatNavigation	Provides a camera to navigate on a 2D map - Only available in a Planet context

The camera is automatically instantiated by the context AbstractContext, which is created by client. Usually, the navigation is in 3D (AstroNavigation or PlanetNavigation). However, in a particular case, when the client selects a Coordinate Reference System with a projection, the FlatNavigation is selected.

Then the client can control the navigation by its interface

In addition, the navigation is controlled by the user with the help of devices : keyboard, touch, mouse. When creating the Mizar instance, the user can define a list of supported devices to be able to control the navigation by these devices. By default, the MouseNavigationHandler and KeyboardNavigationHandler are set up. When the parameter isMobile is set to true in Mizar options, then the TouchNavigationHandler is set up

Projection

Mizar owns different types of projection, which is used to represent a planet on a 2D map.

	AitoffProjection	Provides a AITOFF projection
	AugustProjection	Provides an august projection
	AzimuthProjection	Provides an azimuth projection
	MercatorProjection	Provides a mercator projection
	MollweideProjection	Provides a mollweide projection
	PlateProjection	Provides a plate carrée projection

The projection is automatically instantiated by the ProjectedCrs class.

Provider

Provider

ReverseNameResolver

Reverse Name resolver module : API allowing to retrieve information from a geo picking

NameResolver

Name resolver module : API allowing to search object name and zoom to it

Classes

Mizar

Creates an instance of the Mizar API.

Mizar

Creates an instance of the Mizar API.

AbstractAnimation

AbstractAnimation is an abstract class for all animation contexts which allow an application to create an animation of the camera around the globe.

AbstractContext

The active context object can normally be obtained from the ContextManager class of the Mizar instance.
A context is the main webGL object that contains its own coordinate reference system, its own data, its own navigation and its own GUI.
Client implementations should not normally instantiate this class directly.

AbstractCrs

Creates an coordinate reference system for a globe and data.

A coordinate reference system is a coordinate system that is related to an object by a geodetic datum.

A coordinate system is a set of mathematical rules for specifying how coordinates are to be assigned to points

AbstractGlobe

Creates a sky or a planet with it own coordinate reference system and renders the globe. According to its coordinate reference system, the globe can be projected on a map.
Client implementations should not normally instantiate this class directly.

AbstractTracker

Abstract class for tracker (position, elevation...)

ElevationTracker ⇐ AbstractTracker

ElevationTracker context constructor

PositionTracker ⇐ AbstractTracker

PositionTracker constructor

AbstractHipsLayer ⇐ AbstractRasterLayer

Abstract class for HIPS

AbstractLayer ⇐ Event

Abstract class for creating layer.

AbstractRasterLayer ⇐ AbstractLayer

Base class for raster layer

HipsMetadata

Hips data model

OSData

OpenSearch renderable

AbstractNavigation ⇐ Event

The active navigation object can normally be obtained from the Mizar#getNavigation method of the Mizar instance. Client implementations should not normally instantiate this class directly.

KMLParser constructor

ParserFactory

Parser Factory

AbstractProjection

Abstract class for projections. A map projection is one of many methods used to represent the 3-dimensional surface of the earth or other round body on a 2-dimensional plane in cartography. The creation of a map projection involves two steps :

• selection of a model for the shape of the body (choosing between a sphere or ellipsoid),
• transform planetographic coordinates to plane coordinates.

BatchRenderable

Base renderable

BoundingBox

Bounding Box

Bucket

Bucket constructor for ConvexPolygonRenderer

Renderable

Renderable constructor Attach to a bucket

ConvexPolygonRenderer ⇐ VectorRenderer

ConvexPolygonRenderer constructor

DynamicImage

DynamicImage constructor

FeatureOverlayManager

FeatureOverlayManager constructor

FeatureStyle

The style to display a Feature

Plane

Plane constructor

Frustum

Frustum constructor

GeoBound

Geo Bound

GroundOverlayRenderer

GroundOverlayRenderer constructor

LineRenderer

Basic renderer to animate lines with gradient color texture

LineRenderable ⇐ BatchRenderable

Renderable constructor for Line

LineBucket

Bucket constructor for LineRenderer

LineRenderer ⇐ TiledVectorRenderable

LineStringRenderable manages lineString data to be rendered on a tile.

LineStringRenderer ⇐ TiledVectorRenderer

LineStringRenderer manages lineString data to be rendered on a tile.

LineStringBucket

Bucket constructor for LineStringRenderer

PlanetPolygonRenderable ⇐ TiledVectorRenderable

PlanetPolygonRenderable constructor

PlanetPolygonRenderer ⇐ TiledVectorRenderer

PlanetPolygonRenderer constructor

PlanetPolygonBucket ⇐ TiledVectorRenderer

Bucket constructor for PlanetPolygonRenderer

PointRenderer ⇐ VectorRenderer

POI Renderer constructor

PointRenderable

Renderable constructor for Point

PointBucket

Bucket constructor for PointRenderer

PointSpriteRenderer ⇐ VectorRenderer

PointSpriteRenderer constructor

Renderable

Renderable constructor for PointSprite

Bucket

Bucket constructor for PointSpriteRenderer

PolygonRenderable ⇐ TiledVectorRenderable

PolygonRenderable constructor

PointSet

PointSet constructor

PolygonRenderer ⇐ TiledVectorRenderer

PolygonRenderer constructor

PolygonBucket

PolygonBucket constructor

PolygonRenderer ⇐ VectorRenderer

Basic renderer for polygon

PolygonRenderable ⇐ BatchRenderable

Renderable constructor for Polygon

PolygonBucket

Bucket constructor for PolygonRenderer

Program

Program constructor

RasterOverlayRenderer

RasterOverlayRenderer constructor

RasterOverlayRenderable

Create a renderable for the overlay. There is one renderable per overlay and per tile.

Bucket

Bucket constructor for RasterOverlay

Ray

Ray constructor

RenderContext

RenderContext constructor

RendererTileData

RendererTileData constructor Contains a list of renderables for the tiles

StencilPolygonRenderer

Basic renderer for polygon

PolygonRenderable

Renderable constructor for Polygon

PolygonBucket

Bucket constructor for PolygonRenderer

VectorRenderer

VectorRenderer constructor

VectorRendererManager

VectorRendererManager constructor

MatrixArray

System-specific optimal array type

vec3

3 Dimensional Vector

mat3

3x3 Matrix

mat4

4x4 Matrix

quat4

AbstractNameResolverer

Abstract Wrapper constructor

init

Tile constructor

GeoTiling constructor

HEALPixTiling

Tile constructor

Mesh constructor

Tile

TileIndexBuffer TileIndexBuffer

TilePool constructor

TileRequest constructor

TiledVectorRenderable constructor

TiledVectorRenderer constructor

AttributionHandler

Manage the attributions

Event

A light-weight event object.

ImageRequest constructor

Long

Long class for only unsigned integers Constructs a 64-bit two's-complement integer, given its low and high 32-bit values as signed integers. See the from* functions below for more convenient ways of constructing Longs.

The internal representation of a long is the two given signed, 32-bit values. We use 32-bit pieces because these are the size of integers on which Javascript performs bit-operations. For operations like addition and multiplication, we split each number into 16-bit pieces, which can easily be multiplied within Javascript's floating-point representation without overflow or change in sign.

In the algorithms below, we frequently reduce the negative case to the positive case by negating the input(s) and then post-processing the result. Note that we must ALWAYS check specially whether those values are MIN_VALUE (-2^63) because -MIN_VALUE == MIN_VALUE (since 2^63 cannot be represented as a positive number, it overflows back into a negative). Not handling this case would often result in infinite recursion.

Stats

Display some rendering statistics in a HTML element

Objects

GENERAL_WAVELENGTH : object

HIPS_FRAME : object

HIPS_TILE_FORMAT : object

SAMPLING : object

PIXEL_OVERLAY : object

SKY_VAL : object

DATA_PRODUCT_TYPE : object

SUB_TYPE_DATA : object

HIPS_METADATA : object

Hips data model Mandatory, description, isMultiple, default value, distinctvalue, isArray

ANIMATION : object

CONTEXT : object

GLOBE : object

LAYER : object

GEOMETRY : object

PROJECTION : object

CRS : object

NAVIGATION : object

SERVICE : object

HANDLER : object

PROVIDER : object

MappingCrsHips2Mizar : object

UTILITY : object

ANIMATION_STATUS : object

Functions

failCallback()

handleFeatureCollection(gwLayer, featureCollection)

Handles feature collection Recompute geometry from equatorial coordinates to geo for each feature Handle feature services Add gid

addCustomColormap(name, colors)

Create custom colormap with equidistant intervals

generateColormap()

Generate colormap

sendRequest(geoPick, options)

Send request to reverse name resolver service for the given gepoint

setContext()

Set new context

init(m, configuration)

Initialize ImageManagerCore

hideImage(featureData)

Hide image

showImage(featureData)

Show image

removeImage(featureData)

Remove image from renderer

addImage(featureData)

Start download of texture

init(options)

Histogram contructor

init(options, $dl, $histoElmt, $cutOutElmt)

Init ImageProcessingCore

addPickableLayer(layer)

Add pickable layer to the pickableLayers list

fxyf()

Function describing a location on the sphere

maxPixrad() ⇒

Returns the maximum angular distance between a pixel center and its corners.

nside2order()

Static function Convert nside to order (ilog2(nside))

lonLat2pix(order, lon, lat)

Returns pixel index of point on sphere

getChildren()

Create the children of the given pixel

getPixRes(nside) ⇒

calculates angular resolution of the pixel map in arc seconds.

Typedefs

serviceRegistryCallback : function

This callback function.

toggleContextCallback : function

Callback after the context switches.

serviceRegistryCallback : function

This callback function.

toggleContextCallback : function

Callback after the context switches.

layerCallback : function

This callback allows to transform FeatureCollection from a GeoJson.

onreadyCallback : function

Callback when the layer is ready.

navigationCallback : function

Callback at the end of animation (when stop method is called).

Animation

Mizar is able to create different types of animation on a globe :

• [InertiaAnimation](#module_Animation.InertiaAnimation): Animation simulating inertia for camera navigation
• [InterpolatedAnimation](#module_Animation.InterpolatedAnimation) : Generic animation to interpolate arbitrary values
• [PathAnimation](#module_Animation.PathAnimation) : Animation defined with a path
• [SegmentedAnimation](#module_Animation.SegmentedAnimation) : Animation defined with segments

In addition to the classes, a factory is available to help for creating animation. Once the animation is created, the client can handle it by the use of its interface.

Implements: Animation
Todo

• Describes here and link to the tutos about Animation

• Animation
  • .AnimationFactory
    • .create(type, options) ⇒ AbstractAnimation
  • .InertiaAnimation ⇐ AbstractAnimation
    • new InertiaAnimation(options)
    • .getRenderContext()
    • .getStatus()
    • .start()
    • .pause()
    • .stop()
  • .InterpolatedAnimation ⇐ AbstractAnimation
    • new InterpolatedAnimation(options)
    • .getRenderContext()
    • .getStatus()
    • .start()
    • .pause()
    • .stop()
  • .PathAnimation ⇐ AbstractAnimation
    • new PathAnimation(options)
    • .getRenderContext()
    • .getStatus()
    • .start()
    • .pause()
    • .stop()
  • .SegmentedAnimation ⇐ AbstractAnimation
    • new SegmentedAnimation(options)
    • .getRenderContext()
    • .getStatus()
    • .start()
    • .pause()
    • .stop()

Animation.AnimationFactory

Factory to create an animation

Kind: static class of Animation

AnimationFactory.create(type, options) ⇒ AbstractAnimation

Factory to create an animation.

Creates an animation based on :

• the animation type [ANIMATION](#ANIMATION),
• the options for the specific animation

Severals animations can be created :

• [InertiaAnimation](#module_Animation.InertiaAnimation)
• [InterpolatedAnimation](#module_Animation.InterpolatedAnimation)
• [PathAnimation](#module_Animation.PathAnimation)
• [SegmentedAnimation](#module_Animation.SegmentedAnimation)

Kind: static method of AnimationFactory
Returns: AbstractAnimation - - the interface to handle an animation
Throws:

• RangeError Type not valid - a valid type is included in the list ANIMATION

See

• InertiaAnimation Animation simulating inertia for camera's navigation
• InterpolatedAnimation Generic animation to interpolate arbitrary values
• PathAnimation Defines an animation based on a path
• SegmentedAnimation Defines an animation based on segments

Param	Type	Description
type	ANIMATION	Type of animation.
options	inertia_configuration | interpolated_configuration | path_configuration | segmented_configuration	See the options for each animation for further information

Animation.InertiaAnimation ⇐ AbstractAnimation

Animation simulating inertia for camera's navigation. Inertia is its tendency to retain its velocity: in the absence of external influence, the camera's motion persists in an uniform rectilinear motion.

Kind: static class of Animation
Extends: AbstractAnimation

• .InertiaAnimation ⇐ AbstractAnimation
  • new InertiaAnimation(options)
  • .getRenderContext()
  • .getStatus()
  • .start()
  • .pause()
  • .stop()

new InertiaAnimation(options)

Param	Type	Description
options	inertia_configuration	Configuration of the Inertia animation

inertiaAnimation.getRenderContext()

Kind: instance method of InertiaAnimation
Implements: getRenderContext

inertiaAnimation.getStatus()

Kind: instance method of InertiaAnimation
Implements: getStatus

inertiaAnimation.start()

Kind: instance method of InertiaAnimation
Implements: start

inertiaAnimation.pause()

Kind: instance method of InertiaAnimation
Implements: pause

inertiaAnimation.stop()

Kind: instance method of InertiaAnimation
Implements: stop

Animation.InterpolatedAnimation ⇐ AbstractAnimation

Generic animation to interpolate arbitrary values The animation will interpolate between startValue and endValue, using the interpolateFunction(t, startValue, endValue) (t [0,1]) The interpolated value is then given to the setFunction(value)

Kind: static class of Animation
Extends: AbstractAnimation
Todo

• Create a tutorial with a simple InterpolatedAnimation on Mars

• .InterpolatedAnimation ⇐ AbstractAnimation
  • new InterpolatedAnimation(options)
  • .getRenderContext()
  • .getStatus()
  • .start()
  • .pause()
  • .stop()

new InterpolatedAnimation(options)

Param	Type	Description
options	interpolated_configuration	Configuration of the InterpolatedAnimation

interpolatedAnimation.getRenderContext()

Kind: instance method of InterpolatedAnimation
Implements: getRenderContext

interpolatedAnimation.getStatus()

Kind: instance method of InterpolatedAnimation
Implements: getStatus

interpolatedAnimation.start()

Kind: instance method of InterpolatedAnimation
Implements: start

interpolatedAnimation.pause()

Kind: instance method of InterpolatedAnimation
Implements: pause

interpolatedAnimation.stop()

Kind: instance method of InterpolatedAnimation
Implements: stop

Animation.PathAnimation ⇐ AbstractAnimation

PathAnimation is an animation defined with a path.

Kind: static class of Animation
Extends: AbstractAnimation
Todo

• Create a tutorial with a simple PathAnimation on Mars

• .PathAnimation ⇐ AbstractAnimation
  • new PathAnimation(options)
  • .getRenderContext()
  • .getStatus()
  • .start()
  • .pause()
  • .stop()

new PathAnimation(options)

Param	Type	Description
options	path_configuration	Configuration of the animation

pathAnimation.getRenderContext()

Kind: instance method of PathAnimation
Implements: getRenderContext

pathAnimation.getStatus()

Kind: instance method of PathAnimation
Implements: getStatus

pathAnimation.start()

Kind: instance method of PathAnimation
Implements: start

pathAnimation.pause()

Kind: instance method of PathAnimation
Implements: pause

pathAnimation.stop()

Kind: instance method of PathAnimation
Implements: stop

Animation.SegmentedAnimation ⇐ AbstractAnimation

SegmentedAnimation is an animation defined with segments. Each segment has a [start,end] pair of 't' value and a [start,end] pair of values that will be interpolated with the interpolator set on the segment. When the animation runs, a t parameter is mapped to [0,1] according to current time and animation duration. The current segment is then looked up with that 't' value and used to interpolate the animation's current value.

Kind: static class of Animation
Extends: AbstractAnimation

• .SegmentedAnimation ⇐ AbstractAnimation
  • new SegmentedAnimation(options)
  • .getRenderContext()
  • .getStatus()
  • .start()
  • .pause()
  • .stop()

new SegmentedAnimation(options)

Param	Type	Description
options	segmented_configuration	Configuration of the animation

segmentedAnimation.getRenderContext()

Kind: instance method of SegmentedAnimation
Implements: getRenderContext

segmentedAnimation.getStatus()

Kind: instance method of SegmentedAnimation
Implements: getStatus

segmentedAnimation.start()

Kind: instance method of SegmentedAnimation
Implements: start

segmentedAnimation.pause()

Kind: instance method of SegmentedAnimation
Implements: pause

segmentedAnimation.stop()

Kind: instance method of SegmentedAnimation
Implements: stop

Context

Mizar is able to handle different types of context.

A context is a concept that brings together :

• a webGL [globe](#AbstractGlobe)
• a [coordinate reference system](#AbstractCrs)
• a [navigation](#AbstractNavigation)

	[SkyContext](#module_Context.SkyContext)	A context representing a sky
	[PlanetContext](#module_Context.PlanetContext)	A context representing a planet

The context is automatically instantiated by the method createContext from Mizar.
In addition to the classes, a factory and a context manager are availables to help for creating context. Once the context is created, the client can handle it by the use of its interface.

Implements: Context

• Context
  • .ContextFactory
    • .create(type, configuration, options) ⇒ Context
  • .PlanetContext ⇐ AbstractContext
    • new PlanetContext(mizarConfiguration, options)
    • ._fillDataProvider(layer, mizarDescription)
    • .getTileManager()
    • .registerNoStandardDataProvider(type, loadFunc)
    • .getContextConfiguration()
    • .getMizarConfiguration()
    • .getLonLatFromPixel()
    • .getPixelFromLonLat()
    • .getElevation()
    • .getPositionTracker()
    • .getElevationTracker()
    • .getLayers()
    • .getLayerByID()
    • .getLayerByName()
    • .addLayer()
    • .removeLayer()
    • .removeAllLayers()
    • .addDraw()
    • .removeDraw()
    • .initTouchNavigation(options)
    • .refresh()
    • .initCanvas(canvas)
    • .iniGlobeEvents(globe)
    • .show()
    • .showComponents()
    • .hideComponents()
    • .hide()
    • .setComponentVisibility()
    • .showAdditionalLayers()
    • .hideAdditionalLayers()
    • .setBackgroundLayer()
    • .setBackgroundLayerByID()
    • .getAdditionalLayers()
    • .getRenderContext()
    • .disbable()
    • .enable()
    • .setCompassVisible()
    • .getMode()
    • .setCoordinateSystem()
    • .getNavigation()
    • .getCoordinateSystem()
    • .addAnimation()
    • .removeAnimation()
    • .render()
    • .dispose()
    • .destroy()
  • .SkyContext ⇐ AbstractContext
    • new SkyContext(mizarConfiguration, options)
    • ._fillDataProvider(layer, mizarDescription)
    • .getTileManager()
    • .registerNoStandardDataProvider(type, loadFunc)
    • .getContextConfiguration()
    • .getMizarConfiguration()
    • .getLonLatFromPixel()
    • .getPixelFromLonLat()
    • .getElevation()
    • .getPositionTracker()
    • .getElevationTracker()
    • .getLayers()
    • .getLayerByID()
    • .getLayerByName()
    • .addLayer()
    • .removeLayer()
    • .removeAllLayers()
    • .addDraw()
    • .removeDraw()
    • .initTouchNavigation(options)
    • .refresh()
    • .initCanvas(canvas)
    • .iniGlobeEvents(globe)
    • .show()
    • .showComponents()
    • .hideComponents()
    • .hide()
    • .setComponentVisibility()
    • .showAdditionalLayers()
    • .hideAdditionalLayers()
    • .setBackgroundLayer()
    • .setBackgroundLayerByID()
    • .getAdditionalLayers()
    • .getRenderContext()
    • .disbable()
    • .enable()
    • .setCompassVisible()
    • .getMode()
    • .setCoordinateSystem()
    • .getNavigation()
    • .getCoordinateSystem()
    • .addAnimation()
    • .removeAnimation()
    • .render()
    • .dispose()
    • .destroy()

Context.ContextFactory

Factory to create a context

Kind: static class of Context

ContextFactory.create(type, configuration, options) ⇒ Context

Factory to create a context.

Creates a context based on :

• the context type [CONTEXT](#CONTEXT),
• the global Mizar's configuration,
• the options for the specific context

Kind: static method of ContextFactory
Returns: Context - - the object to handle an animation
Throws:

• RangeError Type not valid - a valid type is included in the list CONTEXT

Param	Type	Description
type	CONTEXT	Type of animation.
configuration	Object	see options.configuration for Mizar
options	Object	See options.planetContext or options.skyContext configuration for Mizar

Context.PlanetContext ⇐ AbstractContext

Virtual globe where the camera is outside the globe. When an error happens at the initialisation, a message is displayed

Kind: static class of Context
Extends: AbstractContext

• .PlanetContext ⇐ AbstractContext
  • new PlanetContext(mizarConfiguration, options)
  • ._fillDataProvider(layer, mizarDescription)
  • .getTileManager()
  • .registerNoStandardDataProvider(type, loadFunc)
  • .getContextConfiguration()
  • .getMizarConfiguration()
  • .getLonLatFromPixel()
  • .getPixelFromLonLat()
  • .getElevation()
  • .getPositionTracker()
  • .getElevationTracker()
  • .getLayers()
  • .getLayerByID()
  • .getLayerByName()
  • .addLayer()
  • .removeLayer()
  • .removeAllLayers()
  • .addDraw()
  • .removeDraw()
  • .initTouchNavigation(options)
  • .refresh()
  • .initCanvas(canvas)
  • .iniGlobeEvents(globe)
  • .show()
  • .showComponents()
  • .hideComponents()
  • .hide()
  • .setComponentVisibility()
  • .showAdditionalLayers()
  • .hideAdditionalLayers()
  • .setBackgroundLayer()
  • .setBackgroundLayerByID()
  • .getAdditionalLayers()
  • .getRenderContext()
  • .disbable()
  • .enable()
  • .setCompassVisible()
  • .getMode()
  • .setCoordinateSystem()
  • .getNavigation()
  • .getCoordinateSystem()
  • .addAnimation()
  • .removeAnimation()
  • .render()
  • .dispose()
  • .destroy()

new PlanetContext(mizarConfiguration, options)

Param	Type	Description
mizarConfiguration	configuration	mizar configuration
options	planetContext	planet context configuration

planetContext._fillDataProvider(layer, mizarDescription)

Fill data-provider-type layer by features coming from data object

Kind: instance method of PlanetContext
Access: protected

Param	Type	Description
layer	Layer	layer in which data should be added.
mizarDescription	Object	See the base properties configuration and a specific layer for specific properties

planetContext.getTileManager()

Kind: instance method of PlanetContext
Implements: getTileManager

planetContext.registerNoStandardDataProvider(type, loadFunc)

Registers no standard data provider and call them in the addLayer method.

Kind: instance method of PlanetContext

Param	Type	Description
type	string	data provider key
loadFunc	function	Function

Example (Registers planets on the sky)

  var planetProvider = ProviderFactory.create(Constants.PROVIDER.Planet);
  this.registerNoStandardDataProvider("planets", planetProvider.loadFiles);

planetContext.getContextConfiguration()

Kind: instance method of PlanetContext
Implements: getContextConfiguration

planetContext.getMizarConfiguration()

Kind: instance method of PlanetContext
Implements: getMizarConfiguration

planetContext.getLonLatFromPixel()

Kind: instance method of PlanetContext
Implements: getLonLatFromPixel

planetContext.getPixelFromLonLat()

Kind: instance method of PlanetContext
Implements: getPixelFromLonLat

planetContext.getElevation()

Kind: instance method of PlanetContext
Implements: getElevation

planetContext.getPositionTracker()

Kind: instance method of PlanetContext
Implements: getPositionTracker

planetContext.getElevationTracker()

Kind: instance method of PlanetContext
Implements: getElevationTracker

planetContext.getLayers()

Kind: instance method of PlanetContext
Implements: getLayers

planetContext.getLayerByID()

Kind: instance method of PlanetContext
Implements: getLayerByID

planetContext.getLayerByName()

Kind: instance method of PlanetContext
Implements: getLayerByName

planetContext.addLayer()

Kind: instance method of PlanetContext
Implements: addLayer

planetContext.removeLayer()

Kind: instance method of PlanetContext
Implements: removeLayer

planetContext.removeAllLayers()

Kind: instance method of PlanetContext
Implements: removeAllLayers

planetContext.addDraw()

Kind: instance method of PlanetContext
Implements: addDraw

planetContext.removeDraw()

Kind: instance method of PlanetContext
Implements: removeDraw

planetContext.initTouchNavigation(options)

Initializes the touch navigation handler.

Kind: instance method of PlanetContext

Param	Type	Description
options	Object	to add touch navigation
options.navigation	Navigation	Navigation object

planetContext.refresh()

Kind: instance method of PlanetContext
Implements: refresh

planetContext.initCanvas(canvas)

Initialization of the canvas element. When no canvas element is provided, sets to full screen.

Kind: instance method of PlanetContext

Param	Type	Description
canvas	Object	Canvas object
canvas.parentElement	Object	HTML object

planetContext.iniGlobeEvents(globe)

Initializes the planet or sky events.

Kind: instance method of PlanetContext

Param	Type	Description
globe	AbstractGlobe	Planet or Sky object

planetContext.show()

Kind: instance method of PlanetContext
Implements: show

planetContext.showComponents()

Kind: instance method of PlanetContext
Implements: showComponents

planetContext.hideComponents()

Kind: instance method of PlanetContext
Implements: hideComponents

planetContext.hide()

Kind: instance method of PlanetContext
Implements: hide

planetContext.setComponentVisibility()

Kind: instance method of PlanetContext
Implements: setComponentVisibility

planetContext.showAdditionalLayers()

Kind: instance method of PlanetContext
Implements: showAdditionalLayers

planetContext.hideAdditionalLayers()

Kind: instance method of PlanetContext
Implements: hideAdditionalLayers

planetContext.setBackgroundLayer()

Kind: instance method of PlanetContext
Implements: setBackgroundLayer

planetContext.setBackgroundLayerByID()

Kind: instance method of PlanetContext
Implements: setBackgroundLayerByID

planetContext.getAdditionalLayers()

Kind: instance method of PlanetContext
Implements: getAdditionalLayers

planetContext.getRenderContext()

Kind: instance method of PlanetContext
Implements: getRenderContext

planetContext.disbable()

Kind: instance abstract method of PlanetContext

planetContext.enable()

Kind: instance abstract method of PlanetContext
Implements: enable

planetContext.setCompassVisible()

Kind: instance abstract method of PlanetContext
Implements: setCompassVisible

planetContext.getMode()

Kind: instance method of PlanetContext
Implements: getMode

planetContext.setCoordinateSystem()

Kind: instance abstract method of PlanetContext
Implements: setCoordinateSystem

planetContext.getNavigation()

Kind: instance method of PlanetContext
Implements: getNavigation

planetContext.getCoordinateSystem()

Kind: instance method of PlanetContext
Implements: getCoordinateSystem

planetContext.addAnimation()

Kind: instance method of PlanetContext
Implements: addAnimation

planetContext.removeAnimation()

Kind: instance method of PlanetContext
Implements: removeAnimation

planetContext.render()

Kind: instance method of PlanetContext
Implements: Context#render

planetContext.dispose()

Kind: instance method of PlanetContext
Implements: dispose

planetContext.destroy()

Kind: instance abstract method of PlanetContext
Implements: destroy

Context.SkyContext ⇐ AbstractContext

Virtual globe where the camera is inside the globe.
When an error happens at the initialisation, a message is displayed

Kind: static class of Context
Extends: AbstractContext

• .SkyContext ⇐ AbstractContext
  • new SkyContext(mizarConfiguration, options)
  • ._fillDataProvider(layer, mizarDescription)
  • .getTileManager()
  • .registerNoStandardDataProvider(type, loadFunc)
  • .getContextConfiguration()
  • .getMizarConfiguration()
  • .getLonLatFromPixel()
  • .getPixelFromLonLat()
  • .getElevation()
  • .getPositionTracker()
  • .getElevationTracker()
  • .getLayers()
  • .getLayerByID()
  • .getLayerByName()
  • .addLayer()
  • .removeLayer()
  • .removeAllLayers()
  • .addDraw()
  • .removeDraw()
  • .initTouchNavigation(options)
  • .refresh()
  • .initCanvas(canvas)
  • .iniGlobeEvents(globe)
  • .show()
  • .showComponents()
  • .hideComponents()
  • .hide()
  • .setComponentVisibility()
  • .showAdditionalLayers()
  • .hideAdditionalLayers()
  • .setBackgroundLayer()
  • .setBackgroundLayerByID()
  • .getAdditionalLayers()
  • .getRenderContext()
  • .disbable()
  • .enable()
  • .setCompassVisible()
  • .getMode()
  • .setCoordinateSystem()
  • .getNavigation()
  • .getCoordinateSystem()
  • .addAnimation()
  • .removeAnimation()
  • .render()
  • .dispose()
  • .destroy()

new SkyContext(mizarConfiguration, options)

Param	Type	Description
mizarConfiguration	configuration	mizar configuration
options	skyContext	skyContext configuration

skyContext._fillDataProvider(layer, mizarDescription)

Fill data-provider-type layer by features coming from data object

Kind: instance method of SkyContext
Access: protected

Param	Type	Description
layer	Layer	layer in which data should be added.
mizarDescription	Object	See the base properties configuration and a specific layer for specific properties

skyContext.getTileManager()

Kind: instance method of SkyContext
Implements: getTileManager

skyContext.registerNoStandardDataProvider(type, loadFunc)

Registers no standard data provider and call them in the addLayer method.

Kind: instance method of SkyContext

Param	Type	Description
type	string	data provider key
loadFunc	function	Function

Example (Registers planets on the sky)

  var planetProvider = ProviderFactory.create(Constants.PROVIDER.Planet);
  this.registerNoStandardDataProvider("planets", planetProvider.loadFiles);

skyContext.getContextConfiguration()

Kind: instance method of SkyContext
Implements: getContextConfiguration

skyContext.getMizarConfiguration()

Kind: instance method of SkyContext
Implements: getMizarConfiguration

skyContext.getLonLatFromPixel()

Kind: instance method of SkyContext
Implements: getLonLatFromPixel

skyContext.getPixelFromLonLat()

Kind: instance method of SkyContext
Implements: getPixelFromLonLat

skyContext.getElevation()

Kind: instance method of SkyContext
Implements: getElevation

skyContext.getPositionTracker()

Kind: instance method of SkyContext
Implements: getPositionTracker

skyContext.getElevationTracker()

Kind: instance method of SkyContext
Implements: getElevationTracker

skyContext.getLayers()

Kind: instance method of SkyContext
Implements: getLayers

skyContext.getLayerByID()

Kind: instance method of SkyContext
Implements: getLayerByID

skyContext.getLayerByName()

Kind: instance method of SkyContext
Implements: getLayerByName

skyContext.addLayer()

Kind: instance method of SkyContext
Implements: addLayer

skyContext.removeLayer()

Kind: instance method of SkyContext
Implements: removeLayer

skyContext.removeAllLayers()

Kind: instance method of SkyContext
Implements: removeAllLayers

skyContext.addDraw()

Kind: instance method of SkyContext
Implements: addDraw

skyContext.removeDraw()

Kind: instance method of SkyContext
Implements: removeDraw

skyContext.initTouchNavigation(options)

Initializes the touch navigation handler.

Kind: instance method of SkyContext

Param	Type	Description
options	Object	to add touch navigation
options.navigation	Navigation	Navigation object

skyContext.refresh()

Kind: instance method of SkyContext
Implements: refresh

skyContext.initCanvas(canvas)

Initialization of the canvas element. When no canvas element is provided, sets to full screen.

Kind: instance method of SkyContext

Param	Type	Description
canvas	Object	Canvas object
canvas.parentElement	Object	HTML object

skyContext.iniGlobeEvents(globe)

Initializes the planet or sky events.

Kind: instance method of SkyContext

Param	Type	Description
globe	AbstractGlobe	Planet or Sky object

skyContext.show()

Kind: instance method of SkyContext
Implements: show

skyContext.showComponents()

Kind: instance method of SkyContext
Implements: showComponents

skyContext.hideComponents()

Kind: instance method of SkyContext
Implements: hideComponents

skyContext.hide()

Kind: instance method of SkyContext
Implements: hide

skyContext.setComponentVisibility()

Kind: instance method of SkyContext
Implements: setComponentVisibility

skyContext.showAdditionalLayers()

Kind: instance method of SkyContext
Implements: showAdditionalLayers

skyContext.hideAdditionalLayers()

Kind: instance method of SkyContext
Implements: hideAdditionalLayers

skyContext.setBackgroundLayer()

Kind: instance method of SkyContext
Implements: setBackgroundLayer

skyContext.setBackgroundLayerByID()

Kind: instance method of SkyContext
Implements: setBackgroundLayerByID

skyContext.getAdditionalLayers()

Kind: instance method of SkyContext
Implements: getAdditionalLayers

skyContext.getRenderContext()

Kind: instance method of SkyContext
Implements: getRenderContext

skyContext.disbable()

Kind: instance abstract method of SkyContext

skyContext.enable()

Kind: instance abstract method of SkyContext
Implements: enable

skyContext.setCompassVisible()

Kind: instance abstract method of SkyContext
Implements: setCompassVisible

skyContext.getMode()

Kind: instance method of SkyContext
Implements: getMode

skyContext.setCoordinateSystem()

Kind: instance abstract method of SkyContext
Implements: setCoordinateSystem

skyContext.getNavigation()

Kind: instance method of SkyContext
Implements: getNavigation

skyContext.getCoordinateSystem()

Kind: instance method of SkyContext
Implements: getCoordinateSystem

skyContext.addAnimation()

Kind: instance method of SkyContext
Implements: addAnimation

skyContext.removeAnimation()

Kind: instance method of SkyContext
Implements: removeAnimation

skyContext.render()

Kind: instance method of SkyContext
Implements: Context#render

skyContext.dispose()

Kind: instance method of SkyContext
Implements: dispose

skyContext.destroy()

Kind: instance abstract method of SkyContext
Implements: destroy

Crs

A coordinate reference system is a coordinate system that is related to an object by a geodetic datum. Mizar currently supports the following coordinates reference systems :

	[EquatorialCrs](#module_Crs.EquatorialCrs)	Provides an equatorial coordinate reference system
	[GalacticCrs](#module_Crs.GalacticCrs)	Provides a galactic coordinate reference system
	[Mars2000Crs](#module_Crs.Mars2000Crs)	Provides a coordinate reference system base on the Mars geoide
	[WGS84Crs](#module_Crs.WGS84Crs)	Provides a coordinate reference system base on the Earth geoide
	[ProjectedCrs](#module_Crs.ProjectedCrs)	Provides a projected coordinate reference system on a map

In addition to the classes, a [factory](#module_Crs.CoordinateSystemFactory) is available to help for creating coordinate reference system. Once the coordinate reference system is created, the client can handle it by the use of its [interface](#Crs).

Implements: Crs

• Crs
  • .CoordinateSystemFactory
    • .create(options) ⇒ Crs
  • .EquatorialCrs ⇐ AbstractCrs
    • new EquatorialCrs(options)
    • .isFlat()
    • .getVerticalAt3D()
    • .fromGeoTo3D()
    • .from3DToGeo()
    • .getLocalTransform()
    • .getLHVTransform()
    • .getSideVector()
    • .getFrontVector()
    • .getUpVector()
    • .formatCoordinates()
    • .getGeoide()
    • .getGeoideName()
    • .getType()
    • .getElevation()
    • .getWorldFrom3D()
    • .get3DFromWorld()
    • .get3DFromWorldInCrs()
    • .getSexagesimalFromDeg()
    • .getDecimalDegFromSexagesimal()
    • .convert()
    • .fromDegreesToHMS()
    • .fromDegreesToDMS()
    • ._setupPosBeforeTrans()
    • ._setupPosAfterTrans()
    • .getGeoBound()
  • .GalacticCrs ⇐ AbstractCrs
    • new GalacticCrs(options)
    • .isFlat()
    • .getVerticalAt3D()
    • .fromGeoTo3D()
    • .from3DToGeo()
    • .getLocalTransform()
    • .getLHVTransform()
    • .getSideVector()
    • .getFrontVector()
    • .getUpVector()
    • .formatCoordinates()
    • .getGeoide()
    • .getGeoideName()
    • .getType()
    • .getElevation()
    • .getWorldFrom3D()
    • .get3DFromWorld()
    • .get3DFromWorldInCrs()
    • .getSexagesimalFromDeg()
    • .getDecimalDegFromSexagesimal()
    • .convert()
    • .fromDegreesToHMS()
    • .fromDegreesToDMS()
    • ._setupPosBeforeTrans()
    • ._setupPosAfterTrans()
    • .getGeoBound()
  • .Geoide
    • new Geoide(options)
  • .Mars2000Crs ⇐ AbstractCrs
    • new Mars2000Crs(options)
    • .isFlat()
    • .getVerticalAt3D()
    • .fromGeoTo3D()
    • .from3DToGeo()
    • .getLocalTransform()
    • .getLHVTransform()
    • .getSideVector()
    • .getFrontVector()
    • .getUpVector()
    • .formatCoordinates()
    • .getGeoide()
    • .getGeoideName()
    • .getType()
    • .getElevation()
    • .getWorldFrom3D()
    • .get3DFromWorld()
    • .get3DFromWorldInCrs()
    • .getSexagesimalFromDeg()
    • .getDecimalDegFromSexagesimal()
    • .convert()
    • .fromDegreesToHMS()
    • .fromDegreesToDMS()
    • ._setupPosBeforeTrans()
    • ._setupPosAfterTrans()
    • .getGeoBound()
  • .ProjectedCrs ⇐ AbstractCrs
    • new ProjectedCrs(cs, options)
    • .isFlat()
    • .getVerticalAt3D()
    • .fromGeoTo3D()
    • .from3DToGeo()
    • .getLocalTransform()
    • .getLHVTransform()
    • .getSideVector()
    • .getFrontVector()
    • .getUpVector()
    • .formatCoordinates()
    • .getGeoide()
    • .getGeoideName()
    • .getType()
    • .getElevation()
    • .getWorldFrom3D()
    • .get3DFromWorld()
    • .get3DFromWorldInCrs()
    • .getSexagesimalFromDeg()
    • .getDecimalDegFromSexagesimal()
    • .convert()
    • .fromDegreesToHMS()
    • .fromDegreesToDMS()
    • ._setupPosBeforeTrans()
    • ._setupPosAfterTrans()
    • .getGeoBound()
  • .WGS84Crs ⇐ AbstractCrs
    • new WGS84Crs(options)
    • .isFlat()
    • .getVerticalAt3D()
    • .fromGeoTo3D()
    • .from3DToGeo()
    • .getLocalTransform()
    • .getLHVTransform()
    • .getSideVector()
    • .getFrontVector()
    • .getUpVector()
    • .formatCoordinates()
    • .getGeoide()
    • .getGeoideName()
    • .getType()
    • .getElevation()
    • .getWorldFrom3D()
    • .get3DFromWorld()
    • .get3DFromWorldInCrs()
    • .getSexagesimalFromDeg()
    • .getDecimalDegFromSexagesimal()
    • .convert()
    • .fromDegreesToHMS()
    • .fromDegreesToDMS()
    • ._setupPosBeforeTrans()
    • ._setupPosAfterTrans()
    • .getGeoBound()

Crs.CoordinateSystemFactory

Factory to create a coordinate reference system

Kind: static class of Crs

CoordinateSystemFactory.create(options) ⇒ Crs

Factory for CRS.

Kind: static method of CoordinateSystemFactory
Returns: Crs - Object to handle CRS
Throws:

• ReferenceError Will throw an error when options.geoideName is not defined
• RangeError Will throw an error when options.geoideName is not part of CRS
• RangeError Will throw an error when options.projectionName is not part of PROJECTION

Param	Type	Description
options	crsFactory	Options to create a coordinate reference system

Crs.EquatorialCrs ⇐ AbstractCrs

A system is a system in which a celestial object's position on the celestial sphere is described in terms of its declination and right ascension, measured with respect to the celestial equator. Declination and right ascension correspond directly to geographic latitude and longitude as projected outward onto the celestial sphere. Declination is measured in degrees north or south of the celestial equator but right ascension is measured in hours, minutes, and seconds eastward along the celestial equator from the point of the vernal equinox. Because the celestial equator moves among the fixed stars with the precession of the Earth's poles, an object's declination and right ascension change gradually over time, and coordinates in the equatorial system must be specified for particular years.
source : equatorial coordinate system. Dictionary.com. The American Heritage® Science Dictionary. Houghton Mifflin Company. http://www.dictionary.com/browse/equatorial-coordinate-system (accessed: March 5, 2017).

EquatorialCrs is initialized with the following parameters :

• geoideName = Equatorial
• radius = 10.0
• realPlanetRadius = 1.0
• type = Sky
• geoBound = new GeoBound(0, -90, 360, 90)

Kind: static class of Crs
Extends: AbstractCrs
See: Wikipedia

• .EquatorialCrs ⇐ AbstractCrs
  • new EquatorialCrs(options)
  • .isFlat()
  • .getVerticalAt3D()
  • .fromGeoTo3D()
  • .from3DToGeo()
  • .getLocalTransform()
  • .getLHVTransform()
  • .getSideVector()
  • .getFrontVector()
  • .getUpVector()
  • .formatCoordinates()
  • .getGeoide()
  • .getGeoideName()
  • .getType()
  • .getElevation()
  • .getWorldFrom3D()
  • .get3DFromWorld()
  • .get3DFromWorldInCrs()
  • .getSexagesimalFromDeg()
  • .getDecimalDegFromSexagesimal()
  • .convert()
  • .fromDegreesToHMS()
  • .fromDegreesToDMS()
  • ._setupPosBeforeTrans()
  • ._setupPosAfterTrans()
  • .getGeoBound()

new EquatorialCrs(options)

Param	Type	Description
options	Object	No option to give

equatorialCrs.isFlat()

Kind: instance method of EquatorialCrs
Implements: isFlat

equatorialCrs.getVerticalAt3D()

Kind: instance method of EquatorialCrs
Implements: getVerticalAt3D

equatorialCrs.fromGeoTo3D()

Kind: instance method of EquatorialCrs
Implements: fromGeoTo3D

equatorialCrs.from3DToGeo()

Kind: instance method of EquatorialCrs
Implements: from3DToGeo

equatorialCrs.getLocalTransform()

Kind: instance method of EquatorialCrs
Implements: getLocalTransform

equatorialCrs.getLHVTransform()

Kind: instance method of EquatorialCrs
Implements: getLHVTransform

equatorialCrs.getSideVector()

Kind: instance method of EquatorialCrs
Implements: getSideVector

equatorialCrs.getFrontVector()

Kind: instance method of EquatorialCrs
Implements: getFrontVector

equatorialCrs.getUpVector()

Kind: instance method of EquatorialCrs
Implements: getUpVector

equatorialCrs.formatCoordinates()

Kind: instance abstract method of EquatorialCrs
Implements: formatCoordinates

equatorialCrs.getGeoide()

Kind: instance method of EquatorialCrs
Implements: getGeoide

equatorialCrs.getGeoideName()

Kind: instance method of EquatorialCrs
Implements: getGeoideName

equatorialCrs.getType()

Kind: instance method of EquatorialCrs
Implements: getType

equatorialCrs.getElevation()

Kind: instance method of EquatorialCrs
Implements: getElevation

equatorialCrs.getWorldFrom3D()

Kind: instance method of EquatorialCrs
Implements: getWorldFrom3D

equatorialCrs.get3DFromWorld()

Kind: instance method of EquatorialCrs
Implements: get3DFromWorld

equatorialCrs.get3DFromWorldInCrs()

Kind: instance method of EquatorialCrs
Implements: get3DFromWorldInCrs

equatorialCrs.getSexagesimalFromDeg()

Kind: instance method of EquatorialCrs
Implements: getSexagesimalFromDeg

equatorialCrs.getDecimalDegFromSexagesimal()

Kind: instance method of EquatorialCrs
Implements: getDecimalDegFromSexagesimal

equatorialCrs.convert()

Kind: instance method of EquatorialCrs
Implements: convert

equatorialCrs.fromDegreesToHMS()

Kind: instance method of EquatorialCrs
Implements: fromDegreesToHMS

equatorialCrs.fromDegreesToDMS()

Kind: instance method of EquatorialCrs
Implements: fromDegreesToDMS

equatorialCrs._setupPosBeforeTrans()

Kind: instance method of EquatorialCrs
Implements: _setupPosBeforeTrans
Bastract:

equatorialCrs._setupPosAfterTrans()

Kind: instance method of EquatorialCrs
Implements: _setupPosAfterTrans
Bastract:

equatorialCrs.getGeoBound()

Kind: instance method of EquatorialCrs
Implements: getGeoBound

Crs.GalacticCrs ⇐ AbstractCrs

A system in which a celestial object's position on the celestial sphere is described in relation to the structure of the Milky Way galaxy. An object's galactic longitude is measured along the galactic equator, a great circle on the celestial sphere that follows the band of the Milky Way. The galactic equator, also called the galactic circle, is inclined at an angle of approximately 62° to the celestial equator; distances are measured along it beginning at a point in the constellation Sagittarius lying in the direction of the Milky Way's nucleus. The galactic poles are the two points where a perpendicular line through the middle of the plane of the galactic equator intersect the celestial sphere. An object's galactic latitude is measured in degrees north or south of the galactic equator toward the galactic poles.
source : galactic coordinate system. Dictionary.com. The American Heritage® Science Dictionary. Houghton Mifflin Company. http://www.dictionary.com/browse/galactic-coordinate-system (accessed: March 5, 2017).

GalacticCrs is initialized with the following parameters :

• geoideName = Galactic
• radius = 10.0
• realPlanetRadius = 1.0
• type = Sky
• geoBound = new GeoBound(0, -90, 360, 90)

Kind: static class of Crs
Extends: AbstractCrs
See: Wikipedia

• .GalacticCrs ⇐ AbstractCrs
  • new GalacticCrs(options)
  • .isFlat()
  • .getVerticalAt3D()
  • .fromGeoTo3D()
  • .from3DToGeo()
  • .getLocalTransform()
  • .getLHVTransform()
  • .getSideVector()
  • .getFrontVector()
  • .getUpVector()
  • .formatCoordinates()
  • .getGeoide()
  • .getGeoideName()
  • .getType()
  • .getElevation()
  • .getWorldFrom3D()
  • .get3DFromWorld()
  • .get3DFromWorldInCrs()
  • .getSexagesimalFromDeg()
  • .getDecimalDegFromSexagesimal()
  • .convert()
  • .fromDegreesToHMS()
  • .fromDegreesToDMS()
  • ._setupPosBeforeTrans()
  • ._setupPosAfterTrans()
  • .getGeoBound()

new GalacticCrs(options)

Param	Description
options	no option to give.

galacticCrs.isFlat()

Kind: instance method of GalacticCrs
Implements: isFlat

galacticCrs.getVerticalAt3D()

Kind: instance method of GalacticCrs
Implements: getVerticalAt3D

galacticCrs.fromGeoTo3D()

Kind: instance method of GalacticCrs
Implements: fromGeoTo3D

galacticCrs.from3DToGeo()

Kind: instance method of GalacticCrs
Implements: from3DToGeo

galacticCrs.getLocalTransform()

Kind: instance method of GalacticCrs
Implements: getLocalTransform

galacticCrs.getLHVTransform()

Kind: instance method of GalacticCrs
Implements: getLHVTransform

galacticCrs.getSideVector()

Kind: instance method of GalacticCrs
Implements: getSideVector

galacticCrs.getFrontVector()

Kind: instance method of GalacticCrs
Implements: getFrontVector

galacticCrs.getUpVector()

Kind: instance method of GalacticCrs
Implements: getUpVector

galacticCrs.formatCoordinates()

Kind: instance abstract method of GalacticCrs
Implements: formatCoordinates

galacticCrs.getGeoide()

Kind: instance method of GalacticCrs
Implements: getGeoide

galacticCrs.getGeoideName()

Kind: instance method of GalacticCrs
Implements: getGeoideName

galacticCrs.getType()

Kind: instance method of GalacticCrs
Implements: getType

galacticCrs.getElevation()

Kind: instance method of GalacticCrs
Implements: getElevation

galacticCrs.getWorldFrom3D()

Kind: instance method of GalacticCrs
Implements: getWorldFrom3D

galacticCrs.get3DFromWorld()

Kind: instance method of GalacticCrs
Implements: get3DFromWorld

galacticCrs.get3DFromWorldInCrs()

Kind: instance method of GalacticCrs
Implements: get3DFromWorldInCrs

galacticCrs.getSexagesimalFromDeg()

Kind: instance method of GalacticCrs
Implements: getSexagesimalFromDeg

galacticCrs.getDecimalDegFromSexagesimal()

Kind: instance method of GalacticCrs
Implements: getDecimalDegFromSexagesimal

galacticCrs.convert()

Kind: instance method of GalacticCrs
Implements: convert

galacticCrs.fromDegreesToHMS()

Kind: instance method of GalacticCrs
Implements: fromDegreesToHMS

galacticCrs.fromDegreesToDMS()

Kind: instance method of GalacticCrs
Implements: fromDegreesToDMS

galacticCrs._setupPosBeforeTrans()

Kind: instance method of GalacticCrs
Implements: _setupPosBeforeTrans
Bastract:

galacticCrs._setupPosAfterTrans()

Kind: instance method of GalacticCrs
Implements: _setupPosAfterTrans
Bastract:

galacticCrs.getGeoBound()

Kind: instance method of GalacticCrs
Implements: getGeoBound

Crs.Geoide

Geodetic datum is a set of parameters that define the position of the origin, the scale, and the orientation of a coordinate system in relationship with the planet.

Kind: static class of Crs
Todo

• add flattening parameter

new Geoide(options)

Throws:

• ReferenceError Will throw an error when options.realPlanetRadius or options.radius are not defined

Param	Type	Description
options	geoide_configuration	Options for Geoide

Crs.Mars2000Crs ⇐ AbstractCrs

Mars 2000 coordinate Reference System is a coordinate system using the Mars geoide and in which the planetographic longitude increases to the east. The planetographic latitude is measured in degrees north or south of the Mars equator.
Mars2000Crs is initialized with the following parameters :

• geoideName = IAU2000:49901
• radius = 10.0
• realPlanetRadius = 1
• type = Planet
• geoBound = new GeoBound(-180, -90, 180, 90)

Kind: static class of Crs
Extends: AbstractCrs

• .Mars2000Crs ⇐ AbstractCrs
  • new Mars2000Crs(options)
  • .isFlat()
  • .getVerticalAt3D()
  • .fromGeoTo3D()
  • .from3DToGeo()
  • .getLocalTransform()
  • .getLHVTransform()
  • .getSideVector()
  • .getFrontVector()
  • .getUpVector()
  • .formatCoordinates()
  • .getGeoide()
  • .getGeoideName()
  • .getType()
  • .getElevation()
  • .getWorldFrom3D()
  • .get3DFromWorld()
  • .get3DFromWorldInCrs()
  • .getSexagesimalFromDeg()
  • .getDecimalDegFromSexagesimal()
  • .convert()
  • .fromDegreesToHMS()
  • .fromDegreesToDMS()
  • ._setupPosBeforeTrans()
  • ._setupPosAfterTrans()
  • .getGeoBound()

new Mars2000Crs(options)

Param	Description
options	No option to give.

mars2000Crs.isFlat()

Kind: instance method of Mars2000Crs
Implements: isFlat

mars2000Crs.getVerticalAt3D()

Kind: instance method of Mars2000Crs
Implements: getVerticalAt3D

mars2000Crs.fromGeoTo3D()

Kind: instance method of Mars2000Crs
Implements: fromGeoTo3D

mars2000Crs.from3DToGeo()

Kind: instance method of Mars2000Crs
Implements: from3DToGeo

mars2000Crs.getLocalTransform()

Kind: instance method of Mars2000Crs
Implements: getLocalTransform

mars2000Crs.getLHVTransform()

Kind: instance method of Mars2000Crs
Implements: getLHVTransform

mars2000Crs.getSideVector()

Kind: instance method of Mars2000Crs
Implements: getSideVector

mars2000Crs.getFrontVector()

Kind: instance method of Mars2000Crs
Implements: getFrontVector

mars2000Crs.getUpVector()

Kind: instance method of Mars2000Crs
Implements: getUpVector

mars2000Crs.formatCoordinates()

Kind: instance abstract method of Mars2000Crs
Implements: formatCoordinates

mars2000Crs.getGeoide()

Kind: instance method of Mars2000Crs
Implements: getGeoide

mars2000Crs.getGeoideName()

Kind: instance method of Mars2000Crs
Implements: getGeoideName

mars2000Crs.getType()

Kind: instance method of Mars2000Crs
Implements: getType

mars2000Crs.getElevation()

Kind: instance method of Mars2000Crs
Implements: getElevation

mars2000Crs.getWorldFrom3D()

Kind: instance method of Mars2000Crs
Implements: getWorldFrom3D

mars2000Crs.get3DFromWorld()

Kind: instance method of Mars2000Crs
Implements: get3DFromWorld

mars2000Crs.get3DFromWorldInCrs()

Kind: instance method of Mars2000Crs
Implements: get3DFromWorldInCrs

mars2000Crs.getSexagesimalFromDeg()

Kind: instance method of Mars2000Crs
Implements: getSexagesimalFromDeg

mars2000Crs.getDecimalDegFromSexagesimal()

Kind: instance method of Mars2000Crs
Implements: getDecimalDegFromSexagesimal

mars2000Crs.convert()

Kind: instance method of Mars2000Crs
Implements: convert

mars2000Crs.fromDegreesToHMS()

Kind: instance method of Mars2000Crs
Implements: fromDegreesToHMS

mars2000Crs.fromDegreesToDMS()

Kind: instance method of Mars2000Crs
Implements: fromDegreesToDMS

mars2000Crs._setupPosBeforeTrans()

Kind: instance method of Mars2000Crs
Implements: _setupPosBeforeTrans
Bastract:

mars2000Crs._setupPosAfterTrans()

Kind: instance method of Mars2000Crs
Implements: _setupPosAfterTrans
Bastract:

mars2000Crs.getGeoBound()

Kind: instance method of Mars2000Crs
Implements: getGeoBound

Crs.ProjectedCrs ⇐ AbstractCrs

A coordinate reference system projected on a 2D map.

Kind: static class of Crs
Extends: AbstractCrs

• .ProjectedCrs ⇐ AbstractCrs
  • new ProjectedCrs(cs, options)
  • .isFlat()
  • .getVerticalAt3D()
  • .fromGeoTo3D()
  • .from3DToGeo()
  • .getLocalTransform()
  • .getLHVTransform()
  • .getSideVector()
  • .getFrontVector()
  • .getUpVector()
  • .formatCoordinates()
  • .getGeoide()
  • .getGeoideName()
  • .getType()
  • .getElevation()
  • .getWorldFrom3D()
  • .get3DFromWorld()
  • .get3DFromWorldInCrs()
  • .getSexagesimalFromDeg()
  • .getDecimalDegFromSexagesimal()
  • .convert()
  • .fromDegreesToHMS()
  • .fromDegreesToDMS()
  • ._setupPosBeforeTrans()
  • ._setupPosAfterTrans()
  • .getGeoBound()

new ProjectedCrs(cs, options)

Throws:

• ReferenceError Will throw when options.projectionName is not defined
• RangeError Will throw when options.projectionName is not part of PROJECTION

Param	Type	Description
cs	Crs	coordinate reference system
options	configuration | azimuth_configuration | mercator_configuration	projection configuration

projectedCrs.isFlat()

Kind: instance method of ProjectedCrs
Implements: isFlat

projectedCrs.getVerticalAt3D()

Kind: instance method of ProjectedCrs
Implements: getVerticalAt3D

projectedCrs.fromGeoTo3D()

Kind: instance method of ProjectedCrs
Implements: fromGeoTo3D

projectedCrs.from3DToGeo()

Kind: instance method of ProjectedCrs
Implements: from3DToGeo

projectedCrs.getLocalTransform()

Kind: instance method of ProjectedCrs
Implements: getLocalTransform

projectedCrs.getLHVTransform()

Kind: instance method of ProjectedCrs
Implements: getLHVTransform

projectedCrs.getSideVector()

Kind: instance method of ProjectedCrs
Implements: getSideVector

projectedCrs.getFrontVector()

Kind: instance method of ProjectedCrs
Implements: getFrontVector

projectedCrs.getUpVector()

Kind: instance method of ProjectedCrs
Implements: getUpVector

projectedCrs.formatCoordinates()

Kind: instance abstract method of ProjectedCrs
Implements: formatCoordinates

projectedCrs.getGeoide()

Kind: instance method of ProjectedCrs
Implements: getGeoide

projectedCrs.getGeoideName()

Kind: instance method of ProjectedCrs
Implements: getGeoideName

projectedCrs.getType()

Kind: instance method of ProjectedCrs
Implements: getType

projectedCrs.getElevation()

Kind: instance method of ProjectedCrs
Implements: getElevation

projectedCrs.getWorldFrom3D()

Kind: instance method of ProjectedCrs
Implements: getWorldFrom3D

projectedCrs.get3DFromWorld()

Kind: instance method of ProjectedCrs
Implements: get3DFromWorld

projectedCrs.get3DFromWorldInCrs()

Kind: instance method of ProjectedCrs
Implements: get3DFromWorldInCrs

projectedCrs.getSexagesimalFromDeg()

Kind: instance method of ProjectedCrs
Implements: getSexagesimalFromDeg

projectedCrs.getDecimalDegFromSexagesimal()

Kind: instance method of ProjectedCrs
Implements: getDecimalDegFromSexagesimal

projectedCrs.convert()

Kind: instance method of ProjectedCrs
Implements: convert

projectedCrs.fromDegreesToHMS()

Kind: instance method of ProjectedCrs
Implements: fromDegreesToHMS

projectedCrs.fromDegreesToDMS()

Kind: instance method of ProjectedCrs
Implements: fromDegreesToDMS

projectedCrs._setupPosBeforeTrans()

Kind: instance method of ProjectedCrs
Implements: _setupPosBeforeTrans
Bastract:

projectedCrs._setupPosAfterTrans()

Kind: instance method of ProjectedCrs
Implements: _setupPosAfterTrans
Bastract:

projectedCrs.getGeoBound()

Kind: instance method of ProjectedCrs
Implements: getGeoBound

Crs.WGS84Crs ⇐ AbstractCrs

WGS84 coordinate Reference System is a coordinate system using the Earth geoide and in which the geographic longitude increases to the east. The geographic latitude is measured in degrees north or south of the Earth equator.

WGS84Crs is initialized with the following parameters :

• geoideName = EPSG:4326
• radius = 1
• realPlanetRadius = 6378137 meters
• type = Planet
• geoBound = new GeoBound(-180, -90, 180, 90)

Kind: static class of Crs
Extends: AbstractCrs

• .WGS84Crs ⇐ AbstractCrs
  • new WGS84Crs(options)
  • .isFlat()
  • .getVerticalAt3D()
  • .fromGeoTo3D()
  • .from3DToGeo()
  • .getLocalTransform()
  • .getLHVTransform()
  • .getSideVector()
  • .getFrontVector()
  • .getUpVector()
  • .formatCoordinates()
  • .getGeoide()
  • .getGeoideName()
  • .getType()
  • .getElevation()
  • .getWorldFrom3D()
  • .get3DFromWorld()
  • .get3DFromWorldInCrs()
  • .getSexagesimalFromDeg()
  • .getDecimalDegFromSexagesimal()
  • .convert()
  • .fromDegreesToHMS()
  • .fromDegreesToDMS()
  • ._setupPosBeforeTrans()
  • ._setupPosAfterTrans()
  • .getGeoBound()

new WGS84Crs(options)

Param	Description
options	No option to give.

wgS84Crs.isFlat()

Kind: instance method of WGS84Crs
Implements: isFlat

wgS84Crs.getVerticalAt3D()

Kind: instance method of WGS84Crs
Implements: getVerticalAt3D

wgS84Crs.fromGeoTo3D()

Kind: instance method of WGS84Crs
Implements: fromGeoTo3D

wgS84Crs.from3DToGeo()

Kind: instance method of WGS84Crs
Implements: from3DToGeo

wgS84Crs.getLocalTransform()

Kind: instance method of WGS84Crs
Implements: getLocalTransform

wgS84Crs.getLHVTransform()

Kind: instance method of WGS84Crs
Implements: getLHVTransform

wgS84Crs.getSideVector()

Kind: instance method of WGS84Crs
Implements: getSideVector

wgS84Crs.getFrontVector()

Kind: instance method of WGS84Crs
Implements: getFrontVector

wgS84Crs.getUpVector()

Kind: instance method of WGS84Crs
Implements: getUpVector

wgS84Crs.formatCoordinates()

Kind: instance abstract method of WGS84Crs
Implements: formatCoordinates

wgS84Crs.getGeoide()

Kind: instance method of WGS84Crs
Implements: getGeoide

wgS84Crs.getGeoideName()

Kind: instance method of WGS84Crs
Implements: getGeoideName

wgS84Crs.getType()

Kind: instance method of WGS84Crs
Implements: getType

wgS84Crs.getElevation()

Kind: instance method of WGS84Crs
Implements: getElevation

wgS84Crs.getWorldFrom3D()

Kind: instance method of WGS84Crs
Implements: getWorldFrom3D

wgS84Crs.get3DFromWorld()

Kind: instance method of WGS84Crs
Implements: get3DFromWorld

wgS84Crs.get3DFromWorldInCrs()

Kind: instance method of WGS84Crs
Implements: get3DFromWorldInCrs

wgS84Crs.getSexagesimalFromDeg()

Kind: instance method of WGS84Crs
Implements: getSexagesimalFromDeg

wgS84Crs.getDecimalDegFromSexagesimal()

Kind: instance method of WGS84Crs
Implements: getDecimalDegFromSexagesimal

wgS84Crs.convert()

Kind: instance method of WGS84Crs
Implements: convert

wgS84Crs.fromDegreesToHMS()

Kind: instance method of WGS84Crs
Implements: fromDegreesToHMS

wgS84Crs.fromDegreesToDMS()

Kind: instance method of WGS84Crs
Implements: fromDegreesToDMS

wgS84Crs._setupPosBeforeTrans()

Kind: instance method of WGS84Crs
Implements: _setupPosBeforeTrans
Bastract:

wgS84Crs._setupPosAfterTrans()

Kind: instance method of WGS84Crs
Implements: _setupPosAfterTrans
Bastract:

wgS84Crs.getGeoBound()

Kind: instance method of WGS84Crs
Implements: getGeoBound

Globe

Provides classes for handling a globe.

The different possible globes in MIZAR are :

• a sky
• a planet

A sky is a globe where the camera is located in it whereas the planet is a globe where the camera is located outside.
In addition to the classes, a [factory](#module_Globe.GlobeFactory) is available to help for creating globe. Once the globe is created, the client can handle it by the use of its [interface](#Globe).

Implements: Globe

• Globe
  • .GlobeFactory
    • .create(type, options) ⇒ Globe
  • .Planet ⇐ AbstractGlobe
    • new Planet(options)
    • .getType()
    • .isSky()
    • .dispose()
    • .destroy()
    • .refresh()
    • .setBaseImagery()
    • .getBaseElevation()
    • .addLayer()
    • .removeLayer()
    • .addAnimation()
    • .removeAnimation()
    • .getElevation()
    • .getViewportGeoBound()
    • .getLonLatFromPixel()
    • .getPixelFromLonLat()
    • .render()
    • .setCoordinateSystem()
    • .getCoordinateSystem()
    • .getRenderStats()
    • .getRenderContext()
    • .setRenderContext()
    • .getTileManager()
    • .isEnabled()
  • .Sky ⇐ AbstractGlobe
    • new Sky(options)
    • .getType()
    • .isSky()
    • .dispose()
    • .destroy()
    • .refresh()
    • .setBaseImagery()
    • .getBaseElevation()
    • .addLayer()
    • .removeLayer()
    • .addAnimation()
    • .removeAnimation()
    • .getElevation()
    • .getViewportGeoBound()
    • .getLonLatFromPixel()
    • .getPixelFromLonLat()
    • .render()
    • .setCoordinateSystem()
    • .getCoordinateSystem()
    • .getRenderStats()
    • .getRenderContext()
    • .setRenderContext()
    • .getTileManager()
    • .isEnabled()

Globe.GlobeFactory

Factory to create a globe.

Kind: static class of Globe

GlobeFactory.create(type, options) ⇒ Globe

Creates a specific globe based on its type (e.g sky, planet).

Kind: static method of GlobeFactory
Returns: Globe - a globe
Throws:

• RangeError Will throw an error when the type is not part of GLOBE

See

• Planet
• Sky

Param	Type	Description
type	GLOBE	the type of globe
options	configuration	options to configure a globe

Globe.Planet ⇐ AbstractGlobe

Create a virtual planet in a HTML canvas element with its own coordinate reference system.

Kind: static class of Globe
Extends: AbstractGlobe

• .Planet ⇐ AbstractGlobe
  • new Planet(options)
  • .getType()
  • .isSky()
  • .dispose()
  • .destroy()
  • .refresh()
  • .setBaseImagery()
  • .getBaseElevation()
  • .addLayer()
  • .removeLayer()
  • .addAnimation()
  • .removeAnimation()
  • .getElevation()
  • .getViewportGeoBound()
  • .getLonLatFromPixel()
  • .getPixelFromLonLat()
  • .render()
  • .setCoordinateSystem()
  • .getCoordinateSystem()
  • .getRenderStats()
  • .getRenderContext()
  • .setRenderContext()
  • .getTileManager()
  • .isEnabled()

new Planet(options)

Param	Type	Description
options	configuration	Planet configuration

planet.getType()

Kind: instance method of Planet
Implements: getType

planet.isSky()

Kind: instance method of Planet
Implements: isSky

planet.dispose()

Kind: instance method of Planet
Implements: dispose

planet.destroy()

Kind: instance method of Planet
Implements: destroy

planet.refresh()

Kind: instance method of Planet
Implements: refresh

planet.setBaseImagery()

Kind: instance abstract method of Planet
Implements: setBaseImagery

planet.getBaseElevation()

Kind: instance abstract method of Planet
Implements: getBaseElevation

planet.addLayer()

Kind: instance method of Planet
Implements: addLayer

planet.removeLayer()

Kind: instance method of Planet
Implements: removeLayer

planet.addAnimation()

Kind: instance method of Planet
Implements: addAnimation

planet.removeAnimation()

Kind: instance method of Planet
Implements: removeAnimation

planet.getElevation()

Kind: instance abstract method of Planet
Implements: getElevation

planet.getViewportGeoBound()

Kind: instance method of Planet
Implements: getViewportGeoBound

planet.getLonLatFromPixel()

Kind: instance method of Planet
Implements: getLonLatFromPixel

planet.getPixelFromLonLat()

Kind: instance method of Planet
Implements: getPixelFromLonLat

planet.render()

Kind: instance abstract method of Planet
Implements: Globe#render
Overrides: render
Access: protected

planet.setCoordinateSystem()

Kind: instance method of Planet
Implements: setCoordinateSystem

planet.getCoordinateSystem()

Kind: instance method of Planet
Implements: getCoordinateSystem

planet.getRenderStats()

Kind: instance method of Planet
Implements: getRenderStats

planet.getRenderContext()

Kind: instance method of Planet
Implements: getRenderContext

planet.setRenderContext()

Kind: instance method of Planet
Implements: setRenderContext

planet.getTileManager()

Kind: instance method of Planet
Implements: getTileManager

planet.isEnabled()

Kind: instance method of Planet
Implements: isEnabled

Globe.Sky ⇐ AbstractGlobe

Create a virtual sky in a HTML canvas element with its own coordinate reference system.

The sky handles two different grids in the same time in order to display both the galactic and equatorial rasters.

Kind: static class of Globe
Extends: AbstractGlobe

• .Sky ⇐ AbstractGlobe
  • new Sky(options)
  • .getType()
  • .isSky()
  • .dispose()
  • .destroy()
  • .refresh()
  • .setBaseImagery()
  • .getBaseElevation()
  • .addLayer()
  • .removeLayer()
  • .addAnimation()
  • .removeAnimation()
  • .getElevation()
  • .getViewportGeoBound()
  • .getLonLatFromPixel()
  • .getPixelFromLonLat()
  • .render()
  • .setCoordinateSystem()
  • .getCoordinateSystem()
  • .getRenderStats()
  • .getRenderContext()
  • .setRenderContext()
  • .getTileManager()
  • .isEnabled()

new Sky(options)

Param	Type	Description
options	configuration	Sky configuration

sky.getType()

Kind: instance method of Sky
Implements: getType

sky.isSky()

Kind: instance method of Sky
Implements: isSky

sky.dispose()

Kind: instance method of Sky
Implements: dispose

sky.destroy()

Kind: instance method of Sky
Implements: destroy

sky.refresh()

Kind: instance method of Sky
Implements: refresh

sky.setBaseImagery()

Kind: instance abstract method of Sky
Implements: setBaseImagery

sky.getBaseElevation()

Kind: instance abstract method of Sky
Implements: getBaseElevation

sky.addLayer()

Kind: instance method of Sky
Implements: addLayer

sky.removeLayer()

Kind: instance method of Sky
Implements: removeLayer

sky.addAnimation()

Kind: instance method of Sky
Implements: addAnimation

sky.removeAnimation()

Kind: instance method of Sky
Implements: removeAnimation

sky.getElevation()

Kind: instance abstract method of Sky
Implements: getElevation

sky.getViewportGeoBound()

Kind: instance method of Sky
Implements: getViewportGeoBound

sky.getLonLatFromPixel()

Kind: instance method of Sky
Implements: getLonLatFromPixel

sky.getPixelFromLonLat()

Kind: instance method of Sky
Implements: getPixelFromLonLat

sky.render()

Kind: instance abstract method of Sky
Implements: Globe#render
Overrides: render
Access: protected

sky.setCoordinateSystem()

Kind: instance method of Sky
Implements: setCoordinateSystem

sky.getCoordinateSystem()

Kind: instance method of Sky
Implements: getCoordinateSystem

sky.getRenderStats()

Kind: instance method of Sky
Implements: getRenderStats

sky.getRenderContext()

Kind: instance method of Sky
Implements: getRenderContext

sky.setRenderContext()

Kind: instance method of Sky
Implements: setRenderContext

sky.getTileManager()

Kind: instance method of Sky
Implements: getTileManager

sky.isEnabled()

Kind: instance method of Sky
Implements: isEnabled

Layer

A layer is an information that can be superimposed on another information. It exists different natures of layer, which are listed as below :

• [AtmosphereLayer](#module_Layer.AtmosphereLayer) : A layer to create an atmosphere on a planet.
• [BingLayer](#module_Layer.BingLayer): The Microsoft service proving a WMTS server.
• [CoordinateGridLayer](#module_Layer.CoordinateGridLayer) : A layer to create a grid on the sky
• [GeoJSONLayer](#module_Layer.GeoJsonLayer) : A layer to add a GeoJSON on the globe
• [GroundOverlayLayer](#module_Layer.GroundOverlayLayer) : A layer to draw an image overlay draped onto the terrain
• [HipsCatLayer](#module_Layer.HipsCatLayer) : A layer to draw a HIPS catalogue
• [HipsFitsLayer](#module_Layer.HipsFitsLayer) : A layer to draw an Hips Fits
• [HipsGraphicLayer](#module_Layer.HipsGraphicLayer) : A layer to draw a Hips JPEG/PNG
• [MocLayer](#module_Layer.MocLayer) : A layer to draw a multi-order-coverage index
• [OpenSearchLayer](#module_Layer.OpenSearchLayer) : A layer to draw the result from an open search service
• [OSMLayer](#module_Layer.OSMLayer) : A layer to display data coming from OpenStreetMap server
• [PlanetLayer](#module_Layer.PlanetLayer) : A layer to save all layers of a planet
• [TileWireframeLayer](#module_Layer.TileWireframeLayer) : A layer to draw a grid on the planet
• [VectorLayer](#module_Layer.VectorLayer) : A layer to draw a vector
• [WCSElevationLayer](#module_Layer.WCSElevationLayer) : A layer to draw the elevation
• [WMSElevationLayer](#module_Layer.WMSElevationLayer) : A layer to draw the elevation
• [WMSLayer](#module_Layer.WMSLayer) : A layer to draw images coming from the WMS server
• [WMTSLayer](#module_Layer.WMTSLayer) : A layer to draw predefined tiles coming from a WMTS server

In addition to the classes, a [factory](#module_Layer.LayerFactory) is available to help for creating layer. Once the layer is created, the client can handle it by the use of its [interface](#Layer).

Implements: Layer

• Layer
  • .AtmosphereLayer ⇐ AbstractLayer
    • new AtmosphereLayer(options)
    • .getGlobe()
    • .getID()
    • .getName()
    • .getAttribution()
    • .getCopyrightUrl()
    • .getAck()
    • .getIcon()
    • .getDescription()
    • .isVisible()
    • .setVisible()
    • .getOpacity()
    • .setOpacity()
    • .getProperties()
    • .getType()
    • .isPickable()
    • .isType()
    • .getServices()
    • .getCoordinateSystem()
    • ._attach()
    • ._detach()
    • .getBaseURl()
    • .getDataType()
    • .getFormat()
    • .isDeletable()
    • .getColor()
    • .getStyle()
    • .getAvailableServices()
  • .BingLayer ⇐ AbstractRasterLayer
    • new BingLayer(options)
    • .getGlobe()
    • .getID()
    • .getName()
    • .getAttribution()
    • .getCopyrightUrl()
    • .getAck()
    • .getIcon()
    • .getDescription()
    • .isVisible()
    • .setVisible()
    • .getOpacity()
    • .setOpacity()
    • .getProperties()
    • .getType()
    • .isPickable()
    • .isType()
    • .getServices()
    • .getCoordinateSystem()
    • ._detach()
    • .getBaseURl()
    • .getDataType()
    • .getFormat()
    • .isDeletable()
    • .getColor()
    • .getStyle()
    • .getAvailableServices()
  • .CoordinateGridLayer ⇐ AbstractLayer
    • new CoordinateGridLayer(options)
    • .getGlobe()
    • .getID()
    • .getName()
    • .getAttribution()
    • .getCopyrightUrl()
    • .getAck()
    • .getIcon()
    • .getDescription()
    • .isVisible()
    • .setVisible()
    • .getOpacity()
    • .setOpacity()
    • .getProperties()
    • .getType()
    • .isPickable()
    • .isType()
    • .getServices()
    • .getCoordinateSystem()
    • ._attach()
    • ._detach()
    • .getBaseURl()
    • .getDataType()
    • .getFormat()
    • .isDeletable()
    • .getColor()
    • .getStyle()
    • .getAvailableServices()
  • .GeoJsonLayer ⇐ AbstractLayer
    • new GeoJsonLayer(options)
    • .getGlobe()
    • .getID()
    • .getName()
    • .getAttribution()
    • .getCopyrightUrl()
    • .getAck()
    • .getIcon()
    • .getDescription()
    • .isVisible()
    • .setVisible()
    • .getOpacity()
    • .setOpacity()
    • .getProperties()
    • .getType()
    • .isPickable()
    • .isType()
    • .getServices()
    • .getCoordinateSystem()
    • ._attach()
    • ._detach()
    • .getBaseURl()
    • .getDataType()
    • .getFormat()
    • .isDeletable()
    • .getColor()
    • .getStyle()
    • .getAvailableServices()
  • .GroundOverlayLayer ⇐ AbstractLayer
    • new GroundOverlayLayer(options)
    • .getGlobe()
    • .getID()
    • .getName()
    • .getAttribution()
    • .getCopyrightUrl()
    • .getAck()
    • .getIcon()
    • .getDescription()
    • .isVisible()
    • .setVisible()
    • .getOpacity()
    • .setOpacity()
    • .getProperties()
    • .getType()
    • .isPickable()
    • .isType()
    • .getServices()
    • .getCoordinateSystem()
    • ._attach()
    • ._detach()
    • .getBaseURl()
    • .getDataType()
    • .getFormat()
    • .isDeletable()
    • .getColor()
    • .getStyle()
    • .getAvailableServices()
  • .HipsCatLayer
    • new HipsCatLayer(options)
    • .launchRequest(tile, url)
    • .addFeature(feature, tile)
    • .removeFeature(identifier, tile)
    • .modifyFeatureStyle(feature, style)
    • .generate(tile)
    • .buildUrl(tile) ⇒ *
    • .getUrl(tile) ⇒ *
    • .render(tiles)
  • .HipsFitsLayer ⇐ AbstractHipsLayer
    • new HipsFitsLayer(hipsMetadata, options)
    • .getGlobe()
    • .getID()
    • .getName()
    • .getAttribution()
    • .getCopyrightUrl()
    • .getAck()
    • .getIcon()
    • .getDescription()
    • .isVisible()
    • .setVisible()
    • .getOpacity()
    • .setOpacity()
    • .getProperties()
    • .getType()
    • .isPickable()
    • .isType()
    • .getServices()
    • .getCoordinateSystem()
    • ._detach()
    • .getBaseURl()
    • .getDataType()
    • .getFormat()
    • .isDeletable()
    • .getColor()
    • .getStyle()
    • .getAvailableServices()
  • .HipsGraphicLayer ⇐ AbstractHipsLayer
    • new HipsGraphicLayer(hipsMetadata, options)
    • .getGlobe()
    • .getID()
    • .getName()
    • .getAttribution()
    • .getCopyrightUrl()
    • .getAck()
    • .getIcon()
    • .getDescription()
    • .isVisible()
    • .setVisible()
    • .getOpacity()
    • .setOpacity()
    • .getProperties()
    • .getType()
    • .isPickable()
    • .isType()
    • .getServices()
    • .getCoordinateSystem()
    • ._detach()
    • .getBaseURl()
    • .getDataType()
    • .getFormat()
    • .isDeletable()
    • .getColor()
    • .getStyle()
    • .getAvailableServices()
  • .LayerFactory
    • .create(options) ⇒ AbstractLayer
  • .MocLayer ⇐ AbstractLayer
    • new MocLayer(options)
    • .getGlobe()
    • .getID()
    • .getName()
    • .getAttribution()
    • .getCopyrightUrl()
    • .getAck()
    • .getIcon()
    • .getDescription()
    • .isVisible()
    • .setVisible()
    • .getOpacity()
    • .setOpacity()
    • .getProperties()
    • .getType()
    • .isPickable()
    • .isType()
    • .getServices()
    • .getCoordinateSystem()
    • ._attach()
    • ._detach()
    • .getBaseURl()
    • .getDataType()
    • .getFormat()
    • .isDeletable()
    • .getColor()
    • .getStyle()
    • .getAvailableServices()
  • .OSMLayer ⇐ AbstractRasterLayer
    • new OSMLayer(options)
    • .getGlobe()
    • .getID()
    • .getName()
    • .getAttribution()
    • .getCopyrightUrl()
    • .getAck()
    • .getIcon()
    • .getDescription()
    • .isVisible()
    • .setVisible()
    • .getOpacity()
    • .setOpacity()
    • .getProperties()
    • .getType()
    • .isPickable()
    • .isType()
    • .getServices()
    • .getCoordinateSystem()
    • ._detach()
    • .getBaseURl()
    • .getDataType()
    • .getFormat()
    • .isDeletable()
    • .getColor()
    • .getStyle()
    • .getAvailableServices()
  • .OpenSearchLayer ⇐ AbstractLayer
    • new OpenSearchLayer(options)
    • .getGlobe()
    • .getID()
    • .getName()
    • .getAttribution()
    • .getCopyrightUrl()
    • .getAck()
    • .getIcon()
    • .getDescription()
    • .isVisible()
    • .setVisible()
    • .getOpacity()
    • .setOpacity()
    • .getProperties()
    • .getType()
    • .isPickable()
    • .isType()
    • .getServices()
    • .getCoordinateSystem()
    • ._attach()
    • ._detach()
    • .getBaseURl()
    • .getDataType()
    • .getFormat()
    • .isDeletable()
    • .getColor()
    • .getStyle()
    • .getAvailableServices()
  • .PlanetLayer
    • new PlanetLayer(options)
  • .TileWireframeLayer ⇐ AbstractLayer
    • new TileWireframeLayer(options)
    • .getGlobe()
    • .getID()
    • .getName()
    • .getAttribution()
    • .getCopyrightUrl()
    • .getAck()
    • .getIcon()
    • .getDescription()
    • .isVisible()
    • .setVisible()
    • .getOpacity()
    • .setOpacity()
    • .getProperties()
    • .getType()
    • .isPickable()
    • .isType()
    • .getServices()
    • .getCoordinateSystem()
    • ._attach()
    • ._detach()
    • .getBaseURl()
    • .getDataType()
    • .getFormat()
    • .isDeletable()
    • .getColor()
    • .getStyle()
    • .getAvailableServices()
  • .VectorLayer ⇐ AbstractLayer
    • new VectorLayer(options)
    • .getGlobe()
    • .getID()
    • .getName()
    • .getAttribution()
    • .getCopyrightUrl()
    • .getAck()
    • .getIcon()
    • .getDescription()
    • .isVisible()
    • .setVisible()
    • .getOpacity()
    • .setOpacity()
    • .getProperties()
    • .getType()
    • .isPickable()
    • .isType()
    • .getServices()
    • .getCoordinateSystem()
    • ._attach()
    • ._detach()
    • .getBaseURl()
    • .getDataType()
    • .getFormat()
    • .isDeletable()
    • .getColor()
    • .getStyle()
    • .getAvailableServices()
  • .WCSElevationLayer ⇐ AbstractRasterLayer
    • new WCSElevationLayer(options)
    • .getGlobe()
    • .getID()
    • .getName()
    • .getAttribution()
    • .getCopyrightUrl()
    • .getAck()
    • .getIcon()
    • .getDescription()
    • .isVisible()
    • .setVisible()
    • .getOpacity()
    • .setOpacity()
    • .getProperties()
    • .getType()
    • .isPickable()
    • .isType()
    • .getServices()
    • .getCoordinateSystem()
    • ._detach()
    • .getBaseURl()
    • .getDataType()
    • .getFormat()
    • .isDeletable()
    • .getColor()
    • .getStyle()
    • .getAvailableServices()
  • .WMSElevationLayer ⇐ WMSLayer
    • new WMSElevationLayer(options)
    • .getUrl(tile) ⇒ String
    • .getBaseURl()
  • .WMSLayer ⇐ AbstractRasterLayer
    • new WMSLayer(options)
    • .getGlobe()
    • .getID()
    • .getName()
    • .getAttribution()
    • .getCopyrightUrl()
    • .getAck()
    • .getIcon()
    • .getDescription()
    • .isVisible()
    • .setVisible()
    • .getOpacity()
    • .setOpacity()
    • .getProperties()
    • .getType()
    • .isPickable()
    • .isType()
    • .getServices()
    • .getCoordinateSystem()
    • ._detach()
    • .getBaseURl()
    • .getDataType()
    • .getFormat()
    • .isDeletable()
    • .getColor()
    • .getStyle()
    • .getAvailableServices()
  • .WMTSLayer ⇐ AbstractRasterLayer
    • new WMTSLayer(options)
    • .getGlobe()
    • .getID()
    • .getName()
    • .getAttribution()
    • .getCopyrightUrl()
    • .getAck()
    • .getIcon()
    • .getDescription()
    • .isVisible()
    • .setVisible()
    • .getOpacity()
    • .setOpacity()
    • .getProperties()
    • .getType()
    • .isPickable()
    • .isType()
    • .getServices()
    • .getCoordinateSystem()
    • ._detach()
    • .getBaseURl()
    • .getDataType()
    • .getFormat()
    • .isDeletable()
    • .getColor()
    • .getStyle()
    • .getAvailableServices()

Layer.AtmosphereLayer ⇐ AbstractLayer

Creates an atmosphere on the planet.

Kind: static class of Layer
Extends: AbstractLayer

• .AtmosphereLayer ⇐ AbstractLayer
  • new AtmosphereLayer(options)
  • .getGlobe()
  • .getID()
  • .getName()
  • .getAttribution()
  • .getCopyrightUrl()
  • .getAck()
  • .getIcon()
  • .getDescription()
  • .isVisible()
  • .setVisible()
  • .getOpacity()
  • .setOpacity()
  • .getProperties()
  • .getType()
  • .isPickable()
  • .isType()
  • .getServices()
  • .getCoordinateSystem()
  • ._attach()
  • ._detach()
  • .getBaseURl()
  • .getDataType()
  • .getFormat()
  • .isDeletable()
  • .getColor()
  • .getStyle()
  • .getAvailableServices()

new AtmosphereLayer(options)

Param	Type	Description
options	atmosphere_configuration	Atmosphere configuration.

atmosphereLayer.getGlobe()

Kind: instance method of AtmosphereLayer
Implements: getGlobe

atmosphereLayer.getID()

Kind: instance method of AtmosphereLayer
Implements: getID

atmosphereLayer.getName()

Kind: instance method of AtmosphereLayer
Implements: getName

atmosphereLayer.getAttribution()

Kind: instance method of AtmosphereLayer
Implements: getAttribution

atmosphereLayer.getCopyrightUrl()

Kind: instance method of AtmosphereLayer
Implements: getCopyrightUrl

atmosphereLayer.getAck()

Kind: instance method of AtmosphereLayer
Implements: getAck

atmosphereLayer.getIcon()

Kind: instance method of AtmosphereLayer
Implements: getIcon

atmosphereLayer.getDescription()

Kind: instance method of AtmosphereLayer
Implements: getDescription

atmosphereLayer.isVisible()

Kind: instance method of AtmosphereLayer
Implements: isVisible

atmosphereLayer.setVisible()

Kind: instance method of AtmosphereLayer
Implements: setVisible

atmosphereLayer.getOpacity()

Kind: instance method of AtmosphereLayer
Implements: getOpacity

atmosphereLayer.setOpacity()

Kind: instance method of AtmosphereLayer
Implements: setOpacity

atmosphereLayer.getProperties()

Kind: instance method of AtmosphereLayer
Implements: getProperties

atmosphereLayer.getType()

Kind: instance method of AtmosphereLayer
Implements: getType

atmosphereLayer.isPickable()

Kind: instance method of AtmosphereLayer
Implements: isPickable

atmosphereLayer.isType()

Kind: instance method of AtmosphereLayer
Implements: isType

atmosphereLayer.getServices()

Kind: instance method of AtmosphereLayer
Implements: getServices

atmosphereLayer.getCoordinateSystem()

Kind: instance method of AtmosphereLayer
Implements: getCoordinateSystem

atmosphereLayer._attach()

Kind: instance method of AtmosphereLayer
Implements: _attach

atmosphereLayer._detach()

Kind: instance method of AtmosphereLayer
Implements: _detach

atmosphereLayer.getBaseURl()

Kind: instance method of AtmosphereLayer
Implements: getBaseURl

atmosphereLayer.getDataType()

Kind: instance method of AtmosphereLayer
Implements: getDataType

atmosphereLayer.getFormat()

Kind: instance method of AtmosphereLayer
Implements: getFormat

atmosphereLayer.isDeletable()

Kind: instance method of AtmosphereLayer
Implements: isDeletable

atmosphereLayer.getColor()

Kind: instance method of AtmosphereLayer
Implements: getColor

atmosphereLayer.getStyle()

Kind: instance method of AtmosphereLayer
Implements: getStyle

atmosphereLayer.getAvailableServices()

Kind: instance method of AtmosphereLayer
Implements: getAvailableServices

Layer.BingLayer ⇐ AbstractRasterLayer

Bing Maps is a web mapping service provided as a part of Microsoft's Bing suite of search engines and powered by the Bing Maps for Enterprise framework.

Kind: static class of Layer
Extends: AbstractRasterLayer
See: https://en.wikipedia.org/wiki/Bing_Maps

• .BingLayer ⇐ AbstractRasterLayer
  • new BingLayer(options)
  • .getGlobe()
  • .getID()
  • .getName()
  • .getAttribution()
  • .getCopyrightUrl()
  • .getAck()
  • .getIcon()
  • .getDescription()
  • .isVisible()
  • .setVisible()
  • .getOpacity()
  • .setOpacity()
  • .getProperties()
  • .getType()
  • .isPickable()
  • .isType()
  • .getServices()
  • .getCoordinateSystem()
  • ._detach()
  • .getBaseURl()
  • .getDataType()
  • .getFormat()
  • .isDeletable()
  • .getColor()
  • .getStyle()
  • .getAvailableServices()

new BingLayer(options)

Param	Type	Description
options	bing_configuration	Bing Layer configuration

bingLayer.getGlobe()

Kind: instance method of BingLayer
Implements: getGlobe

bingLayer.getID()

Kind: instance method of BingLayer
Implements: getID

bingLayer.getName()

Kind: instance method of BingLayer
Implements: getName

bingLayer.getAttribution()

Kind: instance method of BingLayer
Implements: getAttribution

bingLayer.getCopyrightUrl()

Kind: instance method of BingLayer
Implements: getCopyrightUrl

bingLayer.getAck()

Kind: instance method of BingLayer
Implements: getAck

bingLayer.getIcon()

Kind: instance method of BingLayer
Implements: getIcon

bingLayer.getDescription()

Kind: instance method of BingLayer
Implements: getDescription

bingLayer.isVisible()

Kind: instance method of BingLayer
Implements: isVisible

bingLayer.setVisible()

Kind: instance method of BingLayer
Implements: setVisible

bingLayer.getOpacity()

Kind: instance method of BingLayer
Implements: getOpacity

bingLayer.setOpacity()

Kind: instance method of BingLayer
Implements: setOpacity

bingLayer.getProperties()

Kind: instance method of BingLayer
Implements: getProperties

bingLayer.getType()

Kind: instance method of BingLayer
Implements: getType

bingLayer.isPickable()

Kind: instance method of BingLayer
Implements: isPickable

bingLayer.isType()

Kind: instance method of BingLayer
Implements: isType

bingLayer.getServices()

Kind: instance method of BingLayer
Implements: getServices

bingLayer.getCoordinateSystem()

Kind: instance method of BingLayer
Implements: getCoordinateSystem

bingLayer._detach()

Kind: instance method of BingLayer
Implements: _detach

bingLayer.getBaseURl()

Kind: instance method of BingLayer
Implements: getBaseURl

bingLayer.getDataType()

Kind: instance method of BingLayer
Implements: getDataType

bingLayer.getFormat()

Kind: instance method of BingLayer
Implements: getFormat

bingLayer.isDeletable()

Kind: instance method of BingLayer
Implements: isDeletable

bingLayer.getColor()

Kind: instance method of BingLayer
Implements: getColor

bingLayer.getStyle()

Kind: instance method of BingLayer
Implements: getStyle

bingLayer.getAvailableServices()

Kind: instance method of BingLayer
Implements: getAvailableServices

Layer.CoordinateGridLayer ⇐ AbstractLayer

A layer for coordinate grid

Kind: static class of Layer
Extends: AbstractLayer

• .CoordinateGridLayer ⇐ AbstractLayer
  • new CoordinateGridLayer(options)
  • .getGlobe()
  • .getID()
  • .getName()
  • .getAttribution()
  • .getCopyrightUrl()
  • .getAck()
  • .getIcon()
  • .getDescription()
  • .isVisible()
  • .setVisible()
  • .getOpacity()
  • .setOpacity()
  • .getProperties()
  • .getType()
  • .isPickable()
  • .isType()
  • .getServices()
  • .getCoordinateSystem()
  • ._attach()
  • ._detach()
  • .getBaseURl()
  • .getDataType()
  • .getFormat()
  • .isDeletable()
  • .getColor()
  • .getStyle()
  • .getAvailableServices()

new CoordinateGridLayer(options)

Param	Type	Description
options	coordinateGrid_configuration	coordinate grid layer configuration

coordinateGridLayer.getGlobe()

Kind: instance method of CoordinateGridLayer
Implements: getGlobe

coordinateGridLayer.getID()

Kind: instance method of CoordinateGridLayer
Implements: getID

coordinateGridLayer.getName()

Kind: instance method of CoordinateGridLayer
Implements: getName

coordinateGridLayer.getAttribution()

Kind: instance method of CoordinateGridLayer
Implements: getAttribution

coordinateGridLayer.getCopyrightUrl()

Kind: instance method of CoordinateGridLayer
Implements: getCopyrightUrl

coordinateGridLayer.getAck()

Kind: instance method of CoordinateGridLayer
Implements: getAck

coordinateGridLayer.getIcon()

Kind: instance method of CoordinateGridLayer
Implements: getIcon

coordinateGridLayer.getDescription()

Kind: instance method of CoordinateGridLayer
Implements: getDescription

coordinateGridLayer.isVisible()

Kind: instance method of CoordinateGridLayer
Implements: isVisible

coordinateGridLayer.setVisible()

Kind: instance method of CoordinateGridLayer
Implements: setVisible

coordinateGridLayer.getOpacity()

Kind: instance method of CoordinateGridLayer
Implements: getOpacity

coordinateGridLayer.setOpacity()

Kind: instance method of CoordinateGridLayer
Implements: setOpacity

coordinateGridLayer.getProperties()

Kind: instance method of CoordinateGridLayer
Implements: getProperties

coordinateGridLayer.getType()

Kind: instance method of CoordinateGridLayer
Implements: getType

coordinateGridLayer.isPickable()

Kind: instance method of CoordinateGridLayer
Implements: isPickable

coordinateGridLayer.isType()

Kind: instance method of CoordinateGridLayer
Implements: isType

coordinateGridLayer.getServices()

Kind: instance method of CoordinateGridLayer
Implements: getServices

coordinateGridLayer.getCoordinateSystem()

Kind: instance method of CoordinateGridLayer
Implements: getCoordinateSystem

coordinateGridLayer._attach()

Kind: instance method of CoordinateGridLayer
Implements: _attach

coordinateGridLayer._detach()

Kind: instance method of CoordinateGridLayer
Implements: _detach

coordinateGridLayer.getBaseURl()

Kind: instance method of CoordinateGridLayer
Implements: getBaseURl

coordinateGridLayer.getDataType()

Kind: instance method of CoordinateGridLayer
Implements: getDataType

coordinateGridLayer.getFormat()

Kind: instance method of CoordinateGridLayer
Implements: getFormat

coordinateGridLayer.isDeletable()

Kind: instance method of CoordinateGridLayer
Implements: isDeletable

coordinateGridLayer.getColor()

Kind: instance method of CoordinateGridLayer
Implements: getColor

coordinateGridLayer.getStyle()

Kind: instance method of CoordinateGridLayer
Implements: getStyle

coordinateGridLayer.getAvailableServices()

Kind: instance method of CoordinateGridLayer
Implements: getAvailableServices

Layer.GeoJsonLayer ⇐ AbstractLayer

Create a layer to display vector data in GeoJSON format.

Kind: static class of Layer
Extends: AbstractLayer

• .GeoJsonLayer ⇐ AbstractLayer
  • new GeoJsonLayer(options)
  • .getGlobe()
  • .getID()
  • .getName()
  • .getAttribution()
  • .getCopyrightUrl()
  • .getAck()
  • .getIcon()
  • .getDescription()
  • .isVisible()
  • .setVisible()
  • .getOpacity()
  • .setOpacity()
  • .getProperties()
  • .getType()
  • .isPickable()
  • .isType()
  • .getServices()
  • .getCoordinateSystem()
  • ._attach()
  • ._detach()
  • .getBaseURl()
  • .getDataType()
  • .getFormat()
  • .isDeletable()
  • .getColor()
  • .getStyle()
  • .getAvailableServices()

new GeoJsonLayer(options)

Param	Type	Description
options	geojson_configuration	GeoJsonLayer configuration

geoJsonLayer.getGlobe()

Kind: instance method of GeoJsonLayer
Implements: getGlobe

geoJsonLayer.getID()

Kind: instance method of GeoJsonLayer
Implements: getID

geoJsonLayer.getName()

Kind: instance method of GeoJsonLayer
Implements: getName

geoJsonLayer.getAttribution()

Kind: instance method of GeoJsonLayer
Implements: getAttribution

geoJsonLayer.getCopyrightUrl()

Kind: instance method of GeoJsonLayer
Implements: getCopyrightUrl

geoJsonLayer.getAck()

Kind: instance method of GeoJsonLayer
Implements: getAck

geoJsonLayer.getIcon()

Kind: instance method of GeoJsonLayer
Implements: getIcon

geoJsonLayer.getDescription()

Kind: instance method of GeoJsonLayer
Implements: getDescription

geoJsonLayer.isVisible()

Kind: instance method of GeoJsonLayer
Implements: isVisible

geoJsonLayer.setVisible()

Kind: instance method of GeoJsonLayer
Implements: setVisible

geoJsonLayer.getOpacity()

Kind: instance method of GeoJsonLayer
Implements: getOpacity

geoJsonLayer.setOpacity()

Kind: instance method of GeoJsonLayer
Implements: setOpacity

geoJsonLayer.getProperties()

Kind: instance method of GeoJsonLayer
Implements: getProperties

geoJsonLayer.getType()

Kind: instance method of GeoJsonLayer
Implements: getType

geoJsonLayer.isPickable()

Kind: instance method of GeoJsonLayer
Implements: isPickable

geoJsonLayer.isType()

Kind: instance method of GeoJsonLayer
Implements: isType

geoJsonLayer.getServices()

Kind: instance method of GeoJsonLayer
Implements: getServices

geoJsonLayer.getCoordinateSystem()

Kind: instance method of GeoJsonLayer
Implements: getCoordinateSystem

geoJsonLayer._attach()

Kind: instance method of GeoJsonLayer
Implements: _attach

geoJsonLayer._detach()

Kind: instance method of GeoJsonLayer
Implements: _detach

geoJsonLayer.getBaseURl()

Kind: instance method of GeoJsonLayer
Implements: getBaseURl

geoJsonLayer.getDataType()

Kind: instance method of GeoJsonLayer
Implements: getDataType

geoJsonLayer.getFormat()

Kind: instance method of GeoJsonLayer
Implements: getFormat

geoJsonLayer.isDeletable()

Kind: instance method of GeoJsonLayer
Implements: isDeletable

geoJsonLayer.getColor()

Kind: instance method of GeoJsonLayer
Implements: getColor

geoJsonLayer.getStyle()

Kind: instance method of GeoJsonLayer
Implements: getStyle

geoJsonLayer.getAvailableServices()

Kind: instance method of GeoJsonLayer
Implements: getAvailableServices

Layer.GroundOverlayLayer ⇐ AbstractLayer

This layer draws an image overlay draped onto the terrain

Kind: static class of Layer
Extends: AbstractLayer

• .GroundOverlayLayer ⇐ AbstractLayer
  • new GroundOverlayLayer(options)
  • .getGlobe()
  • .getID()
  • .getName()
  • .getAttribution()
  • .getCopyrightUrl()
  • .getAck()
  • .getIcon()
  • .getDescription()
  • .isVisible()
  • .setVisible()
  • .getOpacity()
  • .setOpacity()
  • .getProperties()
  • .getType()
  • .isPickable()
  • .isType()
  • .getServices()
  • .getCoordinateSystem()
  • ._attach()
  • ._detach()
  • .getBaseURl()
  • .getDataType()
  • .getFormat()
  • .isDeletable()
  • .getColor()
  • .getStyle()
  • .getAvailableServices()

new GroundOverlayLayer(options)

Param	Type	Description
options	groundOverlay_configuration	Ground overlay configuration

groundOverlayLayer.getGlobe()

Kind: instance method of GroundOverlayLayer
Implements: getGlobe

groundOverlayLayer.getID()

Kind: instance method of GroundOverlayLayer
Implements: getID

groundOverlayLayer.getName()

Kind: instance method of GroundOverlayLayer
Implements: getName

groundOverlayLayer.getAttribution()

Kind: instance method of GroundOverlayLayer
Implements: getAttribution

groundOverlayLayer.getCopyrightUrl()

Kind: instance method of GroundOverlayLayer
Implements: getCopyrightUrl

groundOverlayLayer.getAck()

Kind: instance method of GroundOverlayLayer
Implements: getAck

groundOverlayLayer.getIcon()

Kind: instance method of GroundOverlayLayer
Implements: getIcon

groundOverlayLayer.getDescription()

Kind: instance method of GroundOverlayLayer
Implements: getDescription

groundOverlayLayer.isVisible()

Kind: instance method of GroundOverlayLayer
Implements: isVisible

groundOverlayLayer.setVisible()

Kind: instance method of GroundOverlayLayer
Implements: setVisible

groundOverlayLayer.getOpacity()

Kind: instance method of GroundOverlayLayer
Implements: getOpacity

groundOverlayLayer.setOpacity()

Kind: instance method of GroundOverlayLayer
Implements: setOpacity

groundOverlayLayer.getProperties()

Kind: instance method of GroundOverlayLayer
Implements: getProperties

groundOverlayLayer.getType()

Kind: instance method of GroundOverlayLayer
Implements: getType

groundOverlayLayer.isPickable()

Kind: instance method of GroundOverlayLayer
Implements: isPickable

groundOverlayLayer.isType()

Kind: instance method of GroundOverlayLayer
Implements: isType

groundOverlayLayer.getServices()

Kind: instance method of GroundOverlayLayer
Implements: getServices

groundOverlayLayer.getCoordinateSystem()

Kind: instance method of GroundOverlayLayer
Implements: getCoordinateSystem

groundOverlayLayer._attach()

Kind: instance method of GroundOverlayLayer
Implements: _attach

groundOverlayLayer._detach()

Kind: instance method of GroundOverlayLayer
Implements: _detach

groundOverlayLayer.getBaseURl()

Kind: instance method of GroundOverlayLayer
Implements: getBaseURl

groundOverlayLayer.getDataType()

Kind: instance method of GroundOverlayLayer
Implements: getDataType

groundOverlayLayer.getFormat()

Kind: instance method of GroundOverlayLayer
Implements: getFormat

groundOverlayLayer.isDeletable()

Kind: instance method of GroundOverlayLayer
Implements: isDeletable

groundOverlayLayer.getColor()

Kind: instance method of GroundOverlayLayer
Implements: getColor

groundOverlayLayer.getStyle()

Kind: instance method of GroundOverlayLayer
Implements: getStyle

groundOverlayLayer.getAvailableServices()

Kind: instance method of GroundOverlayLayer
Implements: getAvailableServices

Layer.HipsCatLayer

Kind: static class of Layer
See: Hips standard

• .HipsCatLayer
  • new HipsCatLayer(options)
  • .launchRequest(tile, url)
  • .addFeature(feature, tile)
  • .removeFeature(identifier, tile)
  • .modifyFeatureStyle(feature, style)
  • .generate(tile)
  • .buildUrl(tile) ⇒ *
  • .getUrl(tile) ⇒ *
  • .render(tiles)

new HipsCatLayer(options)

Create a HIPS catalogue

Param	Type	Description
options	hipsCat_configuration	Hip catalogue configuration

hipsCatLayer.launchRequest(tile, url)

Launches request to the HipsCatLayer service

Kind: instance method of HipsCatLayer
Emits: startLoad, endLoad, features:added

Param
tile
url

hipsCatLayer.addFeature(feature, tile)

Adds feature to the layer and to the tile extension

Kind: instance method of HipsCatLayer

Param
feature
tile

hipsCatLayer.removeFeature(identifier, tile)

Removes feature from Dynamic HipsCatLayer layer

Kind: instance method of HipsCatLayer

Param
identifier
tile

hipsCatLayer.modifyFeatureStyle(feature, style)

Modifies feature style

Kind: instance method of HipsCatLayer

Param
feature
style

hipsCatLayer.generate(tile)

Generates the tile data

Kind: instance method of HipsCatLayer

Param
tile

hipsCatLayer.buildUrl(tile) ⇒ *

Builds URL

Kind: instance method of HipsCatLayer

Param
tile

hipsCatLayer.getUrl(tile) ⇒ *

Get Tile URL.

Kind: instance method of HipsCatLayer

Param
tile

hipsCatLayer.render(tiles)

Render function

Kind: instance method of HipsCatLayer

Param	Description
tiles	The array of tiles to render

Layer.HipsFitsLayer ⇐ AbstractHipsLayer

This layer draws an Hips Fits Image

Kind: static class of Layer
Extends: AbstractHipsLayer
See: Hips standard

• .HipsFitsLayer ⇐ AbstractHipsLayer
  • new HipsFitsLayer(hipsMetadata, options)
  • .getGlobe()
  • .getID()
  • .getName()
  • .getAttribution()
  • .getCopyrightUrl()
  • .getAck()
  • .getIcon()
  • .getDescription()
  • .isVisible()
  • .setVisible()
  • .getOpacity()
  • .setOpacity()
  • .getProperties()
  • .getType()
  • .isPickable()
  • .isType()
  • .getServices()
  • .getCoordinateSystem()
  • ._detach()
  • .getBaseURl()
  • .getDataType()
  • .getFormat()
  • .isDeletable()
  • .getColor()
  • .getStyle()
  • .getAvailableServices()

new HipsFitsLayer(hipsMetadata, options)

Param	Type	Description
hipsMetadata	Object	HIPS Metadata
options	hipsFits_configuration	HipsFits configuration

hipsFitsLayer.getGlobe()

Kind: instance method of HipsFitsLayer
Implements: getGlobe

hipsFitsLayer.getID()

Kind: instance method of HipsFitsLayer
Implements: getID

hipsFitsLayer.getName()

Kind: instance method of HipsFitsLayer
Implements: getName

hipsFitsLayer.getAttribution()

Kind: instance method of HipsFitsLayer
Implements: getAttribution

hipsFitsLayer.getCopyrightUrl()

Kind: instance method of HipsFitsLayer
Implements: getCopyrightUrl

hipsFitsLayer.getAck()

Kind: instance method of HipsFitsLayer
Implements: getAck

hipsFitsLayer.getIcon()

Kind: instance method of HipsFitsLayer
Implements: getIcon

hipsFitsLayer.getDescription()

Kind: instance method of HipsFitsLayer
Implements: getDescription

hipsFitsLayer.isVisible()

Kind: instance method of HipsFitsLayer
Implements: isVisible

hipsFitsLayer.setVisible()

Kind: instance method of HipsFitsLayer
Implements: setVisible

hipsFitsLayer.getOpacity()

Kind: instance method of HipsFitsLayer
Implements: getOpacity

hipsFitsLayer.setOpacity()

Kind: instance method of HipsFitsLayer
Implements: setOpacity

hipsFitsLayer.getProperties()

Kind: instance method of HipsFitsLayer
Implements: getProperties

hipsFitsLayer.getType()

Kind: instance method of HipsFitsLayer
Implements: getType

hipsFitsLayer.isPickable()

Kind: instance method of HipsFitsLayer
Implements: isPickable

hipsFitsLayer.isType()

Kind: instance method of HipsFitsLayer
Implements: isType

hipsFitsLayer.getServices()

Kind: instance method of HipsFitsLayer
Implements: getServices

hipsFitsLayer.getCoordinateSystem()

Kind: instance method of HipsFitsLayer
Implements: getCoordinateSystem

hipsFitsLayer._detach()

Kind: instance method of HipsFitsLayer
Implements: _detach

hipsFitsLayer.getBaseURl()

Kind: instance method of HipsFitsLayer
Implements: getBaseURl

hipsFitsLayer.getDataType()

Kind: instance method of HipsFitsLayer
Implements: getDataType

hipsFitsLayer.getFormat()

Kind: instance method of HipsFitsLayer
Implements: getFormat

hipsFitsLayer.isDeletable()

Kind: instance method of HipsFitsLayer
Implements: isDeletable

hipsFitsLayer.getColor()

Kind: instance method of HipsFitsLayer
Implements: getColor

hipsFitsLayer.getStyle()

Kind: instance method of HipsFitsLayer
Implements: getStyle

hipsFitsLayer.getAvailableServices()

Kind: instance method of HipsFitsLayer
Implements: getAvailableServices

Layer.HipsGraphicLayer ⇐ AbstractHipsLayer

This layer draws an Hips Image

Kind: static class of Layer
Extends: AbstractHipsLayer
Emits: baseLayersError
See: Hips standard

• .HipsGraphicLayer ⇐ AbstractHipsLayer
  • new HipsGraphicLayer(hipsMetadata, options)
  • .getGlobe()
  • .getID()
  • .getName()
  • .getAttribution()
  • .getCopyrightUrl()
  • .getAck()
  • .getIcon()
  • .getDescription()
  • .isVisible()
  • .setVisible()
  • .getOpacity()
  • .setOpacity()
  • .getProperties()
  • .getType()
  • .isPickable()
  • .isType()
  • .getServices()
  • .getCoordinateSystem()
  • ._detach()
  • .getBaseURl()
  • .getDataType()
  • .getFormat()
  • .isDeletable()
  • .getColor()
  • .getStyle()
  • .getAvailableServices()

new HipsGraphicLayer(hipsMetadata, options)

Param	Type	Description
hipsMetadata	HipsMetadata
options	graphic_configuration	HipsGraphic configuration

hipsGraphicLayer.getGlobe()

Kind: instance method of HipsGraphicLayer
Implements: getGlobe

hipsGraphicLayer.getID()

Kind: instance method of HipsGraphicLayer
Implements: getID

hipsGraphicLayer.getName()

Kind: instance method of HipsGraphicLayer
Implements: getName

hipsGraphicLayer.getAttribution()

Kind: instance method of HipsGraphicLayer
Implements: getAttribution

hipsGraphicLayer.getCopyrightUrl()

Kind: instance method of HipsGraphicLayer
Implements: getCopyrightUrl

hipsGraphicLayer.getAck()

Kind: instance method of HipsGraphicLayer
Implements: getAck

hipsGraphicLayer.getIcon()

Kind: instance method of HipsGraphicLayer
Implements: getIcon

hipsGraphicLayer.getDescription()

Kind: instance method of HipsGraphicLayer
Implements: getDescription

hipsGraphicLayer.isVisible()

Kind: instance method of HipsGraphicLayer
Implements: isVisible

hipsGraphicLayer.setVisible()

Kind: instance method of HipsGraphicLayer
Implements: setVisible

hipsGraphicLayer.getOpacity()

Kind: instance method of HipsGraphicLayer
Implements: getOpacity

hipsGraphicLayer.setOpacity()

Kind: instance method of HipsGraphicLayer
Implements: setOpacity

hipsGraphicLayer.getProperties()

Kind: instance method of HipsGraphicLayer
Implements: getProperties

hipsGraphicLayer.getType()

Kind: instance method of HipsGraphicLayer
Implements: getType

hipsGraphicLayer.isPickable()

Kind: instance method of HipsGraphicLayer
Implements: isPickable

hipsGraphicLayer.isType()

Kind: instance method of HipsGraphicLayer
Implements: isType

hipsGraphicLayer.getServices()

Kind: instance method of HipsGraphicLayer
Implements: getServices

hipsGraphicLayer.getCoordinateSystem()

Kind: instance method of HipsGraphicLayer
Implements: getCoordinateSystem

hipsGraphicLayer._detach()

Kind: instance method of HipsGraphicLayer
Implements: _detach

hipsGraphicLayer.getBaseURl()

Kind: instance method of HipsGraphicLayer
Implements: getBaseURl

hipsGraphicLayer.getDataType()

Kind: instance method of HipsGraphicLayer
Implements: getDataType

hipsGraphicLayer.getFormat()

Kind: instance method of HipsGraphicLayer
Implements: getFormat

hipsGraphicLayer.isDeletable()

Kind: instance method of HipsGraphicLayer
Implements: isDeletable

hipsGraphicLayer.getColor()

Kind: instance method of HipsGraphicLayer
Implements: getColor

hipsGraphicLayer.getStyle()

Kind: instance method of HipsGraphicLayer
Implements: getStyle

hipsGraphicLayer.getAvailableServices()

Kind: instance method of HipsGraphicLayer
Implements: getAvailableServices

Layer.LayerFactory

Factory to create a layer

Kind: static class of Layer

LayerFactory.create(options) ⇒ AbstractLayer

Factory for Layer.

Kind: static method of LayerFactory
Returns: AbstractLayer - - Object to handle Layer
Throw: "Unable to create the layer"
See

• AtmosphereLayer : A layer to create an atmosphere on a planet.
• BingLayer: The Microsoft service proving a WMTS server.
• CoordinateGridLayer : A layer to create a grid on the sky
• GeoJSONLayer : A layer to add a GeoJSON on the globe
• GroundOverlayLayer : A layer to draw an image overlay draped onto the terrain
• HipsCatLayer : A layer to draw a HIPS catalogue
• HipsFitsLayer : A layer to draw an Hips Fits
• HipsGraphicLayer : A layer to draw a Hips JPEG/PNG
• MocLayer : A layer to draw a multi-order-coverage index
• OpenSearchLayer : A layer to draw the result from an open search service
• OSMLayer : A layer to display data coming from OpenStreetMap server
• PlanetLayer : A layer to save all layers of a planet
• TileWireframeLayer : A layer to draw a grid on the planet
• VectorLayer : A layer to draw a vector
• WCSElevationLayer : A layer to draw the elevation
• WMSElevationLayer : A layer to draw the elevation
• WMSLayer : A layer to draw images coming from the WMS server
• WMTSLayer : A layer to draw predefined tiles coming from a WMTS server

Param	Type	Description
options	Object	See the base properties configuration and specific properties for specific layers
options.type	string	one of the following value {Constants.Layer}

Layer.MocLayer ⇐ AbstractLayer

This layer draws a MOC data

Kind: static class of Layer
Extends: AbstractLayer
See: Moc

• .MocLayer ⇐ AbstractLayer
  • new MocLayer(options)
  • .getGlobe()
  • .getID()
  • .getName()
  • .getAttribution()
  • .getCopyrightUrl()
  • .getAck()
  • .getIcon()
  • .getDescription()
  • .isVisible()
  • .setVisible()
  • .getOpacity()
  • .setOpacity()
  • .getProperties()
  • .getType()
  • .isPickable()
  • .isType()
  • .getServices()
  • .getCoordinateSystem()
  • ._attach()
  • ._detach()
  • .getBaseURl()
  • .getDataType()
  • .getFormat()
  • .isDeletable()
  • .getColor()
  • .getStyle()
  • .getAvailableServices()

new MocLayer(options)

Param	Type	Description
options	moc_configuration	Moc layer configuration

mocLayer.getGlobe()

Kind: instance method of MocLayer
Implements: getGlobe

mocLayer.getID()

Kind: instance method of MocLayer
Implements: getID

mocLayer.getName()

Kind: instance method of MocLayer
Implements: getName

mocLayer.getAttribution()

Kind: instance method of MocLayer
Implements: getAttribution

mocLayer.getCopyrightUrl()

Kind: instance method of MocLayer
Implements: getCopyrightUrl

mocLayer.getAck()

Kind: instance method of MocLayer
Implements: getAck

mocLayer.getIcon()

Kind: instance method of MocLayer
Implements: getIcon

mocLayer.getDescription()

Kind: instance method of MocLayer
Implements: getDescription

mocLayer.isVisible()

Kind: instance method of MocLayer
Implements: isVisible

mocLayer.setVisible()

Kind: instance method of MocLayer
Implements: setVisible

mocLayer.getOpacity()

Kind: instance method of MocLayer
Implements: getOpacity

mocLayer.setOpacity()

Kind: instance method of MocLayer
Implements: setOpacity

mocLayer.getProperties()

Kind: instance method of MocLayer
Implements: getProperties

mocLayer.getType()

Kind: instance method of MocLayer
Implements: getType

mocLayer.isPickable()

Kind: instance method of MocLayer
Implements: isPickable

mocLayer.isType()

Kind: instance method of MocLayer
Implements: isType

mocLayer.getServices()

Kind: instance method of MocLayer
Implements: getServices

mocLayer.getCoordinateSystem()

Kind: instance method of MocLayer
Implements: getCoordinateSystem

mocLayer._attach()

Kind: instance method of MocLayer
Implements: _attach

mocLayer._detach()

Kind: instance method of MocLayer
Implements: _detach

mocLayer.getBaseURl()

Kind: instance method of MocLayer
Implements: getBaseURl

mocLayer.getDataType()

Kind: instance method of MocLayer
Implements: getDataType

mocLayer.getFormat()

Kind: instance method of MocLayer
Implements: getFormat

mocLayer.isDeletable()

Kind: instance method of MocLayer
Implements: isDeletable

mocLayer.getColor()

Kind: instance method of MocLayer
Implements: getColor

mocLayer.getStyle()

Kind: instance method of MocLayer
Implements: getStyle

mocLayer.getAvailableServices()

Kind: instance method of MocLayer
Implements: getAvailableServices

Layer.OSMLayer ⇐ AbstractRasterLayer

A layer to display data coming from OpenStreetMap server. OpenStreetMap (OSM) is a collaborative project to create a free editable map of the world

Kind: static class of Layer
Extends: AbstractRasterLayer

• .OSMLayer ⇐ AbstractRasterLayer
  • new OSMLayer(options)
  • .getGlobe()
  • .getID()
  • .getName()
  • .getAttribution()
  • .getCopyrightUrl()
  • .getAck()
  • .getIcon()
  • .getDescription()
  • .isVisible()
  • .setVisible()
  • .getOpacity()
  • .setOpacity()
  • .getProperties()
  • .getType()
  • .isPickable()
  • .isType()
  • .getServices()
  • .getCoordinateSystem()
  • ._detach()
  • .getBaseURl()
  • .getDataType()
  • .getFormat()
  • .isDeletable()
  • .getColor()
  • .getStyle()
  • .getAvailableServices()

new OSMLayer(options)

Param	Type	Description
options	osm_configuration	OSM Configuration

osmLayer.getGlobe()

Kind: instance method of OSMLayer
Implements: getGlobe

osmLayer.getID()

Kind: instance method of OSMLayer
Implements: getID

osmLayer.getName()

Kind: instance method of OSMLayer
Implements: getName

osmLayer.getAttribution()

Kind: instance method of OSMLayer
Implements: getAttribution

osmLayer.getCopyrightUrl()

Kind: instance method of OSMLayer
Implements: getCopyrightUrl

osmLayer.getAck()

Kind: instance method of OSMLayer
Implements: getAck

osmLayer.getIcon()

Kind: instance method of OSMLayer
Implements: getIcon

osmLayer.getDescription()

Kind: instance method of OSMLayer
Implements: getDescription

osmLayer.isVisible()

Kind: instance method of OSMLayer
Implements: isVisible

osmLayer.setVisible()

Kind: instance method of OSMLayer
Implements: setVisible

osmLayer.getOpacity()

Kind: instance method of OSMLayer
Implements: getOpacity

osmLayer.setOpacity()

Kind: instance method of OSMLayer
Implements: setOpacity

osmLayer.getProperties()

Kind: instance method of OSMLayer
Implements: getProperties

osmLayer.getType()

Kind: instance method of OSMLayer
Implements: getType

osmLayer.isPickable()

Kind: instance method of OSMLayer
Implements: isPickable

osmLayer.isType()

Kind: instance method of OSMLayer
Implements: isType

osmLayer.getServices()

Kind: instance method of OSMLayer
Implements: getServices

osmLayer.getCoordinateSystem()

Kind: instance method of OSMLayer
Implements: getCoordinateSystem

osmLayer._detach()

Kind: instance method of OSMLayer
Implements: _detach

osmLayer.getBaseURl()

Kind: instance method of OSMLayer
Implements: getBaseURl

osmLayer.getDataType()

Kind: instance method of OSMLayer
Implements: getDataType

osmLayer.getFormat()

Kind: instance method of OSMLayer
Implements: getFormat

osmLayer.isDeletable()

Kind: instance method of OSMLayer
Implements: isDeletable

osmLayer.getColor()

Kind: instance method of OSMLayer
Implements: getColor

osmLayer.getStyle()

Kind: instance method of OSMLayer
Implements: getStyle

osmLayer.getAvailableServices()

Kind: instance method of OSMLayer
Implements: getAvailableServices

Layer.OpenSearchLayer ⇐ AbstractLayer

This layer draws an OpenSearch dynamic layer

Kind: static class of Layer
Extends: AbstractLayer

• .OpenSearchLayer ⇐ AbstractLayer
  • new OpenSearchLayer(options)
  • .getGlobe()
  • .getID()
  • .getName()
  • .getAttribution()
  • .getCopyrightUrl()
  • .getAck()
  • .getIcon()
  • .getDescription()
  • .isVisible()
  • .setVisible()
  • .getOpacity()
  • .setOpacity()
  • .getProperties()
  • .getType()
  • .isPickable()
  • .isType()
  • .getServices()
  • .getCoordinateSystem()
  • ._attach()
  • ._detach()
  • .getBaseURl()
  • .getDataType()
  • .getFormat()
  • .isDeletable()
  • .getColor()
  • .getStyle()
  • .getAvailableServices()

new OpenSearchLayer(options)

Param	Type	Default	Description
options	Object		Configuration properties for the layer. See AbstractLayer for base properties
options.serviceUrl	String		Url of OpenSearch description XML file
[options.minOrder]	int	5	Starting order for OpenSearch requests
[options.maxRequests]	int	2	Max request
[options.invertY]	Boolean	false	a boolean, if set all the image data of current layer is flipped along the vertical axis
[options.coordSystemRequired]	Boolean	true
[options.style]	FeatureStyle	new FeatureStyle()

openSearchLayer.getGlobe()

Kind: instance method of OpenSearchLayer
Implements: getGlobe

openSearchLayer.getID()

Kind: instance method of OpenSearchLayer
Implements: getID

openSearchLayer.getName()

Kind: instance method of OpenSearchLayer
Implements: getName

openSearchLayer.getAttribution()

Kind: instance method of OpenSearchLayer
Implements: getAttribution

openSearchLayer.getCopyrightUrl()

Kind: instance method of OpenSearchLayer
Implements: getCopyrightUrl

openSearchLayer.getAck()

Kind: instance method of OpenSearchLayer
Implements: getAck

openSearchLayer.getIcon()

Kind: instance method of OpenSearchLayer
Implements: getIcon

openSearchLayer.getDescription()

Kind: instance method of OpenSearchLayer
Implements: getDescription

openSearchLayer.isVisible()

Kind: instance method of OpenSearchLayer
Implements: isVisible

openSearchLayer.setVisible()

Kind: instance method of OpenSearchLayer
Implements: setVisible

openSearchLayer.getOpacity()

Kind: instance method of OpenSearchLayer
Implements: getOpacity

openSearchLayer.setOpacity()

Kind: instance method of OpenSearchLayer
Implements: setOpacity

openSearchLayer.getProperties()

Kind: instance method of OpenSearchLayer
Implements: getProperties

openSearchLayer.getType()

Kind: instance method of OpenSearchLayer
Implements: getType

openSearchLayer.isPickable()

Kind: instance method of OpenSearchLayer
Implements: isPickable

openSearchLayer.isType()

Kind: instance method of OpenSearchLayer
Implements: isType

openSearchLayer.getServices()

Kind: instance method of OpenSearchLayer
Implements: getServices

openSearchLayer.getCoordinateSystem()

Kind: instance method of OpenSearchLayer
Implements: getCoordinateSystem

openSearchLayer._attach()

Kind: instance method of OpenSearchLayer
Implements: _attach

openSearchLayer._detach()

Kind: instance method of OpenSearchLayer
Implements: _detach

openSearchLayer.getBaseURl()

Kind: instance method of OpenSearchLayer
Implements: getBaseURl

openSearchLayer.getDataType()

Kind: instance method of OpenSearchLayer
Implements: getDataType

openSearchLayer.getFormat()

Kind: instance method of OpenSearchLayer
Implements: getFormat

openSearchLayer.isDeletable()

Kind: instance method of OpenSearchLayer
Implements: isDeletable

openSearchLayer.getColor()

Kind: instance method of OpenSearchLayer
Implements: getColor

openSearchLayer.getStyle()

Kind: instance method of OpenSearchLayer
Implements: getStyle

openSearchLayer.getAvailableServices()

Kind: instance method of OpenSearchLayer
Implements: getAvailableServices

Layer.PlanetLayer

Kind: static class of Layer

new PlanetLayer(options)

Planet layer.

Param	Type	Description
options	AbstractLayer	See for base properties
options.elevation	Object

Layer.TileWireframeLayer ⇐ AbstractLayer

This layer draws an TileWireframe layer

Kind: static class of Layer
Extends: AbstractLayer

• .TileWireframeLayer ⇐ AbstractLayer
  • new TileWireframeLayer(options)
  • .getGlobe()
  • .getID()
  • .getName()
  • .getAttribution()
  • .getCopyrightUrl()
  • .getAck()
  • .getIcon()
  • .getDescription()
  • .isVisible()
  • .setVisible()
  • .getOpacity()
  • .setOpacity()
  • .getProperties()
  • .getType()
  • .isPickable()
  • .isType()
  • .getServices()
  • .getCoordinateSystem()
  • ._attach()
  • ._detach()
  • .getBaseURl()
  • .getDataType()
  • .getFormat()
  • .isDeletable()
  • .getColor()
  • .getStyle()
  • .getAvailableServices()

new TileWireframeLayer(options)

Param	Type	Description
options	tileWireFrame_configuration	TileWireFrame configuration

tileWireframeLayer.getGlobe()

Kind: instance method of TileWireframeLayer
Implements: getGlobe

tileWireframeLayer.getID()

Kind: instance method of TileWireframeLayer
Implements: getID

tileWireframeLayer.getName()

Kind: instance method of TileWireframeLayer
Implements: getName

tileWireframeLayer.getAttribution()

Kind: instance method of TileWireframeLayer
Implements: getAttribution

tileWireframeLayer.getCopyrightUrl()

Kind: instance method of TileWireframeLayer
Implements: getCopyrightUrl

tileWireframeLayer.getAck()

Kind: instance method of TileWireframeLayer
Implements: getAck

tileWireframeLayer.getIcon()

Kind: instance method of TileWireframeLayer
Implements: getIcon

tileWireframeLayer.getDescription()

Kind: instance method of TileWireframeLayer
Implements: getDescription

tileWireframeLayer.isVisible()

Kind: instance method of TileWireframeLayer
Implements: isVisible

tileWireframeLayer.setVisible()

Kind: instance method of TileWireframeLayer
Implements: setVisible

tileWireframeLayer.getOpacity()

Kind: instance method of TileWireframeLayer
Implements: getOpacity

tileWireframeLayer.setOpacity()

Kind: instance method of TileWireframeLayer
Implements: setOpacity

tileWireframeLayer.getProperties()

Kind: instance method of TileWireframeLayer
Implements: getProperties

tileWireframeLayer.getType()

Kind: instance method of TileWireframeLayer
Implements: getType

tileWireframeLayer.isPickable()

Kind: instance method of TileWireframeLayer
Implements: isPickable

tileWireframeLayer.isType()

Kind: instance method of TileWireframeLayer
Implements: isType

tileWireframeLayer.getServices()

Kind: instance method of TileWireframeLayer
Implements: getServices

tileWireframeLayer.getCoordinateSystem()

Kind: instance method of TileWireframeLayer
Implements: getCoordinateSystem

tileWireframeLayer._attach()

Kind: instance method of TileWireframeLayer
Implements: _attach

tileWireframeLayer._detach()

Kind: instance method of TileWireframeLayer
Implements: _detach

tileWireframeLayer.getBaseURl()

Kind: instance method of TileWireframeLayer
Implements: getBaseURl

tileWireframeLayer.getDataType()

Kind: instance method of TileWireframeLayer
Implements: getDataType

tileWireframeLayer.getFormat()

Kind: instance method of TileWireframeLayer
Implements: getFormat

tileWireframeLayer.isDeletable()

Kind: instance method of TileWireframeLayer
Implements: isDeletable

tileWireframeLayer.getColor()

Kind: instance method of TileWireframeLayer
Implements: getColor

tileWireframeLayer.getStyle()

Kind: instance method of TileWireframeLayer
Implements: getStyle

tileWireframeLayer.getAvailableServices()

Kind: instance method of TileWireframeLayer
Implements: getAvailableServices

Layer.VectorLayer ⇐ AbstractLayer

Create a layer to display vector data in GeoJSON format.

Kind: static class of Layer
Extends: AbstractLayer

• .VectorLayer ⇐ AbstractLayer
  • new VectorLayer(options)
  • .getGlobe()
  • .getID()
  • .getName()
  • .getAttribution()
  • .getCopyrightUrl()
  • .getAck()
  • .getIcon()
  • .getDescription()
  • .isVisible()
  • .setVisible()
  • .getOpacity()
  • .setOpacity()
  • .getProperties()
  • .getType()
  • .isPickable()
  • .isType()
  • .getServices()
  • .getCoordinateSystem()
  • ._attach()
  • ._detach()
  • .getBaseURl()
  • .getDataType()
  • .getFormat()
  • .isDeletable()
  • .getColor()
  • .getStyle()
  • .getAvailableServices()

new VectorLayer(options)

Param	Type	Description
options	vector_configuration	Vector configuration

vectorLayer.getGlobe()

Kind: instance method of VectorLayer
Implements: getGlobe

vectorLayer.getID()

Kind: instance method of VectorLayer
Implements: getID

vectorLayer.getName()

Kind: instance method of VectorLayer
Implements: getName

vectorLayer.getAttribution()

Kind: instance method of VectorLayer
Implements: getAttribution

vectorLayer.getCopyrightUrl()

Kind: instance method of VectorLayer
Implements: getCopyrightUrl

vectorLayer.getAck()

Kind: instance method of VectorLayer
Implements: getAck

vectorLayer.getIcon()

Kind: instance method of VectorLayer
Implements: getIcon

vectorLayer.getDescription()

Kind: instance method of VectorLayer
Implements: getDescription

vectorLayer.isVisible()

Kind: instance method of VectorLayer
Implements: isVisible

vectorLayer.setVisible()

Kind: instance method of VectorLayer
Implements: setVisible

vectorLayer.getOpacity()

Kind: instance method of VectorLayer
Implements: getOpacity

vectorLayer.setOpacity()

Kind: instance method of VectorLayer
Implements: setOpacity

vectorLayer.getProperties()

Kind: instance method of VectorLayer
Implements: getProperties

vectorLayer.getType()

Kind: instance method of VectorLayer
Implements: getType

vectorLayer.isPickable()

Kind: instance method of VectorLayer
Implements: isPickable

vectorLayer.isType()

Kind: instance method of VectorLayer
Implements: isType

vectorLayer.getServices()

Kind: instance method of VectorLayer
Implements: getServices

vectorLayer.getCoordinateSystem()

Kind: instance method of VectorLayer
Implements: getCoordinateSystem

vectorLayer._attach()

Kind: instance method of VectorLayer
Implements: _attach

vectorLayer._detach()

Kind: instance method of VectorLayer
Implements: _detach

vectorLayer.getBaseURl()

Kind: instance method of VectorLayer
Implements: getBaseURl

vectorLayer.getDataType()

Kind: instance method of VectorLayer
Implements: getDataType

vectorLayer.getFormat()

Kind: instance method of VectorLayer
Implements: getFormat

vectorLayer.isDeletable()

Kind: instance method of VectorLayer
Implements: isDeletable

vectorLayer.getColor()

Kind: instance method of VectorLayer
Implements: getColor

vectorLayer.getStyle()

Kind: instance method of VectorLayer
Implements: getStyle

vectorLayer.getAvailableServices()

Kind: instance method of VectorLayer
Implements: getAvailableServices

Layer.WCSElevationLayer ⇐ AbstractRasterLayer

Create a layer for elevation data using WCS protocol based on a GeoTiling(4, 2) with a pixelSize = 33 by default. The only supported format is right now image/x-aaigrid. It is an ASCII format that is easily parsed in Javascript.

Kind: static class of Layer
Extends: AbstractRasterLayer

• .WCSElevationLayer ⇐ AbstractRasterLayer
  • new WCSElevationLayer(options)
  • .getGlobe()
  • .getID()
  • .getName()
  • .getAttribution()
  • .getCopyrightUrl()
  • .getAck()
  • .getIcon()
  • .getDescription()
  • .isVisible()
  • .setVisible()
  • .getOpacity()
  • .setOpacity()
  • .getProperties()
  • .getType()
  • .isPickable()
  • .isType()
  • .getServices()
  • .getCoordinateSystem()
  • ._detach()
  • .getBaseURl()
  • .getDataType()
  • .getFormat()
  • .isDeletable()
  • .getColor()
  • .getStyle()
  • .getAvailableServices()

new WCSElevationLayer(options)

Param	Type	Description
options	AbstractLayer.wcsElevation_configuration	WCSElevation Configuration

wcsElevationLayer.getGlobe()

Kind: instance method of WCSElevationLayer
Implements: getGlobe

wcsElevationLayer.getID()

Kind: instance method of WCSElevationLayer
Implements: getID

wcsElevationLayer.getName()

Kind: instance method of WCSElevationLayer
Implements: getName

wcsElevationLayer.getAttribution()

Kind: instance method of WCSElevationLayer
Implements: getAttribution

wcsElevationLayer.getCopyrightUrl()

Kind: instance method of WCSElevationLayer
Implements: getCopyrightUrl

wcsElevationLayer.getAck()

Kind: instance method of WCSElevationLayer
Implements: getAck

wcsElevationLayer.getIcon()

Kind: instance method of WCSElevationLayer
Implements: getIcon

wcsElevationLayer.getDescription()

Kind: instance method of WCSElevationLayer
Implements: getDescription

wcsElevationLayer.isVisible()

Kind: instance method of WCSElevationLayer
Implements: isVisible

wcsElevationLayer.setVisible()

Kind: instance method of WCSElevationLayer
Implements: setVisible

wcsElevationLayer.getOpacity()

Kind: instance method of WCSElevationLayer
Implements: getOpacity

wcsElevationLayer.setOpacity()

Kind: instance method of WCSElevationLayer
Implements: setOpacity

wcsElevationLayer.getProperties()

Kind: instance method of WCSElevationLayer
Implements: getProperties

wcsElevationLayer.getType()

Kind: instance method of WCSElevationLayer
Implements: getType

wcsElevationLayer.isPickable()

Kind: instance method of WCSElevationLayer
Implements: isPickable

wcsElevationLayer.isType()

Kind: instance method of WCSElevationLayer
Implements: isType

wcsElevationLayer.getServices()

Kind: instance method of WCSElevationLayer
Implements: getServices

wcsElevationLayer.getCoordinateSystem()

Kind: instance method of WCSElevationLayer
Implements: getCoordinateSystem

wcsElevationLayer._detach()

Kind: instance method of WCSElevationLayer
Implements: _detach

wcsElevationLayer.getBaseURl()

Kind: instance method of WCSElevationLayer
Implements: getBaseURl

wcsElevationLayer.getDataType()

Kind: instance method of WCSElevationLayer
Implements: getDataType

wcsElevationLayer.getFormat()

Kind: instance method of WCSElevationLayer
Implements: getFormat

wcsElevationLayer.isDeletable()

Kind: instance method of WCSElevationLayer
Implements: isDeletable

wcsElevationLayer.getColor()

Kind: instance method of WCSElevationLayer
Implements: getColor

wcsElevationLayer.getStyle()

Kind: instance method of WCSElevationLayer
Implements: getStyle

wcsElevationLayer.getAvailableServices()

Kind: instance method of WCSElevationLayer
Implements: getAvailableServices

Layer.WMSElevationLayer ⇐ WMSLayer

Creates a layer for elevation data using WMS protocol based on a GeoTiling(4, 2) with a pixelSize = 33 by default. The only supported format is currently image/x-aaigrid.

Kind: static class of Layer
Extends: WMSLayer

• .WMSElevationLayer ⇐ WMSLayer
  • new WMSElevationLayer(options)
  • .getUrl(tile) ⇒ String
  • .getBaseURl()

new WMSElevationLayer(options)

Param	Type	Description
options	AbstractLayer.wmsElevation_configuration	WMSElevation configuration

wmsElevationLayer.getUrl(tile) ⇒ String

Returns the url for the given tile

Kind: instance method of WMSElevationLayer
Returns: String - Url

Param	Type	Description
tile	Tile	Tile

wmsElevationLayer.getBaseURl()

Kind: instance method of WMSElevationLayer

Layer.WMSLayer ⇐ AbstractRasterLayer

Creates a layer for imagery data using WMS (Web Map Service) protocol based on a GeoTiling(4, 2) with a pixelSize = 256 by default.
WMS provides a standard interface for requesting a geospatial map image. The standard guarantees that these images can all be overlaid on one another.

Example of a WMS request
http://example.com/wms?request=GetMap&service=WMS&version=1.1.1&layers=MyLayer &styles=population&srs=EPSG:4326&bbox=-145.15104058007,21.731919794922,-57.154894212888,58.961058642578& &width=780&height=330&format=image/png

Kind: static class of Layer
Extends: AbstractRasterLayer
See: WMS standard

• .WMSLayer ⇐ AbstractRasterLayer
  • new WMSLayer(options)
  • .getGlobe()
  • .getID()
  • .getName()
  • .getAttribution()
  • .getCopyrightUrl()
  • .getAck()
  • .getIcon()
  • .getDescription()
  • .isVisible()
  • .setVisible()
  • .getOpacity()
  • .setOpacity()
  • .getProperties()
  • .getType()
  • .isPickable()
  • .isType()
  • .getServices()
  • .getCoordinateSystem()
  • ._detach()
  • .getBaseURl()
  • .getDataType()
  • .getFormat()
  • .isDeletable()
  • .getColor()
  • .getStyle()
  • .getAvailableServices()

new WMSLayer(options)

Param	Type	Description
options	wms_configuration	WMS Configuration

wmsLayer.getGlobe()

Kind: instance method of WMSLayer
Implements: getGlobe

wmsLayer.getID()

Kind: instance method of WMSLayer
Implements: getID

wmsLayer.getName()

Kind: instance method of WMSLayer
Implements: getName

wmsLayer.getAttribution()

Kind: instance method of WMSLayer
Implements: getAttribution

wmsLayer.getCopyrightUrl()

Kind: instance method of WMSLayer
Implements: getCopyrightUrl

wmsLayer.getAck()

Kind: instance method of WMSLayer
Implements: getAck

wmsLayer.getIcon()

Kind: instance method of WMSLayer
Implements: getIcon

wmsLayer.getDescription()

Kind: instance method of WMSLayer
Implements: getDescription

wmsLayer.isVisible()

Kind: instance method of WMSLayer
Implements: isVisible

wmsLayer.setVisible()

Kind: instance method of WMSLayer
Implements: setVisible

wmsLayer.getOpacity()

Kind: instance method of WMSLayer
Implements: getOpacity

wmsLayer.setOpacity()

Kind: instance method of WMSLayer
Implements: setOpacity

wmsLayer.getProperties()

Kind: instance method of WMSLayer
Implements: getProperties

wmsLayer.getType()

Kind: instance method of WMSLayer
Implements: getType

wmsLayer.isPickable()

Kind: instance method of WMSLayer
Implements: isPickable

wmsLayer.isType()

Kind: instance method of WMSLayer
Implements: isType

wmsLayer.getServices()

Kind: instance method of WMSLayer
Implements: getServices

wmsLayer.getCoordinateSystem()

Kind: instance method of WMSLayer
Implements: getCoordinateSystem

wmsLayer._detach()

Kind: instance method of WMSLayer
Implements: _detach

wmsLayer.getBaseURl()

Kind: instance method of WMSLayer
Implements: getBaseURl

wmsLayer.getDataType()

Kind: instance method of WMSLayer
Implements: getDataType

wmsLayer.getFormat()

Kind: instance method of WMSLayer
Implements: getFormat

wmsLayer.isDeletable()

Kind: instance method of WMSLayer
Implements: isDeletable

wmsLayer.getColor()

Kind: instance method of WMSLayer
Implements: getColor

wmsLayer.getStyle()

Kind: instance method of WMSLayer
Implements: getStyle

wmsLayer.getAvailableServices()

Kind: instance method of WMSLayer
Implements: getAvailableServices

Layer.WMTSLayer ⇐ AbstractRasterLayer

Creates a layer for imagery data using WMTS protocol.
WMTS protocol provides tiles with a resolution of tilePixelSize
based on a GeoTiling(4, 2)

<br/ Example of a WMTS request: http://example.com/wmts?LAYER=MyLayer1,MyLayer2& EXCEPTIONS=text/xml&FORMAT=image/jpeg&SERVICE=WMTS& VERSION=1.0.0&REQUEST=GetTile&STYLE=normal& TILEMATRIXSET=PM&TILEMATRIX=18&TILEROW=90241&TILECOL=132877&

The parameters of a WMTS server are the following:

• TILEMATRIXSET: The name of pyramidal images
• TILEMATRIX: The name of the matrix that contains the tile
• TILEROW: The line number from the top left corner from the tile
• TILECOL: The column number from the top left corner from the tile

Kind: static class of Layer
Extends: AbstractRasterLayer
See

• WMTS standard
• SLD standard

Properties

Name	Type	Default	Description
tilePixelSize	int	256	tile in pixels
numberOfLevels	int	21	number of levels
version	string	""1.0.0""	WMS version
transparent	string
time	string		Time dimension
format	string	""image/png""	output image format

• .WMTSLayer ⇐ AbstractRasterLayer
  • new WMTSLayer(options)
  • .getGlobe()
  • .getID()
  • .getName()
  • .getAttribution()
  • .getCopyrightUrl()
  • .getAck()
  • .getIcon()
  • .getDescription()
  • .isVisible()
  • .setVisible()
  • .getOpacity()
  • .setOpacity()
  • .getProperties()
  • .getType()
  • .isPickable()
  • .isType()
  • .getServices()
  • .getCoordinateSystem()
  • ._detach()
  • .getBaseURl()
  • .getDataType()
  • .getFormat()
  • .isDeletable()
  • .getColor()
  • .getStyle()
  • .getAvailableServices()

new WMTSLayer(options)

Param	Type	Description
options	configuration	WMTS configuration

wmtsLayer.getGlobe()

Kind: instance method of WMTSLayer
Implements: getGlobe

wmtsLayer.getID()

Kind: instance method of WMTSLayer
Implements: getID

wmtsLayer.getName()

Kind: instance method of WMTSLayer
Implements: getName

wmtsLayer.getAttribution()

Kind: instance method of WMTSLayer
Implements: getAttribution

wmtsLayer.getCopyrightUrl()

Kind: instance method of WMTSLayer
Implements: getCopyrightUrl

wmtsLayer.getAck()

Kind: instance method of WMTSLayer
Implements: getAck

wmtsLayer.getIcon()

Kind: instance method of WMTSLayer
Implements: getIcon

wmtsLayer.getDescription()

Kind: instance method of WMTSLayer
Implements: getDescription

wmtsLayer.isVisible()

Kind: instance method of WMTSLayer
Implements: isVisible

wmtsLayer.setVisible()

Kind: instance method of WMTSLayer
Implements: setVisible

wmtsLayer.getOpacity()

Kind: instance method of WMTSLayer
Implements: getOpacity

wmtsLayer.setOpacity()

Kind: instance method of WMTSLayer
Implements: setOpacity

wmtsLayer.getProperties()

Kind: instance method of WMTSLayer
Implements: getProperties

wmtsLayer.getType()

Kind: instance method of WMTSLayer
Implements: getType

wmtsLayer.isPickable()

Kind: instance method of WMTSLayer
Implements: isPickable

wmtsLayer.isType()

Kind: instance method of WMTSLayer
Implements: isType

wmtsLayer.getServices()

Kind: instance method of WMTSLayer
Implements: getServices

wmtsLayer.getCoordinateSystem()

Kind: instance method of WMTSLayer
Implements: getCoordinateSystem

wmtsLayer._detach()

Kind: instance method of WMTSLayer
Implements: _detach

wmtsLayer.getBaseURl()

Kind: instance method of WMTSLayer
Implements: getBaseURl

wmtsLayer.getDataType()

Kind: instance method of WMTSLayer
Implements: getDataType

wmtsLayer.getFormat()

Kind: instance method of WMTSLayer
Implements: getFormat

wmtsLayer.isDeletable()

Kind: instance method of WMTSLayer
Implements: isDeletable

wmtsLayer.getColor()

Kind: instance method of WMTSLayer
Implements: getColor

wmtsLayer.getStyle()

Kind: instance method of WMTSLayer
Implements: getStyle

wmtsLayer.getAvailableServices()

Kind: instance method of WMTSLayer
Implements: getAvailableServices

Navigation

Mizar owns different types of navigation to control the camera on the WebGL scene.

	[AstroNavigation](#module_Navigation.AstroNavigation)	Provides a camera located at the center of the scene. The camera is inside the globe. It is used to view the sky
	[PlanetNavigation](#module_Navigation.PlanetNavigation)	Provides a camera, located outside the globe and looking at the globe. It is used to view a planet
	[FlatNavigation](#module_Navigation.FlatNavigation)	Provides a camera to navigate on a 2D map - Only available in a Planet context

The camera is automatically instantiated by the context AbstractContext, which is created by client. Usually, the navigation is in 3D (AstroNavigation or PlanetNavigation). However, in a particular case, when the client selects a Coordinate Reference System with a projection, the FlatNavigation is selected.

Then the client can control the navigation by its interface

In addition, the navigation is controlled by the user with the help of devices : keyboard, touch, mouse. When creating the Mizar instance, the user can define a list of supported devices to be able to control the navigation by these devices. By default, the [MouseNavigationHandler](#module_Navigation.MouseNavigationHandler) and [KeyboardNavigationHandler](#module_Navigation.KeyboardNavigationHandler) are set up. When the parameter isMobile is set to true in [Mizar](#Mizar) options, then the [TouchNavigationHandler](#module_Navigation.TouchNavigationHandler) is set up

Implements: Navigation
Todo

• Créer un tuto pour montrer les principales méthodes de Navigation et le changement de 3D <--> 2D

• Navigation
  • .AstroNavigation ⇐ AbstractNavigation
    • new AstroNavigation(ctx, options)
    • .getType() ⇒ string
    • .getOptions() ⇒ Object
    • .start()
    • .stop()
    • .stopAnimations()
    • .getFov() ⇒ Array.<float>
    • .getCenter() ⇒ Array.<float>
    • .rotate(dx, dy)
    • .pan(dx, dy)
    • .zoom(delta, scale)
    • .zoomTo(geoPos, options)
    • .computeViewMatrix()
    • .toViewMatrix(mat, fov, duration, callback)
    • .getRenderContext() ⇒ RenderContext
    • .setRenderContext(renderContext)
  • .FlatNavigation ⇐ AbstractNavigation
    • new FlatNavigation(ctx, options)
    • .getType() ⇒ string
    • .getOptions() ⇒ Object
    • .start()
    • .stop()
    • .stopAnimations()
    • .getFov() ⇒ Array.<float>
    • .getCenter() ⇒ Array.<float>
    • .rotate(dx, dy)
    • .pan(dx, dy)
    • .zoom(delta, scale)
    • .zoomTo(geoPos, options)
    • .computeViewMatrix()
    • .toViewMatrix(mat, fov, duration, callback)
    • .getRenderContext() ⇒ RenderContext
    • .setRenderContext(renderContext)
  • .GoogleMouseNavigationHandler
    • new GoogleMouseNavigationHandler(options)
  • .KeyboardNavigationHandler
    • new KeyboardNavigationHandler(options)
  • .MouseNavigationHandler
    • new MouseNavigationHandler(options)
  • .NavigationFactory
    • .create(type, ctx, options) ⇒ Navigation
  • .NavigationHandlerFactory
    • .create(type, options) ⇒ Object
  • .PlanetNavigation ⇐ AbstractNavigation
    • new PlanetNavigation(ctx, options)
    • .getType() ⇒ string
    • .getOptions() ⇒ Object
    • .start()
    • .stop()
    • .stopAnimations()
    • .getFov() ⇒ Array.<float>
    • .getCenter() ⇒ Array.<float>
    • .rotate(dx, dy)
    • .pan(dx, dy)
    • .zoom(delta, scale)
    • .zoomTo(geoPos, options)
    • .computeViewMatrix()
    • .toViewMatrix(mat, fov, duration, callback)
    • .getRenderContext() ⇒ RenderContext
    • .setRenderContext(renderContext)
  • .TouchNavigationHandler
    • new TouchNavigationHandler(options)

Navigation.AstroNavigation ⇐ AbstractNavigation

Provides a camera located at the center of the scene. The camera is inside the globe. It is used to view the sky.

When an initFov is provided out the range [minFov, maxFov], the range [minFov, maxFov] is updated with the value of initFov.

Kind: static class of Navigation
Extends: AbstractNavigation

• .AstroNavigation ⇐ AbstractNavigation
  • new AstroNavigation(ctx, options)
  • .getType() ⇒ string
  • .getOptions() ⇒ Object
  • .start()
  • .stop()
  • .stopAnimations()
  • .getFov() ⇒ Array.<float>
  • .getCenter() ⇒ Array.<float>
  • .rotate(dx, dy)
  • .pan(dx, dy)
  • .zoom(delta, scale)
  • .zoomTo(geoPos, options)
  • .computeViewMatrix()
  • .toViewMatrix(mat, fov, duration, callback)
  • .getRenderContext() ⇒ RenderContext
  • .setRenderContext(renderContext)

new AstroNavigation(ctx, options)

Param	Type	Description
ctx	SkyContext	Sky context
options	astro_configuration	navigation configuration

astroNavigation.getType() ⇒ string

Returns the type of navigation. The type can take one of the following value : AstroNavigation, FlatNavigation, PlanetNavigation

Kind: instance method of AstroNavigation
Implements: getType
Returns: string - the name of the navigation class, which is used

astroNavigation.getOptions() ⇒ Object

Returns the navigation's options given at the initialisation.

Kind: instance method of AstroNavigation
Implements: getOptions
Returns: Object - Options

astroNavigation.start()

Starts the navigation.

Kind: instance method of AstroNavigation
Implements: start

astroNavigation.stop()

Stops the navigation.

Kind: instance method of AstroNavigation
Implements: stop

astroNavigation.stopAnimations()

Stops the animations.

Kind: instance method of AstroNavigation
Implements: stopAnimations

astroNavigation.getFov() ⇒ Array.<float>

Returns the field of view in decimal degree.

Kind: instance method of AstroNavigation
Implements: getFov
Returns: Array.<float> - the Field of view [fov along width, fov along height]

astroNavigation.getCenter() ⇒ Array.<float>

Returns the center of the field of view.

Kind: instance method of AstroNavigation
Implements: getCenter
Returns: Array.<float> - the center in decimal degree of the field of view [longitude, latitude]

astroNavigation.rotate(dx, dy)

Rotates the camera.

Kind: instance abstract method of AstroNavigation
Implements: rotate

Param	Type	Description
dx	float	Window delta x
dy	float	Window delta y

astroNavigation.pan(dx, dy)

Pans the camera to a direction up/down or left/right with the same distance from the object

Kind: instance abstract method of AstroNavigation
Implements: pan

Param	Type	Description
dx	float	Window direction left/right
dy	float	Window direction up/down

astroNavigation.zoom(delta, scale)

Applies zooming.

Kind: instance abstract method of AstroNavigation
Implements: zoom

Param	Type	Description
delta	float	Delta zoom
scale	float	Scale

astroNavigation.zoomTo(geoPos, options)

Zooms to a 2D position (longitude, latitude).

Kind: instance abstract method of AstroNavigation
Implements: zoomTo

Param	Type	Description
geoPos	Array.<float>	spatial position in decimal degree [longitude, latitude]
options	Object	options for zoomTo

astroNavigation.computeViewMatrix()

Computes the view matrix

Kind: instance abstract method of AstroNavigation
Implements: computeViewMatrix

astroNavigation.toViewMatrix(mat, fov, duration, callback)

Basic animation from current view matrix to the given one

Kind: instance method of AstroNavigation
Implements: toViewMatrix

Param	Type	Description
mat	Array.<Object>	Destination view matrix (array of 16)
fov	int	Final zooming fov in degrees
duration	int	Duration of animation in milliseconds
callback	navigationCallback	Callback at the end of animation

astroNavigation.getRenderContext() ⇒ RenderContext

Returns the rendering context.

Kind: instance method of AstroNavigation
Implements: getRenderContext
Returns: RenderContext - the rendering context

astroNavigation.setRenderContext(renderContext)

Sets the rendering context

Kind: instance method of AstroNavigation
Implements: setRenderContext

Param	Type	Description
renderContext	RenderContext	the rendering context to set

Navigation.FlatNavigation ⇐ AbstractNavigation

Provides a camera to navigate on a 2D map - Only available in a Planet context

Kind: static class of Navigation
Extends: AbstractNavigation

• .FlatNavigation ⇐ AbstractNavigation
  • new FlatNavigation(ctx, options)
  • .getType() ⇒ string
  • .getOptions() ⇒ Object
  • .start()
  • .stop()
  • .stopAnimations()
  • .getFov() ⇒ Array.<float>
  • .getCenter() ⇒ Array.<float>
  • .rotate(dx, dy)
  • .pan(dx, dy)
  • .zoom(delta, scale)
  • .zoomTo(geoPos, options)
  • .computeViewMatrix()
  • .toViewMatrix(mat, fov, duration, callback)
  • .getRenderContext() ⇒ RenderContext
  • .setRenderContext(renderContext)

new FlatNavigation(ctx, options)

Param	Type	Description
ctx	PlanetContext	Planet context
options	flat_configuration	Flat navigation configuration

flatNavigation.getType() ⇒ string

Returns the type of navigation. The type can take one of the following value : AstroNavigation, FlatNavigation, PlanetNavigation

Kind: instance method of FlatNavigation
Implements: getType
Returns: string - the name of the navigation class, which is used

flatNavigation.getOptions() ⇒ Object

Returns the navigation's options given at the initialisation.

Kind: instance method of FlatNavigation
Implements: getOptions
Returns: Object - Options

flatNavigation.start()

Starts the navigation.

Kind: instance method of FlatNavigation
Implements: start

flatNavigation.stop()

Stops the navigation.

Kind: instance method of FlatNavigation
Implements: stop

flatNavigation.stopAnimations()

Stops the animations.

Kind: instance method of FlatNavigation
Implements: stopAnimations

flatNavigation.getFov() ⇒ Array.<float>

Returns the field of view in decimal degree.

Kind: instance method of FlatNavigation
Implements: getFov
Returns: Array.<float> - the Field of view [fov along width, fov along height]

flatNavigation.getCenter() ⇒ Array.<float>

Returns the center of the field of view.

Kind: instance method of FlatNavigation
Implements: getCenter
Returns: Array.<float> - the center in decimal degree of the field of view [longitude, latitude]

flatNavigation.rotate(dx, dy)

Rotates the camera.

Kind: instance abstract method of FlatNavigation
Implements: rotate

Param	Type	Description
dx	float	Window delta x
dy	float	Window delta y

flatNavigation.pan(dx, dy)

Pans the camera to a direction up/down or left/right with the same distance from the object

Kind: instance abstract method of FlatNavigation
Implements: pan

Param	Type	Description
dx	float	Window direction left/right
dy	float	Window direction up/down

flatNavigation.zoom(delta, scale)

Applies zooming.

Kind: instance abstract method of FlatNavigation
Implements: zoom

Param	Type	Description
delta	float	Delta zoom
scale	float	Scale

flatNavigation.zoomTo(geoPos, options)

Zooms to a 2D position (longitude, latitude).

Kind: instance abstract method of FlatNavigation
Implements: zoomTo

Param	Type	Description
geoPos	Array.<float>	spatial position in decimal degree [longitude, latitude]
options	Object	options for zoomTo

flatNavigation.computeViewMatrix()

Computes the view matrix

Kind: instance abstract method of FlatNavigation
Implements: computeViewMatrix

flatNavigation.toViewMatrix(mat, fov, duration, callback)

Basic animation from current view matrix to the given one

Kind: instance method of FlatNavigation
Implements: toViewMatrix

Param	Type	Description
mat	Array.<Object>	Destination view matrix (array of 16)
fov	int	Final zooming fov in degrees
duration	int	Duration of animation in milliseconds
callback	navigationCallback	Callback at the end of animation

flatNavigation.getRenderContext() ⇒ RenderContext

Returns the rendering context.

Kind: instance method of FlatNavigation
Implements: getRenderContext
Returns: RenderContext - the rendering context

flatNavigation.setRenderContext(renderContext)

Sets the rendering context

Kind: instance method of FlatNavigation
Implements: setRenderContext

Param	Type	Description
renderContext	RenderContext	the rendering context to set

Navigation.GoogleMouseNavigationHandler

GoogleMouseNavigationHandler constructor

Kind: static class of Navigation

new GoogleMouseNavigationHandler(options)

Param	Type
options	googleMouse_configuration

Navigation.KeyboardNavigationHandler

KeyboardNavigationHandler constructor.
The keyboard shortcuts are the following :

• space bar : Stop all animations when an event is received
• + : zoom in the camera
• - : zoom out the camera
• Left arrow : pan the camera left
• shift + left arrow : rotate the camera counterclockwise
• Right arrow : pan the camera right
• shift + right arrow : rotate the camera clockwise
• Up arrow : pan the camera up
• shift + up arrow : rotate the camera up
• Down arrow : pan the camera down
• shift + down arrow : rotate the camera down

Kind: static class of Navigation

new KeyboardNavigationHandler(options)

Param	Type	Description
options	keyboard_configuration	Keyboard navigation configuration

Navigation.MouseNavigationHandler

Mouse_navigationHandler constructor.
The mouse movements are the following :

• Wheel up : zoom in the camera
• Wheel down : zoom out the camera
• Click left+Ri + left mouse : pan the camera right
• Wheel press + left mouse : rotate the camera counterclockwise
• Click left + right mouse : pan the camera left
• Wheel press + right arrow : rotate the camera clockwise
• Click left + up mouse : pan the camera down
• Wheel press + up mouse : rotate the camera down
• Click left + down mouse : pan the camera up
• Wheel press + down mouse : rotate the camera up

Kind: static class of Navigation

new MouseNavigationHandler(options)

Param	Type	Description
options	mouse_configuration	Mouse navigation configuration

Navigation.NavigationFactory

Factory to control the camera.

Kind: static class of Navigation

NavigationFactory.create(type, ctx, options) ⇒ Navigation

Mizar owns different types of navigation to control the camera on the WebGL scene. This class allows to create a navigation based on its type (e.g Astro, Flat, Sky).

	[AstroNavigation](#module_Navigation.AstroNavigation)	Provides a camera located at the center of the scene. The camera is inside the globe. It is used to view the sky
	[PlanetNavigation](#module_Navigation.PlanetNavigation)	Provides a camera, located outside the globe and looking at the globe. It is used to view a planet
	[FlatNavigation](#module_Navigation.FlatNavigation)	Provides a camera to navigate on a 2D map - Only available in a Planet context

Kind: static method of NavigationFactory
Returns: Navigation - navigation
Throws:

• RangeError Type not valid - a valid type is included in the list NAVIGATION

See

• PlanetNavigation - Control the camera and turn around the globe, wich is located at the center of the webGL scene.
• AstroNavigation - Control the camera at the center of the scene. The camera is inside the globe
• FlatNavigation - Control the camera. The camera look at the 2D projection

Param	Type	Description
type	NAVIGATION	the type of navigation
ctx	AbstractContext	The context where the camera look at
options	astro_configuration | planet_configuration | flat_configuration	see the navigations.

Navigation.NavigationHandlerFactory

Factory to create a device for the control of the camera.

Kind: static class of Navigation

NavigationHandlerFactory.create(type, options) ⇒ Object

Creates a specific navigation based on its type (e.g Astro, Flat, Sky).

Kind: static method of NavigationHandlerFactory
Returns: Object - one of the handler
Throws:

• RangeError Type not valid - a valid type is included in the list HANDLER

See

• GoogleMouseNavigationHandler - Control the camera with mouse as Google movement
• KeyboardNavigationHandler - Control the camera with the keyboard
• MouseNavigationHandler - Control the camera with the mouse
• TouchNavigationHandler - Control the camera with the smartphone

Param	Type	Description
type	HANDLER	the type of navigation
options	touch_configuration | mouse_configuration | googleMouse_configuration | keyboard_configuration	see the handlers.

Navigation.PlanetNavigation ⇐ AbstractNavigation

Provides a camera, located outside the globe and looking at the globe. It is used to view a planet

At initialisation, the distance of the camera is maxDistance

Kind: static class of Navigation
Extends: AbstractNavigation

• .PlanetNavigation ⇐ AbstractNavigation
  • new PlanetNavigation(ctx, options)
  • .getType() ⇒ string
  • .getOptions() ⇒ Object
  • .start()
  • .stop()
  • .stopAnimations()
  • .getFov() ⇒ Array.<float>
  • .getCenter() ⇒ Array.<float>
  • .rotate(dx, dy)
  • .pan(dx, dy)
  • .zoom(delta, scale)
  • .zoomTo(geoPos, options)
  • .computeViewMatrix()
  • .toViewMatrix(mat, fov, duration, callback)
  • .getRenderContext() ⇒ RenderContext
  • .setRenderContext(renderContext)

new PlanetNavigation(ctx, options)

Param	Type	Description
ctx	PlanetContext	Planet context
options	planet_configuration	Planet navigation configuration

planetNavigation.getType() ⇒ string

Returns the type of navigation. The type can take one of the following value : AstroNavigation, FlatNavigation, PlanetNavigation

Kind: instance method of PlanetNavigation
Implements: getType
Returns: string - the name of the navigation class, which is used

planetNavigation.getOptions() ⇒ Object

Returns the navigation's options given at the initialisation.

Kind: instance method of PlanetNavigation
Implements: getOptions
Returns: Object - Options

planetNavigation.start()

Starts the navigation.

Kind: instance method of PlanetNavigation
Implements: start

planetNavigation.stop()

Stops the navigation.

Kind: instance method of PlanetNavigation
Implements: stop

planetNavigation.stopAnimations()

Stops the animations.

Kind: instance method of PlanetNavigation
Implements: stopAnimations

planetNavigation.getFov() ⇒ Array.<float>

Returns the field of view in decimal degree.

Kind: instance method of PlanetNavigation
Implements: getFov
Returns: Array.<float> - the Field of view [fov along width, fov along height]

planetNavigation.getCenter() ⇒ Array.<float>

Returns the center of the field of view.

Kind: instance method of PlanetNavigation
Implements: getCenter
Returns: Array.<float> - the center in decimal degree of the field of view [longitude, latitude]

planetNavigation.rotate(dx, dy)

Rotates the camera.

Kind: instance abstract method of PlanetNavigation
Implements: rotate

Param	Type	Description
dx	float	Window delta x
dy	float	Window delta y

planetNavigation.pan(dx, dy)

Pans the camera to a direction up/down or left/right with the same distance from the object

Kind: instance abstract method of PlanetNavigation
Implements: pan

Param	Type	Description
dx	float	Window direction left/right
dy	float	Window direction up/down

planetNavigation.zoom(delta, scale)

Applies zooming.

Kind: instance abstract method of PlanetNavigation
Implements: zoom

Param	Type	Description
delta	float	Delta zoom
scale	float	Scale

planetNavigation.zoomTo(geoPos, options)

Zooms to a 2D position (longitude, latitude).

Kind: instance abstract method of PlanetNavigation
Implements: zoomTo

Param	Type	Description
geoPos	Array.<float>	spatial position in decimal degree [longitude, latitude]
options	Object	options for zoomTo

planetNavigation.computeViewMatrix()

Computes the view matrix

Kind: instance abstract method of PlanetNavigation
Implements: computeViewMatrix

planetNavigation.toViewMatrix(mat, fov, duration, callback)

Basic animation from current view matrix to the given one

Kind: instance method of PlanetNavigation
Implements: toViewMatrix

Param	Type	Description
mat	Array.<Object>	Destination view matrix (array of 16)
fov	int	Final zooming fov in degrees
duration	int	Duration of animation in milliseconds
callback	navigationCallback	Callback at the end of animation

planetNavigation.getRenderContext() ⇒ RenderContext

Returns the rendering context.

Kind: instance method of PlanetNavigation
Implements: getRenderContext
Returns: RenderContext - the rendering context

planetNavigation.setRenderContext(renderContext)

Sets the rendering context

Kind: instance method of PlanetNavigation
Implements: setRenderContext

Param	Type	Description
renderContext	RenderContext	the rendering context to set

Navigation.TouchNavigationHandler

TouchNavigationHandler constructor

Kind: static class of Navigation

new TouchNavigationHandler(options)

Param	Type	Description
options	touch_configuration	Touch navigation configuration

Projection

Mizar owns different types of projection, which is used to represent a planet on a 2D map.

	[AitoffProjection](#module_Projection.AitoffProjection)	Provides a AITOFF projection
	[AugustProjection](#module_Projection.AugustProjection)	Provides an august projection
	[AzimuthProjection](#module_Projection.AzimuthProjection)	Provides an azimuth projection
	[MercatorProjection](#module_Projection.MercatorProjection)	Provides a mercator projection
	[MollweideProjection](#module_Projection.MollweideProjection)	Provides a mollweide projection
	[PlateProjection](#module_Projection.PlateProjection)	Provides a plate carrée projection

The projection is automatically instantiated by the ProjectedCrs class.

Implements: Projection

• Projection
  • .AitoffProjection ⇐ AbstractProjection
    • new AitoffProjection([options])
    • .getProjectionCenter()
    • .getGeoBound()
    • .unProject()
    • .project()
  • .AugustProjection ⇐ AbstractProjection
    • new AugustProjection([options])
    • .getProjectionCenter()
    • .getGeoBound()
    • .unProject()
    • .project()
  • .AzimuthProjection ⇐ AbstractProjection
    • new AzimuthProjection([options])
    • .getProjectionCenter()
    • .getGeoBound()
    • .unProject()
    • .project()
  • .MercatorProjection ⇐ AbstractProjection
    • new MercatorProjection([options])
    • .getProjectionCenter()
    • .getGeoBound()
    • .unProject()
    • .project()
  • .MollweideProjection ⇐ AbstractProjection
    • new MollweideProjection([options])
    • .getProjectionCenter()
    • .getGeoBound()
    • .unProject()
    • .project()
  • .PlateProjection ⇐ AbstractProjection
    • new PlateProjection([options])
    • .getProjectionCenter()
    • .getGeoBound()
    • .unProject()
    • .project()
  • .ProjectionFactory
    • .create(options) ⇒ Projection

Projection.AitoffProjection ⇐ AbstractProjection

The Aitoff coordinate system is a coordinate reference system. It is composed of :

• a reference frame : the reference geoid, which is set as parameter of the options object,
• a projection : the Aitoff projection.

The Aitoff projection is a modified azimuthal map projection first proposed by David A. Aitoff in 1889. Based on the equatorial form of the azimuthal equidistant projection, Aitoff halved longitudes from the central meridian, projected by the azimuthal equidistant, and then stretched the result horizontally into a 2:1 ellipse.

Kind: static class of Projection
Extends: AbstractProjection
See: https://en.wikipedia.org/wiki/Aitoff_projection

• .AitoffProjection ⇐ AbstractProjection
  • new AitoffProjection([options])
  • .getProjectionCenter()
  • .getGeoBound()
  • .unProject()
  • .project()

new AitoffProjection([options])

Param	Type	Description
[options]	configuration	Aitoff projection configuration.

aitoffProjection.getProjectionCenter()

Kind: instance method of AitoffProjection
Implements: getProjectionCenter

aitoffProjection.getGeoBound()

Kind: instance method of AitoffProjection
Implements: getGeoBound

aitoffProjection.unProject()

Kind: instance abstract method of AitoffProjection
Implements: unProject

aitoffProjection.project()

Kind: instance abstract method of AitoffProjection
Implements: project

Projection.AugustProjection ⇐ AbstractProjection

The August coordinate system is a coordinate reference system. It is composed of :

• a reference frame : the reference geoid, which is set as parameter of the options object,
• a projection : the August projection.

Kind: static class of Projection
Extends: AbstractProjection

• .AugustProjection ⇐ AbstractProjection
  • new AugustProjection([options])
  • .getProjectionCenter()
  • .getGeoBound()
  • .unProject()
  • .project()

new AugustProjection([options])

Param	Type	Description
[options]	configuration	August projection configuration.

augustProjection.getProjectionCenter()

Kind: instance method of AugustProjection
Implements: getProjectionCenter

augustProjection.getGeoBound()

Kind: instance method of AugustProjection
Implements: getGeoBound

augustProjection.unProject()

Kind: instance abstract method of AugustProjection
Implements: unProject

augustProjection.project()

Kind: instance abstract method of AugustProjection
Implements: project

Projection.AzimuthProjection ⇐ AbstractProjection

The Azimuth coordinate system is a coordinate reference system. It is composed of :

• a reference frame : the reference geoid, which is set as parameter of the options object,
• a projection : the Azimuth projection.

Kind: static class of Projection
Extends: AbstractProjection
See: https://en.wikipedia.org/wiki/Azimuthal_equidistant_projection

• .AzimuthProjection ⇐ AbstractProjection
  • new AzimuthProjection([options])
  • .getProjectionCenter()
  • .getGeoBound()
  • .unProject()
  • .project()

new AzimuthProjection([options])

Param	Type	Description
[options]	azimuth_configuration	Azimuthal projection configuration.

azimuthProjection.getProjectionCenter()

Kind: instance method of AzimuthProjection
Implements: getProjectionCenter

azimuthProjection.getGeoBound()

Kind: instance method of AzimuthProjection
Implements: getGeoBound

azimuthProjection.unProject()

Kind: instance abstract method of AzimuthProjection
Implements: unProject

azimuthProjection.project()

Kind: instance abstract method of AzimuthProjection
Implements: project

Projection.MercatorProjection ⇐ AbstractProjection

The Mercator coordinate system is a coordinate reference system. It is composed of :

• a reference frame : the reference geoide, which is set as parameter of the options object,
• a projection : the Mercator projection.

The Mercator projection is a cylindrical map projection presented by the Flemish geographer and cartographer Gerardus Mercator in 1569. It became the standard map projection for nautical purposes because of its ability to represent lines of constant course

Kind: static class of Projection
Extends: AbstractProjection
See: https://en.wikipedia.org/wiki/Mercator_projection

• .MercatorProjection ⇐ AbstractProjection
  • new MercatorProjection([options])
  • .getProjectionCenter()
  • .getGeoBound()
  • .unProject()
  • .project()

new MercatorProjection([options])

Param	Type	Description
[options]	mercator_configuration	Mercator projection configuration.

mercatorProjection.getProjectionCenter()

Kind: instance method of MercatorProjection
Implements: getProjectionCenter

mercatorProjection.getGeoBound()

Kind: instance method of MercatorProjection
Implements: getGeoBound

mercatorProjection.unProject()

Kind: instance abstract method of MercatorProjection
Implements: unProject

mercatorProjection.project()

Kind: instance abstract method of MercatorProjection
Implements: project

Projection.MollweideProjection ⇐ AbstractProjection

The Mollweide coordinate system is a coordinate reference system. It is composed of :

• a reference frame : the reference geoid, which is set as parameter of the options object,
• a projection : the Mollweide projection.

The Mollweide projection is an equal-area, pseudocylindrical map projection generally used for global maps of the world or night sky.

Kind: static class of Projection
Extends: AbstractProjection
See: https://en.wikipedia.org/wiki/Mollweide_projection

• .MollweideProjection ⇐ AbstractProjection
  • new MollweideProjection([options])
  • .getProjectionCenter()
  • .getGeoBound()
  • .unProject()
  • .project()

new MollweideProjection([options])

Param	Type	Description
[options]	configuration	No options.

mollweideProjection.getProjectionCenter()

Kind: instance method of MollweideProjection
Implements: getProjectionCenter

mollweideProjection.getGeoBound()

Kind: instance method of MollweideProjection
Implements: getGeoBound

mollweideProjection.unProject()

Kind: instance abstract method of MollweideProjection
Implements: unProject

mollweideProjection.project()

Kind: instance abstract method of MollweideProjection
Implements: project

Projection.PlateProjection ⇐ AbstractProjection

The Plate coordinate system is a coordinate reference system. It is composed of :

• a reference frame : the reference geoid, which is set as parameter of the options object,
• a projection : the Plate carrée projection.

Kind: static class of Projection
Extends: AbstractProjection
See: https://en.wikipedia.org/wiki/Mollweide_projection

• .PlateProjection ⇐ AbstractProjection
  • new PlateProjection([options])
  • .getProjectionCenter()
  • .getGeoBound()
  • .unProject()
  • .project()

new PlateProjection([options])

Param	Type	Description
[options]	configuration	No options.

plateProjection.getProjectionCenter()

Kind: instance method of PlateProjection
Implements: getProjectionCenter

plateProjection.getGeoBound()

Kind: instance method of PlateProjection
Implements: getGeoBound

plateProjection.unProject()

Kind: instance abstract method of PlateProjection
Implements: unProject

plateProjection.project()

Kind: instance abstract method of PlateProjection
Implements: project

Projection.ProjectionFactory

Factory to create a projection

Kind: static class of Projection

ProjectionFactory.create(options) ⇒ Projection

Create a projection

Kind: static method of ProjectionFactory
Throws:

• RangeError Will throw when options.projectionName is not part of PROJECTION

Throw: ReferenceError Will throw when options.projectionName is not defined

Param	Type	Description
options	configuration | azimuth_configuration | mercator_configuration	Options.

Provider

Provider

Implements: Provider

• Provider
  • .AbstractProvider
    • new AbstractProvider(options)
  • .ConstellationProvider ⇐ AbstractProvider
    • new ConstellationProvider(options)
  • .CraterProvider ⇐ AbstractProvider
    • new CraterProvider(options)
  • .OpenSearchProvider ⇐ AbstractProvider
    • new OpenSearchProvider(options)
  • .PlanetProvider ⇐ AbstractProvider
    • new PlanetProvider(options)
  • .StarProvider ⇐ AbstractProvider
    • new StarProvider(options)

Provider.AbstractProvider

Abstract Provider constructor

Kind: static class of Provider

new AbstractProvider(options)

Param	Type
options	object

Provider.ConstellationProvider ⇐ AbstractProvider

ConstellationProvider context constructor

Kind: static class of Provider
Extends: AbstractProvider

new ConstellationProvider(options)

Param	Type
options	object

Provider.CraterProvider ⇐ AbstractProvider

Displays the name of the crater

Kind: static class of Provider
Extends: AbstractProvider

new CraterProvider(options)

Param	Type
options	object

Provider.OpenSearchProvider ⇐ AbstractProvider

OpenSearchProvider context constructor

Kind: static class of Provider
Extends: AbstractProvider

new OpenSearchProvider(options)

Param	Type
options	object

Provider.PlanetProvider ⇐ AbstractProvider

Providing planet positions based on ephemeris computations

Kind: static class of Provider
Extends: AbstractProvider
See: http://www.abecedarical.com/javascript/script_planet_orbits.html

new PlanetProvider(options)

Param	Type
options	Object

Provider.StarProvider ⇐ AbstractProvider

Specific star catalogue provider of the Brightest Stars (Ochsenbein+ 1988) from VizieR database

Kind: static class of Provider
Extends: AbstractProvider
See: Search Catalogue of the Brightest Stars (Ochsenbein+ 1988) in VizieR database for more details

new StarProvider(options)

Param	Type
options	object

ReverseNameResolver

Reverse Name resolver module : API allowing to retrieve information from a geo picking

Implements: ReverseNameResolver

• ReverseNameResolver
  • .CDSReverseNameResolver ⇐ AbstractReverseNameResolver
    • new CDSReverseNameResolver(options)
    • .handle()
    • .remove()
  • .DefaultReverseNameResolver ⇐ AbstractReverseNameResolver
    • new DefaultReverseNameResolver(options)
    • .handle()
    • .remove()

ReverseNameResolver.CDSReverseNameResolver ⇐ AbstractReverseNameResolver

Plugin to access to CDS reverse name resolver

Kind: static class of ReverseNameResolver
Extends: AbstractReverseNameResolver

• .CDSReverseNameResolver ⇐ AbstractReverseNameResolver
  • new CDSReverseNameResolver(options)
  • .handle()
  • .remove()

new CDSReverseNameResolver(options)

Param	Type	Description
options	Context	Context

cdsReverseNameResolver.handle()

Kind: instance abstract method of CDSReverseNameResolver

cdsReverseNameResolver.remove()

Kind: instance abstract method of CDSReverseNameResolver

ReverseNameResolver.DefaultReverseNameResolver ⇐ AbstractReverseNameResolver

Plugin to access to Default reverse name resolver

Kind: static class of ReverseNameResolver
Extends: AbstractReverseNameResolver

• .DefaultReverseNameResolver ⇐ AbstractReverseNameResolver
  • new DefaultReverseNameResolver(options)
  • .handle()
  • .remove()

new DefaultReverseNameResolver(options)

Param	Type	Description
options	Context	Context

defaultReverseNameResolver.handle()

Kind: instance abstract method of DefaultReverseNameResolver

defaultReverseNameResolver.remove()

Kind: instance abstract method of DefaultReverseNameResolver

NameResolver

Name resolver module : API allowing to search object name and zoom to it

Implements: NameResolver

• NameResolver
  • .CDSNameResolver ⇐ AbstractNameResolver
    • new CDSNameResolver(options)
    • .handle()
    • .remove()
  • .DefaultNameResolver ⇐ AbstractNameResolver
    • new DefaultNameResolver(options)
    • .handle()
    • .remove()
  • .DictionaryNameResolver ⇐ AbstractNameResolver
    • new DictionaryNameResolver(options)
    • .handle()
    • .remove()
  • .IMCCENameResolver ⇐ AbstractNameResolver
    • new IMCCENameResolver(options)
    • .handle()
    • .remove()
  • .NameResolver
    • .goTo
    • .zoomTo
    • .init(m)
    • .remove()
    • .setContext()

NameResolver.CDSNameResolver ⇐ AbstractNameResolver

Plugin to access to CDS name resolver

Kind: static class of NameResolver
Extends: AbstractNameResolver

• .CDSNameResolver ⇐ AbstractNameResolver
  • new CDSNameResolver(options)
  • .handle()
  • .remove()

new CDSNameResolver(options)

Param	Type	Description
options	Context	Context

cdsNameResolver.handle()

Kind: instance abstract method of CDSNameResolver

cdsNameResolver.remove()

Kind: instance abstract method of CDSNameResolver

NameResolver.DefaultNameResolver ⇐ AbstractNameResolver

Plugin to access to default name resolver

Kind: static class of NameResolver
Extends: AbstractNameResolver

• .DefaultNameResolver ⇐ AbstractNameResolver
  • new DefaultNameResolver(options)
  • .handle()
  • .remove()

new DefaultNameResolver(options)

Param	Type	Description
options	Context	Context

defaultNameResolver.handle()

Kind: instance abstract method of DefaultNameResolver

defaultNameResolver.remove()

Kind: instance abstract method of DefaultNameResolver

NameResolver.DictionaryNameResolver ⇐ AbstractNameResolver

Plugin to access to the dictionary name resolver

Kind: static class of NameResolver
Extends: AbstractNameResolver

• .DictionaryNameResolver ⇐ AbstractNameResolver
  • new DictionaryNameResolver(options)
  • .handle()
  • .remove()

new DictionaryNameResolver(options)

Param	Type	Description
options	Context	Configuration properties

dictionaryNameResolver.handle()

Kind: instance abstract method of DictionaryNameResolver

dictionaryNameResolver.remove()

Kind: instance abstract method of DictionaryNameResolver

NameResolver.IMCCENameResolver ⇐ AbstractNameResolver

Plugin to access to IMCCE name resolver

Kind: static class of NameResolver
Extends: AbstractNameResolver

• .IMCCENameResolver ⇐ AbstractNameResolver
  • new IMCCENameResolver(options)
  • .handle()
  • .remove()

new IMCCENameResolver(options)

Param	Type	Description
options	Context	Context

imcceNameResolver.handle()

Kind: instance abstract method of IMCCENameResolver

imcceNameResolver.remove()

Kind: instance abstract method of IMCCENameResolver

NameResolver.NameResolver

Name resolver

Kind: static class of NameResolver

• .NameResolver
  • .goTo
  • .zoomTo
  • .init(m)
  • .remove()
  • .setContext()

NameResolver.goTo

Search for object name Object name could be:

• Degree in "HMS DMS" or "deg deg"
• Object name as "Mars", "m31", "Mizar"
• For debug : healpix(order,pixelIndex)

Kind: static property of NameResolver
Emits: Mizar#plugin:not_found

NameResolver.zoomTo

Zoom to the given longitude/latitude and add target at the end

Kind: static property of NameResolver

Param	Description
lon	Longitude
lat	Latitude
crs	coordinate reference system of the (longitude, latitude)
callback	Callback once animation is over
args	Callback arguments

NameResolver.init(m)

Init name resolver

Kind: static method of NameResolver

Param	Type	Description
m	Mizar	Mizar API

NameResolver.remove()

Unregisters all event handlers

Kind: static method of NameResolver

NameResolver.setContext()

Set context

Kind: static method of NameResolver

Animation

Animation is an interface to handle animations through a Globe.
Mizar is able to create different types of animation on a globe :

• [InertiaAnimation](#module_Animation.InertiaAnimation) : Animation simulating inertia for camera navigation
• [InterpolatedAnimation](#module_Animation.InterpolatedAnimation) : Generic animation to interpolate arbitrary values
• [PathAnimation](#module_Animation.PathAnimation) : Animation defined with a path
• [SegmentedAnimation](#module_Animation.SegmentedAnimation) : Animation defined with segments

Kind: global interface
See: the animation package

• Animation
  • .getRenderContext() ⇒ RenderContext | null
  • .getStatus() ⇒ ANIMATION_STATUS
  • .start()
  • .pause()
  • .stop()

animation.getRenderContext() ⇒ RenderContext | null

Returns the rendering context.

Kind: instance method of Animation
Returns: RenderContext | null - the rendering context

animation.getStatus() ⇒ ANIMATION_STATUS

Returns the status of the animation.

Kind: instance method of Animation

animation.start()

Starts the animation, records the start time in startTime member and registers the animation.

Kind: instance method of Animation

animation.pause()

Pauses the animation.

Kind: instance method of Animation

animation.stop()

Stops the animation and unregisters the animation.#

Kind: instance method of Animation

Context

Context is an interface to handle a context, which allows Mizar :

• to handle a [Globe](#Globe)
• to handle a [coordinate reference system](#Crs)
• to handle a [Animation](#Animation)
• to handle the graphical components

Mizar owns different contexts:

	[SkyContext](#module_Context.SkyContext)	A context representing a sky
	[PlanetContext](#module_Context.PlanetContext)	A context representing a planet

In addition to the two contexts, the client can define two sub-contexts :

• The planet without backgound
• The planet with the sky background

In addition to the classes, a factory is available to help for creating context. Once the context is created, the client can handle it by the use of its interface.

Kind: global interface
See: the context package

• Context
  • .getContextConfiguration() ⇒ Object
  • .getMizarConfiguration() ⇒ Object
  • .getPositionTracker() ⇒ PositionTracker
  • .getElevationTracker() ⇒ ElevationTracker
  • .setCompassVisible(divName, visible)
  • .setComponentVisibility(componentId, isVisible)
  • .showComponents()
  • .show()
  • .hideComponents(uiArray)
  • .hide()
  • .showAdditionalLayers()
  • .hideAdditionalLayers()
  • .getLonLatFromPixel(x, y) ⇒ Array.<float>
  • .getPixelFromLonLat(longitude, latitude) ⇒ Array.<int>
  • .getElevation(lon, lat) ⇒ float
  • .getLayers() ⇒ Array.<Layer>
  • .getLayerByID(layerId) ⇒ Layer | undefined
  • .getLayerByName(layerName) ⇒ Layer | undefined
  • .setBackgroundLayer(survey) ⇒ Layer | undefined
  • .setBackgroundLayerByID(surveyID) ⇒ Layer | undefined
  • .getAdditionalLayers() ⇒ Array.<Layer>
  • .addLayer(mizarDescription) ⇒ Layer
  • .removeLayer(layerID) ⇒ Layer
  • .removeAllLayers()
  • .addDraw(layer)
  • .removeDraw(layer)
  • .getRenderContext() ⇒ RenderContext
  • .getMode() ⇒ CONTEXT
  • .setCoordinateSystem(cs)
  • .getCoordinateSystem() ⇒ Crs
  • .getNavigation() ⇒ Navigation
  • .addAnimation(anim)
  • .removeAnimation(anim)
  • .getTileManager() ⇒ TileManager
  • .dispose()
  • .refresh()
  • .destroy()
  • .disable()
  • .enable()
  • "modifiedNavigation"
  • "startNavigation"
  • "endNavigation"
  • "startLoad"
  • "endLoad"
  • "backgroundLayer"
  • "backgroundSurveyError"
  • "baseLayersError"
  • "baseLayersReady"
  • "startBackgroundLoad"
  • "endBackgroundLoad"
  • "features:added"
  • "layer:add"
  • "layer:remove"
  • "modifiedCrs"

context.getContextConfiguration() ⇒ Object

Returns the context Configuration

Kind: instance method of Context
Returns: Object - - see options.skyContext or options.planetContext for {Mizar}

context.getMizarConfiguration() ⇒ Object

Returns the mizar Configuration

Kind: instance method of Context
Returns: Object - - see options.configuration for {Mizar}

context.getPositionTracker() ⇒ PositionTracker

Returns the position tracker.

Kind: instance method of Context

context.getElevationTracker() ⇒ ElevationTracker

Returns the elevation tracker.

Kind: instance method of Context

context.setCompassVisible(divName, visible)

Sets the compass to visible or not.

Kind: instance method of Context

Param	Type	Description
divName	string	Name of the compass div
visible	boolean	Visible or not

context.setComponentVisibility(componentId, isVisible)

Sets the UI component visibility.

Kind: instance method of Context

Param	Type	Description
componentId	string	Id of the component
isVisible	boolean	Sets to True when the component must be visible

context.showComponents()

Shows components in the current state given by this.components.

Kind: instance method of Context

context.show()

Start Navigation and "Show" sky or planet component.

Kind: instance method of Context

context.hideComponents(uiArray)

Hide components

Kind: instance method of Context

Param	Description
uiArray	Array of components,which must not be hide.

context.hide()

Stop navigation and hide sky or planet components.

Kind: instance method of Context

context.showAdditionalLayers()

Shows the additional layers.

Kind: instance method of Context

context.hideAdditionalLayers()

Hides the additional layers.

Kind: instance method of Context

context.getLonLatFromPixel(x, y) ⇒ Array.<float>

Returns the lon-lat from a pixel. The pixel is expressed in the canvas frame, i.e. (0,0) corresponds to the lower-left corner of the pixel

Kind: instance method of Context
Returns: Array.<float> - an array of two numbers [lon,lat] or null if the pixel is not on the globe

Param	Type	Description
x	int	the x pixel coordinate
y	int	the y pixel coordinate

context.getPixelFromLonLat(longitude, latitude) ⇒ Array.<int>

Returns the pixel coordinates from longitude/latitude in decimal degree.

Kind: instance method of Context
Returns: Array.<int> - pixels coordinates in the canvas

Param	Type	Description
longitude	float	lonitude in decimal degree in the current coordinate reference system
latitude	float	latitude in decimal degree in the current coordinate reference system

context.getElevation(lon, lat) ⇒ float

Returns the elevation at a geo position.

Kind: instance method of Context
Returns: float - the elevation in meter at the position [lon,lat]

Param	Type	Description
lon	float	the longitude in degree
lat	float	the latitude in degree

context.getLayers() ⇒ Array.<Layer>

Returns the layers of a specific context.

Kind: instance method of Context
Returns: Array.<Layer> - an array of layers

context.getLayerByID(layerId) ⇒ Layer | undefined

Returns the layer based on its ID. Looks through each value in the layer list, returning the first one that matches the ID, or undefined if no value passes the test. The function returns as soon as it finds an acceptable element, and doesn't traverse the entire list.

Kind: instance method of Context
Returns: Layer | undefined - the layer

Param	Type	Description
layerId	string	the layer identifier

context.getLayerByName(layerName) ⇒ Layer | undefined

Returns the layer based on its name. Looks through the list of layers and returns the first value that matches the name of the layer. If no match is found, undefined will be returned.

Kind: instance method of Context
Returns: Layer | undefined - the layer

Param	Type	Description
layerName	string	Name of the layer

context.setBackgroundLayer(survey) ⇒ Layer | undefined

Sets the background survey.

Kind: instance method of Context
Returns: Layer | undefined - the layer which has been added to the background
Emits: Context#backgroundLayer:change, backgroundSurveyError

Param	Type	Description
survey	string	The name of the layer

context.setBackgroundLayerByID(surveyID) ⇒ Layer | undefined

Sets the background survey by layer ID.

Kind: instance method of Context
Returns: Layer | undefined - the layer which has been added to the background

Param	Type	Description
surveyID	string	The name of the layer

context.getAdditionalLayers() ⇒ Array.<Layer>

Returns the additional layers.

Kind: instance method of Context
Returns: Array.<Layer> - the additional layers by opposition to the background layers

context.addLayer(mizarDescription) ⇒ Layer

Registers a new layer to globe to be visualized on the globe.

When layerPlanet is defined, the layer is added to the layerPlanet otherwise the layer is added to the globe. According to the attributes of the layer, the layer is either added as background or as additional layer.

Kind: instance method of Context
Returns: Layer - the created layer
Emits: Context#backgroundLayer:add, Context#additionalLayer:add

Param	Type	Description
mizarDescription	Object	See the base properties configuration and specific properties for specific layers

context.removeLayer(layerID) ⇒ Layer

Removes a layer based on its identifier

Kind: instance method of Context
Returns: Layer - the removed layer

Param	Type	Description
layerID	string	the layer identifier

context.removeAllLayers()

Removes all layers.

Kind: instance method of Context

context.addDraw(layer)

Adds a temporary draw as a layer on the globe.
A temporary draw is used to create a subLayer or a simple draw. This added layer is not searchable and does not subscribe to "visibility:changed" by configuration

Kind: instance method of Context

Param	Type
layer	Layer

context.removeDraw(layer)

Removes the temporary draw on the globe.

Kind: instance method of Context

Param	Type
layer	Layer

context.getRenderContext() ⇒ RenderContext

Returns the rendering context.

Kind: instance method of Context
Returns: RenderContext - The rendering context

context.getMode() ⇒ CONTEXT

Returns the mode of the globe

Kind: instance method of Context
Returns: CONTEXT - the mode of the globe

context.setCoordinateSystem(cs)

Sets the coordinate reference system.

Kind: instance method of Context
Throws:

• "incompatible coordinate reference system with globe context (e.g : sky, planet)"

Emits: modifiedCrs

Param	Description
cs	the coordinate reference system

context.getCoordinateSystem() ⇒ Crs

Returns the reference coordinate system.

Kind: instance method of Context
Returns: Crs - the coordinate reference system

context.getNavigation() ⇒ Navigation

Returns the navigation.

Kind: instance method of Context
Returns: Navigation - navigation

context.addAnimation(anim)

Adds an animation.

Kind: instance method of Context

Param	Type	Description
anim	Animation	the animation to add

context.removeAnimation(anim)

Removes an animation.

Kind: instance method of Context

Param	Type	Description
anim	Animation	the animation to remove

context.getTileManager() ⇒ TileManager

Returns the tile manager.

Kind: instance method of Context

context.dispose()

Cleans up every reference to gl objects and unloads all tiles of the current context.

Kind: instance method of Context

context.refresh()

Refreshes rendering, must be called when canvas size is modified.

Kind: instance method of Context

context.destroy()

Destroys the globe of the current context. The globe is destroyed by :

• cleaning up every reference to gl objects and unloads all tiles
• Removing the renderer from all the tiles

Kind: instance method of Context

context.disable()

Disables the globe of the current context.

Kind: instance method of Context

context.enable()

Enables the globe of the current context.

Kind: instance method of Context

"modifiedNavigation"

Camera view event.
Called when the view of the camera has changed (pan, rotate, ...)

Kind: event emitted by Context

"startNavigation"

Start navigation.
Called when navigation is started (by the user or through animation)

Kind: event emitted by Context

"endNavigation"

End navigation.
Called when navigation is ended (by the user or through animation)

Kind: event emitted by Context

"startLoad"

startLoad.
Called when a layer start to be loaded

Kind: event emitted by Context

"endLoad"

endLoad.
Called when layer end loading

Kind: event emitted by Context

"backgroundLayer"

backgroundLayer.
Called when a layer is loaded as background

Kind: event emitted by Context

"backgroundSurveyError"

backgroundSurveyError.
Called when a layer could not be loaded as background

Kind: event emitted by Context

"baseLayersError"

baseLayersError.

Kind: event emitted by Context

"baseLayersReady"

baseLayersReady.

Kind: event emitted by Context

"startBackgroundLoad"

startBackgroundLoad.
Called when background layers (imagery and/or elevation) start to be loaded

Kind: event emitted by Context

"endBackgroundLoad"

endBackgroundLoad.
Called when background layers (imagery and/or elevation) end loading

Kind: event emitted by Context

"features:added"

features:added.
Called when data coming from a GeoJSON are added

Kind: event emitted by Context
Properties

Name	Type
layer	Layer
features	Object

"layer:add"

layer:add.
Called when a layer is added

Kind: event emitted by Context
See: Layer

"layer:remove"

layer:remove.
Called when a layer is removed

Kind: event emitted by Context
See: Layer

"modifiedCrs"

modifiedCrs.
Called when a CRS changes

Kind: event emitted by Context

Crs

CRS is an interface to handle the coordinate reference system, which allows a Context :

• to convert 3D position from/to world coordinates
• to compute the local transformation matrix and vectors from this matrix

Mizar currently supports the following coordinates reference systems :

	[EquatorialCrs](#module_Crs.EquatorialCrs)	Provides an equatorial coordinate reference system
	[GalacticCrs](#module_Crs.GalacticCrs)	Provides a galactic coordinate reference system
	[Mars2000Crs](#module_Crs.Mars2000Crs)	Provides a coordinate reference system base on the Mars geoide
	[WGS84Crs](#module_Crs.WGS84Crs)	Provides a coordinate reference system base on the Earth geoide
	[ProjectedCrs](#module_Crs.ProjectedCrs)	Provides a projected coordinate reference system on a map

In addition to the classes, a factory is available to help for creating animation. Once the crs is created, the client can handle it by the use of its interface.

Kind: global interface
See: the coordinate reference system package

• Crs
  • .isFlat() ⇒
  • .getVerticalAt3D(pos, dest)
  • .fromGeoTo3D(geo, dest) ⇒ Array.<float>
  • .from3DToGeo(position3d, dest) ⇒ Array.<float>
  • .getLocalTransform(geo, dest) ⇒ Array.<float>
  • .getLHVTransform(geo, dest) ⇒ Array.<float>
  • .getSideVector(matrix, v) ⇒ Array.<float>
  • .getFrontVector(matrix, v) ⇒ Array.<float>
  • .getUpVector(matrix, v) ⇒ Array.<float>
  • .formatCoordinates(geo)
  • .getGeoide() ⇒ Geoide
  • .getGeoideName() ⇒ string
  • .getType() ⇒ CRS
  • .getElevation(globe, geoPos) ⇒ float
  • .getWorldFrom3D(position3d, dest) ⇒ Array.<float>
  • .get3DFromWorld(posWorld, dest) ⇒ Array.<float>
  • .get3DFromWorldInCrs(posWorld, posCrsID, dest) ⇒ Array.<float>
  • .getSexagesimalFromDeg(degPos, dest) ⇒ Array.<string>
  • .getDecimalDegFromSexagesimal(sexagesimalPos, dest) ⇒ Array.<float>
  • .convert(geo, from, to) ⇒ Array.<float>
  • .fromDegreesToHMS(degree) ⇒ string
  • .fromDegreesToDMS(degree) ⇒ string
  • ._setupPosBeforeTrans(posWorld)
  • ._setupPosAfterTrans(posWorld)
  • .getGeoBound() ⇒ GeoBound

crs.isFlat() ⇒

Checks when the CRS is a ProjectedCrs. A ProjectedCrs projects data on a 2D map.

Kind: instance method of Crs
Returns: True when the CRS is 2D otherwise False

crs.getVerticalAt3D(pos, dest)

Computes the direction or vertical as a unit vector of the same direction as the provided pos.

Kind: instance method of Crs

Param	Type	Description
pos	Array.<float>	the position as a 3D vector
dest	Array.<float>	the direction as a 3D vector

crs.fromGeoTo3D(geo, dest) ⇒ Array.<float>

Converts a geographic position to a 3D vector.

Kind: instance method of Crs
Returns: Array.<float> - a 3D vector

Param	Type	Description
geo	Array.<float>	geographical position as a (longitude in degree, latitude in degree, distance from surface in meter)
dest	Array.<float>	3D vector

crs.from3DToGeo(position3d, dest) ⇒ Array.<float>

Converts a 3D vector to geographical position.

Kind: instance method of Crs
Returns: Array.<float> - geographical position [long, lat, distance from earth surface]

Param	Type	Description
position3d	Array.<float>	3D position
dest	Array.<float>	geographical position [long, lat, distance from earth surface]

crs.getLocalTransform(geo, dest) ⇒ Array.<float>

Returns the local transformation.

Kind: instance method of Crs
Returns: Array.<float> - Matrix as 16 values

Param	Type	Description
geo	Array.<float>	geographical position
dest	Array.<float>	Matrix as 16 values

crs.getLHVTransform(geo, dest) ⇒ Array.<float>

Returns the LHV transformation.

Kind: instance method of Crs
Returns: Array.<float> - Matrix as 16 values

Param	Type	Description
geo	Array.<float>	geographical position
dest	Array.<float>	Matrix as 16 values

crs.getSideVector(matrix, v) ⇒ Array.<float>

Returns the side (i.e. X) vector from a local transformation

Kind: instance method of Crs
Returns: Array.<float> - Vector as 3 values

Param	Type	Description
matrix	Array.<float>	Matrix as 16 values
v	Array.<float>	Vector as 3 values

crs.getFrontVector(matrix, v) ⇒ Array.<float>

Returns the front (i.e. Y) vector from a local transformation

Kind: instance method of Crs
Returns: Array.<float> - Vector as 3 values

Param	Type	Description
matrix	Array.<float>	Matrix as 16 values
v	Array.<float>	Vector as 3 values

crs.getUpVector(matrix, v) ⇒ Array.<float>

Returns the up (i.e. Z) vector from a local transformation

Kind: instance method of Crs
Returns: Array.<float> - Vector as 3 values

Param	Type	Description
matrix	Array.<float>	Matrix as 16 values
v	Array.<float>	Vector as 3 values

crs.formatCoordinates(geo)

Formats the coordinates according to the coordinate reference system.

Kind: instance method of Crs

Param	Type	Description
geo	Array.<string>	position on the globe in decimal degree

crs.getGeoide() ⇒ Geoide

Returns the geoide.

Kind: instance method of Crs
Returns: Geoide - the geoide

crs.getGeoideName() ⇒ string

Returns the geoide name.

Kind: instance method of Crs
Returns: string - the geoide name

crs.getType() ⇒ CRS

Returns the name of the coordinate reference system.

Kind: instance method of Crs
Returns: CRS - name of the coordinate reference system

crs.getElevation(globe, geoPos) ⇒ float

Returns the elevation in meters at a given position.

Kind: instance method of Crs
Returns: float - the elevation in meters

Param	Type	Description
globe	AbstractGlobe	globe
geoPos	Array.<float>	position on the globe in decimal degree

crs.getWorldFrom3D(position3d, dest) ⇒ Array.<float>

Returns the position in the defined CRS from a 3D position.

Kind: instance method of Crs
Returns: Array.<float> - the position in the defined coordinate reference system

Param	Type	Description
position3d	Array.<float>	3D position
dest	Array.<float>	the position in the defined coordinate reference system

crs.get3DFromWorld(posWorld, dest) ⇒ Array.<float>

Returns the 3D position from the defined CRS.

Kind: instance method of Crs
Returns: Array.<float> - the 3D position

Param	Type	Description
posWorld	Array.<float>	the position in the defined CRS
dest	Array.<float>	the 3D position

crs.get3DFromWorldInCrs(posWorld, posCrsID, dest) ⇒ Array.<float>

Converts the 3D position from geo position in the current CRS to another CRS.

Kind: instance method of Crs
Returns: Array.<float> - the 3D position

Param	Type	Description
posWorld	Array.<float>	geo position in the current coordinate reference system
posCrsID	CRS	ID of the target CRS
dest	Array.<float>	the 3D position

crs.getSexagesimalFromDeg(degPos, dest) ⇒ Array.<string>

Returns the position in degree to sexagesimal format.

Kind: instance method of Crs
Returns: Array.<string> - the angle in sexagesimal format

Param	Type	Description
degPos	Array.<float>	the geo position in decimal degree
dest	Array.<string>	the angle in sexagesimal format

crs.getDecimalDegFromSexagesimal(sexagesimalPos, dest) ⇒ Array.<float>

Returns the geo position in decimal degree from sexagesimal format.

Kind: instance method of Crs
Returns: Array.<float> - the geo position in decimal degree

Param	Type	Description
sexagesimalPos	Array.<string>	sexagesimal geo position
dest	Array.<float>	the geo position in decimal degree

crs.convert(geo, from, to) ⇒ Array.<float>

Converts a position from a CRS to another CRS.

Kind: instance method of Crs
Returns: Array.<float> - the position in the target CRS

Param	Type	Description
geo	Array.<float>	geo position
from	CRS	the source CRS
to	CRS	the target CRS

crs.fromDegreesToHMS(degree) ⇒ string

Converts an angle to HMS.

Kind: instance method of Crs
Returns: string - HMS

Param	Description
degree	an angle in decimal degree

crs.fromDegreesToDMS(degree) ⇒ string

Converts an angle to DMS

Kind: instance method of Crs
Returns: string - DMS

Param	Description
degree	an angle in decimal degree

crs._setupPosBeforeTrans(posWorld)

Setups the position before the transformation. posWorld is changed.

Kind: instance method of Crs
Access: protected

Param	Type
posWorld	Array.<float>

crs._setupPosAfterTrans(posWorld)

Setups the position after the transformation. posWorld is changed.

Kind: instance method of Crs
Access: protected

Param	Type
posWorld	Array.<float>

crs.getGeoBound() ⇒ GeoBound

Returns the geo bound of the given coordinate reference system

Kind: instance method of Crs
Returns: GeoBound - the geo bound

Globe

Globe is an interface to handle all WebGL objects through a Context. Globe is able :

• to draw layers,
• to render layers,
• to dispose layers and WebGL objects,
• to transform (longitude,latitude) from/to pixel coordinates

The pixel coordinates are expressed in the canvas frame, i.e. (0,0) corresponds to the lower-left corner of the pixel. The geo-position coordinates(longitude,latitude) are expressed in decimal degree in their defined coordinate reference system.

In Mizar, it exists two kinds of globes :

	[Sky](#module_Globe.Sky)	Provides two grids to handle data according to their coordinate reference system : Equatorial, Galactic. Then the globe renders the two grids in the same time.
	[Planet](#module_Globe.Planet)	Provides only one grid to handle data in the reference frame of the planet

In addition to the classes, a factory is available to help for creating globe. Once the globe is created, the client can handle it by the use of its interface.

Kind: global interface
See: the globe package

• Globe
  • .isSky() ⇒ boolean
  • .getType() ⇒ GLOBE
  • .setBaseImagery(layer)
  • .getBaseImagery() ⇒ AbstractRasterLayer
  • .setBaseElevation() ⇒ WMSElevationLayer | WCSElevationLayer
  • .getBaseElevation() ⇒ WMSElevationLayer | WCSElevationLayer
  • .addLayer(layer)
  • .removeLayer(layer)
  • .addAnimation(anim)
  • .removeAnimation(anim)
  • .getElevation(lon, lat) ⇒ float
  • .getViewportGeoBound(transformCallback) ⇒ GeoBound
  • .getLonLatFromPixel(x, y) ⇒ Array.<float> | null
  • .getPixelFromLonLat(lon, lat) ⇒ Array.<int> | null
  • .setCoordinateSystem(coordinateSystem)
  • .getCoordinateSystem() ⇒ Crs
  • .getRenderStats() ⇒ string
  • .getRenderContext() ⇒ RenderContext
  • .setRenderContext(context)
  • .getTileManager() ⇒ TileManager
  • .dispose()
  • .destroy()
  • .refresh()
  • .isEnabled() ⇒ boolean
  • .enable()
  • .disable()

globe.isSky() ⇒ boolean

Checks if the globe is a sky or a planet

Kind: instance method of Globe
Returns: boolean - True when the globe is a sky otherwise false

globe.getType() ⇒ GLOBE

Returns the type of globe.

Kind: instance method of Globe
Returns: GLOBE - type of globe

globe.setBaseImagery(layer)

Registers the layer as a background raster and attach it to the globe.
When a raster layer is already set, this layer is replaced by the new one.

Kind: instance method of Globe

Param	Type	Description
layer	AbstractRasterLayer	raster layer to use

globe.getBaseImagery() ⇒ AbstractRasterLayer

Returns the background raster as a layer.

Kind: instance method of Globe
Returns: AbstractRasterLayer - the raster layer

globe.setBaseElevation() ⇒ WMSElevationLayer | WCSElevationLayer

Registers the elevation layer and attach it to the globe.
When an elevation layer is already set, this layer is replaced by the new one

Kind: instance method of Globe
Returns: WMSElevationLayer | WCSElevationLayer - the layer used

globe.getBaseElevation() ⇒ WMSElevationLayer | WCSElevationLayer

Returns the elevation layer.

Kind: instance method of Globe
Returns: WMSElevationLayer | WCSElevationLayer - the layer used

globe.addLayer(layer)

Registers a new layer to globe to be visualized on the globe.

When the layer is added, an internal ID is generated to the layer based on an autoincrement value. Once the layer is added, the globe is rendered. According to the visible attribute of the layer, the layer is automatically shown on the globe.

The layer can be mainly a raster or a set of vectors.
In the vector case, the data is located in the url attribute of the layer object. In addition to the URL, a callback attribute can be applied to the data.

Kind: instance method of Globe
Emits: layer:add

Param	Type	Description
layer	Layer	the layer to add

globe.removeLayer(layer)

Removes a layer.

The layer is set to unvisible. Then it is detached to the globe. The globe is rendered to remove the layer from the globe.

Kind: instance method of Globe
Emits: layer:remove

Param	Type	Description
layer	Layer	the layer to remove

globe.addAnimation(anim)

Adds an animation to be played later on.

Kind: instance method of Globe

Param	Type	Description
anim	Animation	the animation to add

globe.removeAnimation(anim)

Removes an animation.

Kind: instance method of Globe

Param	Type	Description
anim	Animation	the animation to remove

globe.getElevation(lon, lat) ⇒ float

Returns the elevation in meters at a geo position at the defined coordinate reference system.

Kind: instance method of Globe
Returns: float - the elevation in meter at the position [lon,lat]

Param	Type	Description
lon	float	the longitude in degree
lat	float	the latitude in degree

globe.getViewportGeoBound(transformCallback) ⇒ GeoBound

Returns the viewport geo bound.

Kind: instance method of Globe
Returns: GeoBound - the geo bound of the viewport

Param	Description
transformCallback	Callback transforming the frustum/globe intersection coordinates if needed

globe.getLonLatFromPixel(x, y) ⇒ Array.<float> | null

Returns the geo position [longitude, latitude] in degree from a pixel.
The pixel is expressed in the canvas frame, i.e. (0,0) corresponds to the lower-left corner of the pixel. The geo position is expressed in the defined coordinate reference system.

Kind: instance method of Globe
Returns: Array.<float> | null - an array of two numbers [lon,lat] or null if the pixel is not on the globe

Param	Type	Description
x	int	the pixel x coordinate
y	int	the pixel y coordinate

globe.getPixelFromLonLat(lon, lat) ⇒ Array.<int> | null

Returns the pixel coordinates from geo position [longitude, latitude] in degree in the defined coordinate reference system.
The pixel is expressed in the canvas frame, i.e. (0,0) corresponds to the lower-left corner of the pixel

Kind: instance method of Globe
Returns: Array.<int> | null - an array of two numbers [x,y] or null if the pixel is not on the globe

Param	Type	Description
lon	float	the longitude in decimal degree
lat	float	the latitude in decimal degree

globe.setCoordinateSystem(coordinateSystem)

Sets the coordinate reference system

Kind: instance method of Globe

Param	Type	Description
coordinateSystem	Crs	the coordinate reference system

globe.getCoordinateSystem() ⇒ Crs

Returns the coordinate reference system.

Kind: instance method of Globe
Returns: Crs - the coordinate reference system

globe.getRenderStats() ⇒ string

Displays some rendering statistics.

Kind: instance method of Globe
Returns: string - the statistics

globe.getRenderContext() ⇒ RenderContext

Returns the rendering context.

Kind: instance method of Globe
Returns: RenderContext - the rendering context

globe.setRenderContext(context)

Sets the rendering context.

Kind: instance method of Globe

Param	Type	Description
context	RenderContext	the rendering context

globe.getTileManager() ⇒ TileManager

Returns the tile manager.

Kind: instance method of Globe
Returns: TileManager - Tile manager

globe.dispose()

Cleans up every reference to gl objects and unloads all tiles

Kind: instance method of Globe

globe.destroy()

Destroys the globe. The globe is destroyed by :

• cleaning up every reference to gl objects and unloads all tiles
• Removing the renderer from all the tiles

Kind: instance method of Globe

globe.refresh()

Refreshes rendering, must be called when canvas size is modified.

Kind: instance method of Globe

globe.isEnabled() ⇒ boolean

Checks if the globe rendering is enabled.

Kind: instance method of Globe
Returns: boolean - True when the globe rendering is enabled whereas False

globe.enable()

Enables the globe. This is used to enable the sky when we use the sphere to map the data. In this way, we see the globe and the sky in the same time.

Kind: instance method of Globe

globe.disable()

Disables the globe.

This method is only overloaded by the sky to make disable the sky when the planet is projected on a map.

Kind: instance method of Globe

Tracker

Interface to handle tracker

Kind: global interface

• Tracker
  • .update(event)
  • .compute(geoPosition)
  • .attachTo(globeContext)
  • .detach()

tracker.update(event)

Update the tracker

Kind: instance method of Tracker

Param
event

tracker.compute(geoPosition)

Compute from geoPosition

Kind: instance method of Tracker

Param	Type
geoPosition	Array.<float>

tracker.attachTo(globeContext)

Attaches the tracker to the globe

Kind: instance method of Tracker

Param	Type	Description
globeContext	globe	globe

tracker.detach()

Detaches from the globe

Kind: instance method of Tracker

Layer

Layer is an interface to get access to the layer data model.

In addition to the classes, a factory is available to help for creating layer. Once the layer is created, the client can handle it by the use of its interface.

Kind: global interface
See: the layer package

• Layer
  • .getGlobe() ⇒ Globe
  • .getID() ⇒ string
  • .getName() ⇒ string
  • .getAttribution() ⇒ string
  • .getCopyrightUrl() ⇒ string
  • .getAck() ⇒ string
  • .getIcon() ⇒ string
  • .getDescription() ⇒ string
  • .isVisible() ⇒ boolean
  • .setVisible(arg)
  • .getOpacity() ⇒ float
  • .setOpacity(arg)
  • .getProperties() ⇒ Object
  • .getType() ⇒ string
  • .isPickable() ⇒ boolean
  • .isType(type) ⇒ boolean
  • .getServices() ⇒ Array.<string>
  • .getDataType() ⇒ GEOMETRY
  • .getFormat() ⇒ string
  • .getCoordinateSystem() ⇒ Crs
  • .getBaseURl() ⇒ string
  • .isDeletable() ⇒ boolean
  • .getColor() ⇒ Array.<int>
  • .getStyle() ⇒ FeatureStyle
  • .getAvailableServices() ⇒ Array.<Object>
  • .isBackground()
  • ._attach(g)
  • ._detach()
  • "visibility:changed"
  • "opacity:changed"

layer.getGlobe() ⇒ Globe

Returns the globe.

Kind: instance method of Layer

layer.getID() ⇒ string

Returns the identifier.

Kind: instance method of Layer

layer.getName() ⇒ string

Returns the layer's name.

Kind: instance method of Layer

layer.getAttribution() ⇒ string

Returns the attribution

Kind: instance method of Layer

layer.getCopyrightUrl() ⇒ string

Returns the copyright URL

Kind: instance method of Layer

layer.getAck() ⇒ string

Returns the acknowledgement.

Kind: instance method of Layer

layer.getIcon() ⇒ string

Returns the icon's url.
By default, a default image is returned.

Kind: instance method of Layer

layer.getDescription() ⇒ string

Returns the layer description.

Kind: instance method of Layer

layer.isVisible() ⇒ boolean

Check whether the layer is visible.

Kind: instance method of Layer

layer.setVisible(arg)

Sets visible the layer.

Kind: instance method of Layer
Throws:

• TypeError Will throw an error when arg is not a boolean

Emits: visibility:changed

Param	Type	Description
arg	Boolean	True when the layer is displayed on the globe otherwise false

layer.getOpacity() ⇒ float

Returns the opacity.

Kind: instance method of Layer
Returns: float - A value between [0..1]

layer.setOpacity(arg)

Sets the opacity.

Kind: instance method of Layer
Throws:

• TypeError Will throw an error when arg is not a number in [0..1]

Emits: opacity:changed

Param	Type	Description
arg	float	A value between [0..1], 0 is transparent

layer.getProperties() ⇒ Object

Returns the properties.

Kind: instance method of Layer
Returns: Object - properties

layer.getType() ⇒ string

Returns the type of layer

Kind: instance method of Layer

layer.isPickable() ⇒ boolean

Checks whether the layer is pickable

Kind: instance method of Layer

layer.isType(type) ⇒ boolean

Check the type of the layer

Kind: instance method of Layer
Returns: boolean - Result

Param	Type	Description
type	String	Type to check

layer.getServices() ⇒ Array.<string>

Returns the services related to the layer

Kind: instance method of Layer

layer.getDataType() ⇒ GEOMETRY

Returns the data type for vector layers.

Kind: instance method of Layer

layer.getFormat() ⇒ string

Returns the format for raster layer

Kind: instance method of Layer
Returns: string - the format

layer.getCoordinateSystem() ⇒ Crs

Returns the coordinate reference system of the layer.

Kind: instance method of Layer
Returns: Crs - the coordinate reference system of the layer

layer.getBaseURl() ⇒ string

Returns the base URL

Kind: instance method of Layer
Returns: string - the base URL

layer.isDeletable() ⇒ boolean

Returns true when the layer is deletable by the client

Kind: instance method of Layer
Returns: boolean - true when the layer is deletable by the client otherwise false

layer.getColor() ⇒ Array.<int>

Returns the layer's color

Kind: instance method of Layer
Returns: Array.<int> - color in rgba

layer.getStyle() ⇒ FeatureStyle

Returns the style.

Kind: instance method of Layer
Returns: FeatureStyle - the style

layer.getAvailableServices() ⇒ Array.<Object>

Returns the available services related to the layer.

Kind: instance method of Layer
Returns: Array.<Object> - the available services

layer.isBackground()

Returns true when the layer is set as background otherwise false.

Kind: instance method of Layer

layer._attach(g)

Attachs the raster layer to the planet.

Kind: instance method of Layer
Access: protected

Param	Type	Description
g	Globe	globe

layer._detach()

Detaches the vector layer from the planet.

Kind: instance method of Layer
Access: protected

"visibility:changed"

visibility:changed.
Called when the visibility of a layer changes

Kind: event emitted by Layer

"opacity:changed"

opacity:changed.
Called when the opacity of a layer changes

Kind: event emitted by Layer

Navigation

Navigation is an interface that provides some methods used to control the camera.

	[AstroNavigation](#module_Navigation.AstroNavigation)	Provides a camera located at the center of the scene. The camera is inside the globe. It is used to view the sky
	[PlanetNavigation](#module_Navigation.PlanetNavigation)	Provides a camera, located outside the globe and looking at the globe. It is used to view a planet
	[FlatNavigation](#module_Navigation.FlatNavigation)	Provides a camera to navigate on a 2D map - Only available in a Planet context

Kind: global interface
See: the navigation package

• Navigation
  • .getType() ⇒ NAVIGATION
  • .getOptions() ⇒ Object
  • .start()
  • .stop()
  • .stopAnimations()
  • .getFov() ⇒ Array.<float>
  • .moveUpTo(vec, [duration])
  • .getCenter() ⇒ Array.<float>
  • .rotate(dx, dy)
  • .pan(dx, dy)
  • .zoom(delta, scale)
  • .zoomTo(geoPos, options)
  • .toViewMatrix(mat, fov, duration, callback)
  • .getRenderContext() ⇒ RenderContext
  • .setRenderContext(renderContext)
  • .applyLocalRotation()
  • .computeViewMatrix()

navigation.getType() ⇒ NAVIGATION

Returns the type of navigation.

Kind: instance method of Navigation
Returns: NAVIGATION - the type of navigation

navigation.getOptions() ⇒ Object

Returns the navigation's options at the initialisation.

Kind: instance method of Navigation
Returns: Object - Options

navigation.start()

Starts the navigation.

Kind: instance method of Navigation

navigation.stop()

Stops the navigation.

Kind: instance method of Navigation

navigation.stopAnimations()

Stops the animations.

Kind: instance method of Navigation

navigation.getFov() ⇒ Array.<float>

Returns the field of view in decimal degree.

Kind: instance method of Navigation
Returns: Array.<float> - the Field of view [fov along width, fov along height]

navigation.moveUpTo(vec, [duration])

Moves up vector.

Kind: instance method of Navigation

Param	Type	Default	Description
vec	Array.<float>		3D Vector
[duration]	int	1000	Duration of animation in milliseconds

navigation.getCenter() ⇒ Array.<float>

Returns the center of the field of view.

Kind: instance method of Navigation
Returns: Array.<float> - the center in decimal degree of the field of view [longitude, latitude]

navigation.rotate(dx, dy)

Rotates the camera.

Kind: instance method of Navigation

Param	Type	Description
dx	float	Window delta x
dy	float	Window delta y

navigation.pan(dx, dy)

Pans the camera to a direction up/down or left/right with the same distance from the object

Kind: instance method of Navigation

Param	Type	Description
dx	float	Window direction left/right
dy	float	Window direction up/down

navigation.zoom(delta, scale)

Applies zooming.

Kind: instance method of Navigation

Param	Type	Description
delta	float	Delta zoom
scale	float	Scale

navigation.zoomTo(geoPos, options)

Zooms to a 2D position (longitude, latitude).

Kind: instance method of Navigation

Param	Type	Description
geoPos	Array.<float>	spatial position in decimal degree [longitude, latitude]
options	Object	options for the selected navigation

navigation.toViewMatrix(mat, fov, duration, callback)

Basic animation from current view matrix to the given one

Kind: instance method of Navigation

Param	Type	Description
mat	Array.<Object>	Destination view matrix (array of 16)
fov	int	Final zooming fov in degrees
duration	int	Duration of animation in milliseconds
callback	function	Callback on the end of animation

navigation.getRenderContext() ⇒ RenderContext

Returns the rendering context.

Kind: instance method of Navigation
Returns: RenderContext - the rendering context

navigation.setRenderContext(renderContext)

Sets the rendering context

Kind: instance method of Navigation

Param	Type	Description
renderContext	RenderContext	the rendering context to set

navigation.applyLocalRotation()

Applies to rotation matrix

Kind: instance method of Navigation

navigation.computeViewMatrix()

Computes the view matrix

Kind: instance method of Navigation

Projection

Projection is an interface that provides many methods used to represent the 3-dimensional surface of the earth or other round body on a 2-dimensional plane in cartography. The creation of a map projection involves two steps :

• selection of a [model for the shape of the body](#Projection+getGeoBound) (choosing between a sphere or ellipsoid),
• transform [planetographic coordinates to plane coordinates](#Projection+project).

Mizar owns different types of projection, which is used to represent a planet on a 2D map.

	[AitoffProjection](#module_Projection.AitoffProjection)	Provides a AITOFF projection
	[AugustProjection](#module_Projection.AugustProjection)	Provides an august projection
	[AzimuthProjection](#module_Projection.AzimuthProjection)	Provides an azimuth projection
	[MercatorProjection](#module_Projection.MercatorProjection)	Provides a mercator projection
	[MollweideProjection](#module_Projection.MollweideProjection)	Provides a mollweide projection
	[PlateProjection](#module_Projection.PlateProjection)	Provides a plate carrée projection

Kind: global interface
See: the projection package

• Projection
  • .getProjectionCenter() ⇒ Array.<float>
  • .getGeoBound() ⇒ GeoBound
  • .unProject(position3d, dest) ⇒ Array.<float>
  • .project(geoPos, dest) ⇒ Array.<float>

projection.getProjectionCenter() ⇒ Array.<float>

Returns the projection center.

Kind: instance method of Projection
Returns: Array.<float> - the projection center (longitude in degree, latitude in degree)

projection.getGeoBound() ⇒ GeoBound

Returns the geobound

Kind: instance method of Projection

projection.unProject(position3d, dest) ⇒ Array.<float>

Unprojects coordinates from a given 2D map to world coordinates

Kind: instance method of Projection
Returns: Array.<float> - physical position (longitude in degree, latitude in degree, altitude in meter)

Param	Type	Description
position3d	Array.<float>	3D position on the map (x in pixel, y in pixel, altitude in meter)
dest	Array.<float>	physical position (longitude in degree, latitude in degree, altitude in meter)

projection.project(geoPos, dest) ⇒ Array.<float>

Projects the world coordinates to a given 2D map

Kind: instance method of Projection
Returns: Array.<float> - position on the map (x in pixel, y in pixel, altitude in meter)

Param	Type	Description
geoPos	Array.<float>	physical position (longitude in degree, latitude in degree, altitude in meter)
dest	Array.<float>	position on the map (x in pixel, y in pixel, altitude in meter)

Provider

Provider is an interface that provides methods to load file, which are not supported by Mizar.

Kind: global interface

• Provider
  • .loadFiles()
  • .handleFeatures()
  • .loadFiles(layer, configuration)
  • .handleFeatures(layer)

provider.loadFiles()

Kind: instance abstract method of Provider

provider.handleFeatures()

Kind: instance method of Provider

provider.loadFiles(layer, configuration)

Loads a specific file passed from configuration

Kind: instance method of Provider

Param	Type
layer	Layer
configuration	Object

provider.handleFeatures(layer)

Process data and add them to the layer

Kind: instance method of Provider

Param	Type
layer	Layer

ReverseNameResolver

API allowing to retry an information from a geo picking

Kind: global interface

• ReverseNameResolver
  • .handle(options)
  • .remove()

reverseNameResolver.handle(options)

Code to execute when the service is request to get the information

Kind: instance method of ReverseNameResolver

Param	Description
options	options

reverseNameResolver.remove()

Code to execute when remove

Kind: instance method of ReverseNameResolver

NameResolver

API allowing to search object name and zoom to it

Kind: global interface

• NameResolver
  • .handle(options)
  • .remove()

nameResolver.handle(options)

Queries a service based on an object name.

Kind: instance method of NameResolver

Param	Type	Description
options	Object	Search configuration
options.objectName	string	Searched name
options.onError	function	Callback function when error
options.onComplete	function	Callback function when finish
options.onSuccess	function	Callback function when success
options.searchLayer	function	Layer where the research is done
options.zoomTo	function	ZoomTo function

nameResolver.remove()

Code to execute when remove

Kind: instance method of NameResolver

Mizar

Creates an instance of the Mizar API.

Kind: global class

• Mizar
  • new Mizar(options)
  • new Mizar(options)
  • instance
    • .AnimationFactory
    • .ServiceFactory
    • .ProviderFactory
    • .VERSION
    • .ANIMATION
    • .LAYER
    • .GEOMETRY
    • .NAVIGATION
    • .CONTEXT
    • .PROJECTION
    • .CRS
    • .SERVICE
    • .UTILITY
    • .PROVIDER
    • .AnimationFactory
    • .ServiceFactory
    • .ProviderFactory
    • .VERSION
    • .ANIMATION
    • .LAYER
    • .GEOMETRY
    • .NAVIGATION
    • .CONTEXT
    • .PROJECTION
    • .CRS
    • .SERVICE
    • .UTILITY
    • .PROVIDER
    • .getSkyContext() ⇒ SkyContext | null
    • .getPlanetContext() ⇒ PlanetContext | null
    • .getActivatedContext() ⇒ PlanetContext | SkyContext
    • .setActivatedContext(contextMode)
    • .getRenderContext() ⇒ RenderContext
    • .getOptions() ⇒ parameters
    • .getCrs() ⇒ Crs
    • .setCrs(coordinateSystem)
    • .createContext(contextMode, options)
    • .toggleDimension()
    • .toggleContext(gwLayer, options, callback)
    • .getSkyLayers() ⇒ Array.<Layer>
    • .getPlanetLayers() ⇒ Array.<Layer>
    • .getLayers(mode) ⇒ Array.<Layer>
    • .getAllLayers() ⇒ Array.<Layer>
    • .getLayerByID(layerID, mode) ⇒ Layer | undefined
    • .getLayerByName(layerName, mode) ⇒ Layer | undefined
    • .addLayer(layerDescription, [layerPlanet]) ⇒ string
    • .removeLayer(layerID, mode) ⇒ boolean
    • .setBackgroundLayer(layerName, mode) ⇒ boolean
    • .setBackgroundLayerByID(layerID, mode) ⇒ boolean
    • .setBaseElevation(layerName, mode) ⇒ boolean
    • .searchOnLayerDescription(query, mode) ⇒ Array.<Layer>
    • .searchSkyLayer(query) ⇒ Array.<Layer>
    • .searchPlanetLayer(query) ⇒ Array.<Layer>
    • .registerNoStandardDataProvider(type, loadFunc, mode)
    • .createStats(options) ⇒ Stats
    • .render()
    • .dispose()
    • .destroy()
    • .getSkyContext() ⇒ SkyContext | null
    • .getPlanetContext() ⇒ PlanetContext | null
    • .getActivatedContext() ⇒ PlanetContext | SkyContext
    • .setActivatedContext(contextMode)
    • .getRenderContext() ⇒ RenderContext
    • .getOptions() ⇒ parameters
    • .getCrs() ⇒ Crs
    • .setCrs(coordinateSystem)
    • .createContext(contextMode, options)
    • .toggleDimension()
    • .toggleContext(gwLayer, options, callback)
    • .getSkyLayers() ⇒ Array.<Layer>
    • .getPlanetLayers() ⇒ Array.<Layer>
    • .getLayers(mode) ⇒ Array.<Layer>
    • .getAllLayers() ⇒ Array.<Layer>
    • .getLayerByID(layerID, mode) ⇒ Layer | undefined
    • .getLayerByName(layerName, mode) ⇒ Layer | undefined
    • .addLayer(layerDescription, [layerPlanet]) ⇒ string
    • .removeLayer(layerID, mode) ⇒ boolean
    • .setBackgroundLayer(layerName, mode) ⇒ boolean
    • .setBackgroundLayerByID(layerID, mode) ⇒ boolean
    • .setBaseElevation(layerName, mode) ⇒ boolean
    • .searchOnLayerDescription(query, mode) ⇒ Array.<Layer>
    • .searchSkyLayer(query) ⇒ Array.<Layer>
    • .searchPlanetLayer(query) ⇒ Array.<Layer>
    • .registerNoStandardDataProvider(type, loadFunc, mode)
    • .createStats(options) ⇒ Stats
    • .render()
    • .dispose()
    • .destroy()
  • static
    • .inputParameters : Object
    • .parameters : Object
    • .inputConfiguration : Object
    • .configuration : inputConfiguration
    • .inputParameters : Object
    • .parameters : Object
    • .inputConfiguration : Object
    • .configuration : inputConfiguration

new Mizar(options)

Param	Type	Description
options	inputParameters	Configuration for Mizar

new Mizar(options)

Param	Type	Description
options	inputParameters	Configuration for Mizar

mizar.AnimationFactory

Creates an animation

Kind: instance property of Mizar

mizar.ServiceFactory

Creates a service

Kind: instance property of Mizar

mizar.ProviderFactory

Creates a provider

Kind: instance property of Mizar

mizar.VERSION

Static variable, API version.
SemVer concept is used for versioning

Kind: instance property of Mizar

mizar.ANIMATION

Static variable, supported animation type

Kind: instance property of Mizar

mizar.LAYER

Static variable, supported layer type

Kind: instance property of Mizar

mizar.GEOMETRY

Static variable, supported geometry type

Kind: instance property of Mizar

mizar.NAVIGATION

Static variable, supported navigation type

Kind: instance property of Mizar

mizar.CONTEXT

Static variable, supported context type

Kind: instance property of Mizar

mizar.PROJECTION

Static variable, supported projection type

Kind: instance property of Mizar

mizar.CRS

Static variable, supported coordinate reference system type

Kind: instance property of Mizar

mizar.SERVICE

Static variable, supported service type

Kind: instance property of Mizar

mizar.UTILITY

Static variable, supported utility type

Kind: instance property of Mizar

mizar.PROVIDER

Static variable, supported provider type

Kind: instance property of Mizar

mizar.AnimationFactory

Creates an animation

Kind: instance property of Mizar

mizar.ServiceFactory

Creates a service

Kind: instance property of Mizar

mizar.ProviderFactory

Creates a provider

Kind: instance property of Mizar

mizar.VERSION

Static variable, API version.
SemVer concept is used for versioning

Kind: instance property of Mizar

mizar.ANIMATION

Static variable, supported animation type

Kind: instance property of Mizar

mizar.LAYER

Static variable, supported layer type

Kind: instance property of Mizar

mizar.GEOMETRY

Static variable, supported geometry type

Kind: instance property of Mizar

mizar.NAVIGATION

Static variable, supported navigation type

Kind: instance property of Mizar

mizar.CONTEXT

Static variable, supported context type

Kind: instance property of Mizar

mizar.PROJECTION

Static variable, supported projection type

Kind: instance property of Mizar

mizar.CRS

Static variable, supported coordinate reference system type

Kind: instance property of Mizar

mizar.SERVICE

Static variable, supported service type

Kind: instance property of Mizar

mizar.UTILITY

Static variable, supported utility type

Kind: instance property of Mizar

mizar.PROVIDER

Static variable, supported provider type

Kind: instance property of Mizar

mizar.getSkyContext() ⇒ SkyContext | null

Returns the sky context.

Kind: instance method of Mizar

mizar.getPlanetContext() ⇒ PlanetContext | null

Returns the planet context.

Kind: instance method of Mizar

mizar.getActivatedContext() ⇒ PlanetContext | SkyContext

Returns the selected context

Kind: instance method of Mizar

mizar.setActivatedContext(contextMode)

Selects the context as default context according to the context mode.
Once a context is selected, methods can be applied to it.

Kind: instance method of Mizar
Throws:

• RangeError contextMode not valid - a valid contextMode is included in the list CONTEXT

Emits: Mizar#mizarMode:toggle

Param	Type	Description
contextMode	CONTEXT	select one context among context

mizar.getRenderContext() ⇒ RenderContext

Returns the rendering context.

Kind: instance method of Mizar
Returns: RenderContext - the rendering context

mizar.getOptions() ⇒ parameters

Returns the options

Kind: instance method of Mizar
Returns: parameters - - Mizar's options

mizar.getCrs() ⇒ Crs

Returns the coordinate reference system related to the selected context

Kind: instance method of Mizar
Returns: Crs - the coordinate reference system
See

• setActivatedContext
• createContext

mizar.setCrs(coordinateSystem)

Sets the coordinate reference system related to the selected context

Kind: instance method of Mizar
See

• setActivatedContext
• createContext*

Param	Type	Description
coordinateSystem	configuration | azimuth_configuration | mercator_configuration	coordinate system description

mizar.createContext(contextMode, options)

Creates a context according to the context mode.
The created context is selected automatically as default context. The rendering context for the new context is retrieved from the previous context.

Kind: instance method of Mizar
Throws:

• RangeError contextMode not valid - a valid contextMode is included in the list CONTEXT

Emits: Mizar#mizarMode:toggle

Param	Type	Description
contextMode	CONTEXT	Select on context among context
options	skyContext | planetContext	Options for the context, See options.planetContext or options.skycontext configuration for Mizar

mizar.toggleDimension()

Switches 2D <--> 3D, only for planetary context.
When this method is used in a sky context, and exception is thrown

Kind: instance method of Mizar
Throws:

• "Not implemented" - Will throw an exception for Sky mode. In this version, the sky cannot be projected in 2D

mizar.toggleContext(gwLayer, options, callback)

Switches planetary <---> sky context

Kind: instance method of Mizar
Emits: Mizar#mizarMode:toggle

Param	Type	Description
gwLayer	PlanetLayer	planet layer
options	planetContext	options for the planet
callback	toggleContextCallback	Call at the end of the toggle

mizar.getSkyLayers() ⇒ Array.<Layer>

Returns the sky layers, which have been added by addLayer.

Kind: instance method of Mizar
Returns: Array.<Layer> - the layers

mizar.getPlanetLayers() ⇒ Array.<Layer>

Returns the planet layers, which have been added by addLayer

Kind: instance method of Mizar
Returns: Array.<Layer> - the layers

mizar.getLayers(mode) ⇒ Array.<Layer>

Returns the layers for a specific context.
When no context is specified, the layers from the selected context are returned.

Kind: instance method of Mizar
Returns: Array.<Layer> - the layers
Throws:

• RangeError Will throw an error when the mode is not part of CONTEXT

See

• setActivatedContext
• createContext

Param	Type	Description
mode	CONTEXT | undefined	Context on which the function is applied

mizar.getAllLayers() ⇒ Array.<Layer>

Returns all the layers regardless of the context.

Kind: instance method of Mizar
Returns: Array.<Layer> - the layers

mizar.getLayerByID(layerID, mode) ⇒ Layer | undefined

Returns the layer by its ID according to the context.
When no context is specified, the layer from the selected context is returned.
The ID is a unique layer identifier, which is returned when the layer description is added to Mizar

Kind: instance method of Mizar
Returns: Layer | undefined - The layer or undefined when the layer is not found
See

• setActivatedContext
• createContext

Param	Type	Description
layerID		Layer's ID
mode	CONTEXT | undefined	Context on which the function is applied

mizar.getLayerByName(layerName, mode) ⇒ Layer | undefined

Returns the layer by its name according to the context.
When no context is specified, the layer from the selected context is returned.
Note: The name may not be unique. In this case, the first layer having this name is returned

Kind: instance method of Mizar
Returns: Layer | undefined - the layer or undefined when the layer is not found
Throws:

• RangeError Will throw an error when the mode is not part of CONTEXT

See

• setActivatedContext
• createContext

Param	Type	Description
layerName	string	Layer's name, provided in the layer description when the layer is added
mode	CONTEXT | undefined	Context on which the function is applied

mizar.addLayer(layerDescription, [layerPlanet]) ⇒ string

Adds a layer according to the selected context.
When layerPlanet is not provided, then the layer is added to the selected context otherwise the layer is added to the layerPlanet.

Kind: instance method of Mizar
Returns: string - a unique identifier
See

• AtmosphereLayer : A layer to create an atmosphere on a planet.
• BingLayer: The Microsoft service proving a WMTS server.
• CoordinateGridLayer : A layer to create a grid on the sky
• GeoJSONLayer : A layer to add a GeoJSON on the globe
• GroundOverlayLayer : A layer to draw an image overlay draped onto the terrain
• HipsCatLayer : A layer to draw a HIPS catalogue
• HipsFitsLayer : A layer to draw an Hips Fits
• HipsGraphicLayer : A layer to draw a Hips JPEG/PNG
• MocLayer : A layer to draw a multi-order-coverage index
• OpenSearchLayer : A layer to draw the result from an open search service
• OSMLayer : A layer to display data coming from OpenStreetMap server
• PlanetLayer : A layer to save all layers of a planet
• TileWireframeLayer : A layer to draw a grid on the planet
• VectorLayer : A layer to draw a vector
• WCSElevationLayer : A layer to draw the elevation
• WMSElevationLayer : A layer to draw the elevation
• WMSLayer : A layer to draw images coming from the WMS server
• WMTSLayer : A layer to draw predefined tiles coming from a WMTS server
• setActivatedContext
• createContext

Todo

• Bug to fix : PlanetLayer should use this function to create layer when the context changes

Param	Type	Description
layerDescription	Object	See the base properties configuration and a specific layer for specific properties
[layerPlanet]	PlanetLayer	the planet with which the layer must be linked

mizar.removeLayer(layerID, mode) ⇒ boolean

Removes a layer by its ID according to the context.
When no context is specified, then the function is applied on the selected context.

Kind: instance method of Mizar
Returns: boolean - True when the layer is added otherwise False
Throws:

• RangeError Will throw an error when the mode is not part of CONTEXT

See

• setActivatedContext
• createContext

Param	Type	Description
layerID	string	Layer's ID
mode	CONTEXT | undefined	Context on which the function is applied

mizar.setBackgroundLayer(layerName, mode) ⇒ boolean

Sets the background layer according to the selected context.
When no context is specified, then the function is applied on the selected context.
Note 1: The name is not a unique identifier. The first layer matching at this name is returned
Note 2: The layer must be added before

Kind: instance method of Mizar
Returns: boolean - True when the layer is set as background otherwise False
Throws:

• RangeError Will throw an error when the mode is not part of CONTEXT

See

• setActivatedContext
• createContext

Param	Type	Description
layerName	string	Layer's name, which has been provided in the layer description
mode	CONTEXT | undefined	Context on which the function is applied

mizar.setBackgroundLayerByID(layerID, mode) ⇒ boolean

Sets the background layer by ID according to the context.
When no context is specified, then the function is applied on the selected context. Note: The layer must be added before

Kind: instance method of Mizar
Returns: boolean - True when the layer is set as background otherwise False
Throws:

• RangeError Will throw an error when the mode is not part of CONTEXT

See

• setActivatedContext
• createContext

Param	Type	Description
layerID	string	Unique layer identifier.
mode	CONTEXT | undefined	Context on which the function is applied.

mizar.setBaseElevation(layerName, mode) ⇒ boolean

Sets the base elevation by its layer's name according to the context.
When no context is specified, then the function is applied on the selected context. Note: The layer must be added before

Kind: instance method of Mizar
Returns: boolean - True when the base elevation is set otherwise false
Throws:

• RangeError Will throw an error when the mode is not part of CONTEXT

See

• setActivatedContext
• createContext

Param	Type	Description
layerName	string	Name of the layer
mode	CONTEXT | undefined	Context on which the function is applied

mizar.searchOnLayerDescription(query, mode) ⇒ Array.<Layer>

Looks through each value in the list according to the context, returning an array of all the values that match the query.
The query is performed on the name and the description of each layer.
When no context is specified, the function is applied on the selected context.

Kind: instance method of Mizar
See

• setActivatedContext
• createContext

Param	Type	Description
query	string	query on the layer'name or description
mode	CONTEXT | undefined	Context on which the query is run.

mizar.searchSkyLayer(query) ⇒ Array.<Layer>

Looks through each value in the sky layers, returning an array of all the values that match the query.
The query is performed on the name and the description of each layer

Kind: instance method of Mizar
Returns: Array.<Layer> - An array of layers matching the constraint

Param	Type	Description
query	string	query on the layer'name or description

mizar.searchPlanetLayer(query) ⇒ Array.<Layer>

Looks through each value in the planets layers, returning an array of all the values that match the query.
The query is performed on the name and the description of each layer

Kind: instance method of Mizar
Returns: Array.<Layer> - An array of layers matching the constraint

Param	Type	Description
query	string	query on the layer'name or description

mizar.registerNoStandardDataProvider(type, loadFunc, mode)

Registers no standard data provider in a predefined context.
When no context is specified, the function is applied to the selected context.

Kind: instance method of Mizar
Throws:

• RangeError Will throw an error when the mode is not part of CONTEXT

See

• setActivatedContext
• createContext

Param	Type	Description
type	string	data provider key
loadFunc	function	Function to convert the data
mode	CONTEXT | undefined	Context

Example (Registers planets on the sky)

  var planetProvider = ProviderFactory.create(Mizar.PROVIDER.Planet);
  this.registerNoStandardDataProvider("planets", planetProvider.loadFiles);

mizar.createStats(options) ⇒ Stats

Creates and get Stats Object

Kind: instance method of Mizar

Param	Type	Description
options	Object	Configuration properties for stats. See Stats for options

mizar.render()

Renders the canvas.

Kind: instance method of Mizar

mizar.dispose()

Disposes the Mizar's contexts (planet and sky)

Kind: instance method of Mizar

mizar.destroy()

Destroys Mizar

Kind: instance method of Mizar

mizar.getSkyContext() ⇒ SkyContext | null

Returns the sky context.

Kind: instance method of Mizar

mizar.getPlanetContext() ⇒ PlanetContext | null

Returns the planet context.

Kind: instance method of Mizar

mizar.getActivatedContext() ⇒ PlanetContext | SkyContext

Returns the selected context

Kind: instance method of Mizar

mizar.setActivatedContext(contextMode)

Selects the context as default context according to the context mode.
Once a context is selected, methods can be applied to it.

Kind: instance method of Mizar
Throws:

• RangeError contextMode not valid - a valid contextMode is included in the list CONTEXT

Emits: Mizar#mizarMode:toggle

Param	Type	Description
contextMode	CONTEXT	select one context among context

mizar.getRenderContext() ⇒ RenderContext

Returns the rendering context.

Kind: instance method of Mizar
Returns: RenderContext - the rendering context

mizar.getOptions() ⇒ parameters

Returns the options

Kind: instance method of Mizar
Returns: parameters - - Mizar's options

mizar.getCrs() ⇒ Crs

Returns the coordinate reference system related to the selected context

Kind: instance method of Mizar
Returns: Crs - the coordinate reference system
See

• setActivatedContext
• createContext

mizar.setCrs(coordinateSystem)

Sets the coordinate reference system related to the selected context

Kind: instance method of Mizar
See

• setActivatedContext
• createContext*

Param	Type	Description
coordinateSystem	configuration | azimuth_configuration | mercator_configuration	coordinate system description

mizar.createContext(contextMode, options)

Creates a context according to the context mode.
The created context is selected automatically as default context. The rendering context for the new context is retrieved from the previous context.

Kind: instance method of Mizar
Throws:

• RangeError contextMode not valid - a valid contextMode is included in the list CONTEXT

Emits: Mizar#mizarMode:toggle

Param	Type	Description
contextMode	CONTEXT	Select on context among context
options	skyContext | planetContext	Options for the context, See options.planetContext or options.skycontext configuration for Mizar

mizar.toggleDimension()

Switches 2D <--> 3D, only for planetary context.
When this method is used in a sky context, and exception is thrown

Kind: instance method of Mizar
Throws:

• "Not implemented" - Will throw an exception for Sky mode. In this version, the sky cannot be projected in 2D

mizar.toggleContext(gwLayer, options, callback)

Switches planetary <---> sky context

Kind: instance method of Mizar
Emits: Mizar#mizarMode:toggle

Param	Type	Description
gwLayer	PlanetLayer	planet layer
options	planetContext	options for the planet
callback	toggleContextCallback	Call at the end of the toggle

mizar.getSkyLayers() ⇒ Array.<Layer>

Returns the sky layers, which have been added by addLayer.

Kind: instance method of Mizar
Returns: Array.<Layer> - the layers

mizar.getPlanetLayers() ⇒ Array.<Layer>

Returns the planet layers, which have been added by addLayer

Kind: instance method of Mizar
Returns: Array.<Layer> - the layers

mizar.getLayers(mode) ⇒ Array.<Layer>

Returns the layers for a specific context.
When no context is specified, the layers from the selected context are returned.

Kind: instance method of Mizar
Returns: Array.<Layer> - the layers
Throws:

• RangeError Will throw an error when the mode is not part of CONTEXT

See

• setActivatedContext
• createContext

Param	Type	Description
mode	CONTEXT | undefined	Context on which the function is applied

mizar.getAllLayers() ⇒ Array.<Layer>

Returns all the layers regardless of the context.

Kind: instance method of Mizar
Returns: Array.<Layer> - the layers

mizar.getLayerByID(layerID, mode) ⇒ Layer | undefined

Returns the layer by its ID according to the context.
When no context is specified, the layer from the selected context is returned.
The ID is a unique layer identifier, which is returned when the layer description is added to Mizar

Kind: instance method of Mizar
Returns: Layer | undefined - The layer or undefined when the layer is not found
See

• setActivatedContext
• createContext

Param	Type	Description
layerID		Layer's ID
mode	CONTEXT | undefined	Context on which the function is applied

mizar.getLayerByName(layerName, mode) ⇒ Layer | undefined

Returns the layer by its name according to the context.
When no context is specified, the layer from the selected context is returned.
Note: The name may not be unique. In this case, the first layer having this name is returned

Kind: instance method of Mizar
Returns: Layer | undefined - the layer or undefined when the layer is not found
Throws:

• RangeError Will throw an error when the mode is not part of CONTEXT

See

• setActivatedContext
• createContext

Param	Type	Description
layerName	string	Layer's name, provided in the layer description when the layer is added
mode	CONTEXT | undefined	Context on which the function is applied

mizar.addLayer(layerDescription, [layerPlanet]) ⇒ string

Adds a layer according to the selected context.
When layerPlanet is not provided, then the layer is added to the selected context otherwise the layer is added to the layerPlanet.

Kind: instance method of Mizar
Returns: string - a unique identifier
See

• AtmosphereLayer : A layer to create an atmosphere on a planet.
• BingLayer: The Microsoft service proving a WMTS server.
• CoordinateGridLayer : A layer to create a grid on the sky
• GeoJSONLayer : A layer to add a GeoJSON on the globe
• GroundOverlayLayer : A layer to draw an image overlay draped onto the terrain
• HipsCatLayer : A layer to draw a HIPS catalogue
• HipsFitsLayer : A layer to draw an Hips Fits
• HipsGraphicLayer : A layer to draw a Hips JPEG/PNG
• MocLayer : A layer to draw a multi-order-coverage index
• OpenSearchLayer : A layer to draw the result from an open search service
• OSMLayer : A layer to display data coming from OpenStreetMap server
• PlanetLayer : A layer to save all layers of a planet
• TileWireframeLayer : A layer to draw a grid on the planet
• VectorLayer : A layer to draw a vector
• WCSElevationLayer : A layer to draw the elevation
• WMSElevationLayer : A layer to draw the elevation
• WMSLayer : A layer to draw images coming from the WMS server
• WMTSLayer : A layer to draw predefined tiles coming from a WMTS server
• setActivatedContext
• createContext

Todo

• Bug to fix : PlanetLayer should use this function to create layer when the context changes

Param	Type	Description
layerDescription	Object	See the base properties configuration and a specific layer for specific properties
[layerPlanet]	PlanetLayer	the planet with which the layer must be linked

mizar.removeLayer(layerID, mode) ⇒ boolean

Removes a layer by its ID according to the context.
When no context is specified, then the function is applied on the selected context.

Kind: instance method of Mizar
Returns: boolean - True when the layer is added otherwise False
Throws:

• RangeError Will throw an error when the mode is not part of CONTEXT

See

• setActivatedContext
• createContext

Param	Type	Description
layerID	string	Layer's ID
mode	CONTEXT | undefined	Context on which the function is applied