Documentation

Class: AbstractHipsLayer

AbstractHipsLayer

Abstract class for HIPS

new AbstractHipsLayer(hipsMetadata, options)

Parameters:
Name Type Description
hipsMetadata HipsMetadata
options AbstractHipsLayer.configuration AbstractHipsLayer configuration
See:

Extends

Methods

getGlobe()

Inherited From:
Implements:

getID()

Inherited From:
Implements:

getName()

Inherited From:
Implements:

getAttribution()

Inherited From:
Implements:

getCopyrightUrl()

Inherited From:
Implements:

getAck()

Inherited From:
Implements:

getIcon()

Inherited From:
Implements:

getDescription()

Inherited From:
Implements:

isVisible()

Inherited From:
Implements:

setVisible()

Inherited From:
Implements:

getOpacity()

Inherited From:
Implements:

setOpacity()

Inherited From:
Implements:

getProperties()

Inherited From:
Implements:

getType()

Inherited From:
Implements:

isPickable()

Inherited From:
Implements:

isType()

Inherited From:
Implements:

getServices()

Inherited From:
Implements:

getCoordinateSystem()

Inherited From:
Implements:

_detach()

Inherited From:
Implements:

getBaseURl()

Inherited From:
Implements:

getDataType()

Inherited From:
Implements:

getFormat()

Inherited From:
Implements:

isDeletable()

Inherited From:
Implements:

getColor()

Inherited From:
Implements:

getStyle()

Inherited From:
Implements:

getAvailableServices()

Inherited From:
Implements:

Type Definitions

configuration

AbstractHipsLayer configuration
Type:
Properties:
Name Type Argument Default Description
coordinateSystem Crs <optional>
 CoordinateSystemFactory.create({geoideName: Constants.MappingCrsHips2Mizar[this.hipsMetadata.hips_frame]}) Coordinate reference system
tilePixelSize int <optional>
 hipsMetadata['hips_tile_width' Tiles width in pixels
baseLevel int <optional>
 2 min HiPS order
tiling HEALPixTiling <optional>
 new HEALPixTiling(options.baseLevel, {coordinateSystem: options.coordinateSystem}) Tiling
numberOfLevels int <optional>
 hipsMetadata['hips_order'] Deepest order min
name string <optional>
 hipsMetadata['obs_title'] Data set title
attribution string <optional>
 <a href=\"" + this.hipsMetadata['obs_copyright_url'] + "\" target=\"_blank\">" + this.hipsMetadata['obs_copyright'] + "</a>" URL to a copyright mention
ack string <optional>
 hipsMetadata['obs_ack'] Acknowledgment mention
icon string <optional>
 "" icon used as metadata representation on the map
description string <optional>
 hipsMetadata['obs_description'] Data set description
visible boolean <optional>
 false visibility by default on the map
properties Object other metadata
Properties
Name Type Argument Description
initialRa float <optional>
 Initial RA
initialDec float <optional>
 Initial DEC
initialFov float <optional>
 Initial field of view
mocCoverage float <optional>
 Sky fraction coverage
pickable boolean <optional>
 false Pickable layer
availableServices Array <optional>
 {} List of services related to the layer
format Array <optional>
 hipsMetadata['hips_tile_format'] List of available tile formats
baseUrl string <optional>
 hipsMetadata['hips_service_url'] Endpoint service
category string <optional>
 Image Default category
background boolean Tell if the layer is set as background

hipsFits_configuration

HipsFits configuration
Type:
Properties:
Name Type Description
onready function Callback function

graphic_configuration

HipsFits configuration
Type:
Properties:
Name Type Description
onready function Callback function