Tell the app to load a named HiPS catalog into its view.

HiPS catalogs are a bit funky because in some ways, they behave like imagesets, while in other ways, they behave like data table layers.

This message may result in a LoadHipsCatalogCompletedMessage reply, if you specify the threadId.

Hierarchy

  • LoadHipsCatalogMessage

Properties

event: "layer_hipscat_load"

The tag identifying this message type.

name: string

The name of the catalog to load.

The engine must "know about" this catalog by having loaded a WTML file that defines it. It comes pre-loaded with a library of well-known catalogs. The recognized catalog names can be learned through ApplicationStateMessage.hipsCatalogNames.

tableId: string

An identifier for referring to this catalog as a table layer later.

threadId?: string

If specified, a "thread id" that will be used for a response message with information about the table's contents.

While HiPS catalogs resemble spreadsheet layers in many ways, they are different in that clients don't know their table structure. If this item is provided, the app will reply with a message conveying information about the catalog's characteristics.

Generated using TypeDoc