Skip to main content
Version: Next

HipsQueryStore

Management of HiPS data queries.

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

center

center: Point2D = ...

The center coordinates of the output image.

coordsys

coordsys: HipsCoord = HipsCoord.Icrs

The coordinate system of the output image.

fov

fov: number = NaN

The field of view of the output image.

hipsSurvey

hipsSurvey: string = ""

The HiPS survey to be used.

isLoading

isLoading: boolean = false

Whether the query is in progress.

object

object: string = ""

The object name on which the output image will be centered.

projection

projection: HipsProjection = HipsProjection.TAN

The projection type of the output image.

rotationAngle

rotationAngle: number = 0

The rotation angle of the output image.

size

size: Point2D = ...

The width and height of the output image.

surveyList

surveyList: HipsSurvey[] = []

A list of available HiPS surveys.

staticreadonlyProjectionOptionMap

ProjectionOptionMap: Map<HipsProjection, string> = ...

HiPS projection types and their descriptions.

Accessors

isValid

  • get isValid(): boolean

  • Whether the current state is valid for a HiPS data query.

    Returns boolean

staticInstance

Methods

clear

  • clear(): void

  • Resets the input parameters.

    Returns void

queryByCenter

  • queryByCenter(): Promise<void>

  • Sends a HiPS data query by the center coordinates.

    Returns Promise<void>

queryByObject

  • queryByObject(): Promise<void>

  • Sends a HiPS data query by the object name.

    Returns Promise<void>

setCenterX

  • setCenterX(x: number): void

  • Sets the center x coordinate of the output image.

    Parameters

    • x: number

      The center x coordinate to set.

    Returns void

setCenterY

  • setCenterY(y: number): void

  • Sets the center y coordinate of the output image.

    Parameters

    • y: number

      The center y coordinate to set.

    Returns void

setCoordsys

  • Sets the coordinate system of the output image.

    Parameters

    • coordsys: HipsCoord

      The coordinate system to set.

    Returns void

setFov

  • setFov(fov: number): void

  • Sets the field of view of the output image.

    Parameters

    • fov: number

      The field of view to set.

    Returns void

setHeight

  • setHeight(height: number): void

  • Sets the height of the output image.

    Parameters

    • height: number

      The height to set.

    Returns void

setHipsSurvey

  • setHipsSurvey(hipsSurvey: string): void

  • Sets the HiPS survey to be used.

    Parameters

    • hipsSurvey: string

      The HiPS survey to set.

    Returns void

setIsLoading

  • setIsLoading(isLoading: boolean): void

  • Updates the query state.

    Parameters

    • isLoading: boolean

      Whether the query is in progress.

    Returns void

setObject

  • setObject(object: string): void

  • Sets the object name on which the output image will be centered.

    Parameters

    • object: string

      The object name to set.

    Returns void

setProjection

  • Sets the projection type of the output image.

    Parameters

    Returns void

setRotationAngle

  • setRotationAngle(rotationAngle: number): void

  • Sets the rotation angle of the output image.

    Parameters

    • rotationAngle: number

      The rotation angle to set.

    Returns void

setWidth

  • setWidth(width: number): void

  • Sets the width of the output image.

    Parameters

    • width: number

      The width to set.

    Returns void