Interface CreateImageSetLayerMessage

A command to create an image set layer.

This command is a more flexible evolution of CreateFitsLayerMessage. They have the same event tag, but this one has a mode parameter.

Hierarchy

  • CreateImageSetLayerMessage

Properties

event goto? id mode name? url

Properties

event

event: "image_layer_create"

The tag identifying this message type.

Optional goto

goto?: boolean

Go to centre of the data. Defaults to true.

id

id: string

An identifier for referring to this image layer later.

mode

mode: "autodetect" | "fits" | "preloaded"

The type of layer that is being loaded.

With "fits", the URL will be treated as a FITS file to be downloaded and displayed. With "preloaded", the URL will be assumed to correspond to an imageset that has already been loaded into the engine. The default is "autodetect", which will assume "fits" if the URL ends in a FITS-like extension, otherwise "preloaded".

Optional name

name?: string

The display name of the layer. Defaults to the id of the layer.

url

url: string

The URL from which to obtain the FITS file or image set.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc