Ask the app to return the HiPS catalog data in the current viewport.

This message will result in a GetHipsCatalogDataInViewReply if the input parameters are all correct.

Hierarchy

  • GetHipsCatalogDataInViewMessage

Properties

event: "layer_hipscat_datainview"

The tag identifying this message type.

limit: boolean

Whether to limit the amount of data downloaded.

It is strongly recommended that you set this to true. HiPS catalogs may contain gigabytes of data, and if the viewport is zoomed out, an unlimited request may attempt to download and transfer that much information.

tableId: string

The client's identifier for this HiPS catalog.

threadId: string

A "thread id" that will be used for the response message with the tabular data.

Generated using TypeDoc