Function engineStore

Properties

activeLayers availableImagesets backgroundImageset clockDiscontinuities clockRate currentTime decRad foregroundImageset foregroundOpacity imagesetLayers isTourPlayerActive isTourPlaying raRad renderType rollRad showWebGl2Warning spreadSheetLayers timeAtStartup tourCompletions tourRunTime tourStopStartTimes tourTimecode zoomDeg

Methods

activeImagesetLayerStates addAnnotation addCatalogHipsByName addImageSetLayer addImagesetToRepository applyFitsLayerSettings applySetting applyTableLayerSettings captureFrame captureVideo catalogLayerKey clearAnnotations clearTileCache closeTourPlayer createTableLayer deleteLayer findRADecForScreenPoint findScreenPointForRADec getCatalogHipsDataInView gotoRADecZoom gotoTarget imagesetForLayer imagesetLayerById imagesetStateForLayer layerById layerForHipsCatalog loadFitsLayer loadImageCollection loadTour lookupImageset move removeAnnotation removeCatalogHipsByName seekToTourTimecode setBackgroundImageByName setClockRate setClockSync setFitsLayerColormap setForegroundImageByName setForegroundOpacity setImageSetLayerOrder setTime setTourPlayerLeaveSettingsWhenStopped setTrackedObject setupForImageset spreadSheetLayer spreadSheetLayerById spreadsheetState spreadsheetStateById spreadsheetStateForHipsCatalog startTour stopTour stretchFitsLayer tilt timeToRADecZoom toggleTourPlayPauseState updateTableLayer viewAsTourXml waitForReady zoom

Properties

activeLayers

activeLayers: string[]

The GUIDs of all rendered layers, in their draw order.

This list gives the GUIDs of the layers that are currently candidates for rendering. This list is determined by the hierarchy of "layer maps" registered with the engine and its current rendering mode. Layers in this list might not be actually rendered if their enabled flag is false, if they are fully transparent, and so on.

In WWTAwareComponent this item is exposed under the name wwtActiveLayers.

availableImagesets

availableImagesets: {
    description: string;
    extension: string;
    id: null | string;
    name: string;
    type: ImageSetType;
    url: string;
}[]

Information about the imagesets that are available to be used as a background.

The info includes the name, which can then be used to set the background image via the setBackgroundImageByName mutation.

In WWTAwareComponent this item is exposed under the name wwtAvailableImagesets.

Type declaration

  • description: string

    An (application-specific) string giving some additional information about the imageset.

  • extension: string

    The image filename extension(s) associated with this imageset.

    May include multiple extensions separated by spaces. May also start with a leading period.

  • id: null | string

    The internal GUID of the layer, if it is a HiPS layer

  • name: string

    The user-facing name of the imageset.

  • type: ImageSetType

    The type of the imageset: panorama, sky, ...

  • url: string

    The URL of the image data.

backgroundImageset

backgroundImageset: null | {
    getHashCode() => number;
    get_altUrl() => string;
    get_bandPass() => BandPass;
    get_baseLevel() => number;
    get_baseTileDegrees() => number;
    get_bottomsUp() => boolean;
    get_centerX() => number;
    get_centerY() => number;
    get_children() => Thumbnail[];
    get_creditsText() => string;
    get_creditsUrl() => string;
    get_dataSetType() => ImageSetType;
    get_defaultSet() => boolean;
    get_demUrl() => string;
    get_elevationModel() => boolean;
    get_extension() => string;
    get_fitsProperties() => FitsProperties;
    get_generic() => boolean;
    get_hipsProperties() => null | HipsProperties;
    get_imageSetID() => number;
    get_isCloudCommunityItem() => boolean;
    get_isFolder() => boolean;
    get_isImage() => boolean;
    get_isTour() => boolean;
    get_levels() => number;
    get_meanRadius() => number;
    get_mercator() => boolean;
    get_name() => string;
    get_offsetX() => number;
    get_offsetY() => number;
    get_projection() => ProjectionType;
    get_quadTreeTileMap() => string;
    get_readOnly() => boolean;
    get_referenceFrame() => string;
    get_rotation() => number;
    get_singleImage() => boolean;
    get_sparse() => boolean;
    get_thumbnailUrl() => string;
    get_url() => string;
    get_wcsImage() => null | WcsImage;
    get_widthFactor() => number;
    set_altUrl(url) => string;
    set_bandPass(bp) => BandPass;
    set_baseLevel(bl) => number;
    set_baseTileDegrees(v) => number;
    set_bottomsUp(bu) => boolean;
    set_centerX(cx) => number;
    set_centerY(cy) => number;
    set_creditsText(ct) => string;
    set_creditsUrl(cu) => string;
    set_dataSetType(st) => ImageSetType;
    set_defaultSet(ds) => boolean;
    set_demUrl(url) => string;
    set_elevationModel(em) => boolean;
    set_extension(ext) => string;
    set_generic(g) => boolean;
    set_imageSetID(id) => number;
    set_levels(levels) => number;
    set_meanRadius(mr) => number;
    set_mercator(m) => boolean;
    set_name(name) => string;
    set_offsetX(ox) => number;
    set_offsetY(oy) => number;
    set_projection(pt) => ProjectionType;
    set_quadTreeTileMap(qttm) => string;
    set_referenceFrame(rf) => string;
    set_rotation(r) => number;
    set_singleImage(si) => boolean;
    set_sparse(s) => boolean;
    set_thumbnailUrl(url) => string;
    set_url(url) => string;
    set_wcsImage(w) => null | WcsImage;
    set_widthFactor(f) => number;
}

The current background Imageset, or null if it is undefined.

You can cause this state variable to change using the setBackgroundImageByName mutation.

In WWTAwareComponent this item is exposed under the name wwtBackgroundImageset.

Type declaration

clockDiscontinuities

clockDiscontinuities: number

The number of times that the progression of the WWT internal clock has been changed discontinuously.

The main use of this state variable is that you can watch for changes to it and be alerted when the clock has been altered.

In WWTAwareComponent this item is exposed under the name wwtClockDiscontinuities.

clockRate

clockRate: number

The rate at which the WWT internal clock progresses compared to real time. If the WWT clock is paused, this will be zero. Negative and fractional values are both possible.

In WWTAwareComponent this item is exposed under the name wwtClockRate.

currentTime

currentTime: {
    getVarDate: (() => VarDate);
    [toPrimitive](hint) => string;
    [toPrimitive](hint) => string;
    [toPrimitive](hint) => number;
    [toPrimitive](hint) => string | number;
    getDate() => number;
    getDay() => number;
    getFullYear() => number;
    getHours() => number;
    getMilliseconds() => number;
    getMinutes() => number;
    getMonth() => number;
    getSeconds() => number;
    getTime() => number;
    getTimezoneOffset() => number;
    getUTCDate() => number;
    getUTCDay() => number;
    getUTCFullYear() => number;
    getUTCHours() => number;
    getUTCMilliseconds() => number;
    getUTCMinutes() => number;
    getUTCMonth() => number;
    getUTCSeconds() => number;
    setDate(date) => number;
    setFullYear(year, month?, date?) => number;
    setHours(hours, min?, sec?, ms?) => number;
    setMilliseconds(ms) => number;
    setMinutes(min, sec?, ms?) => number;
    setMonth(month, date?) => number;
    setSeconds(sec, ms?) => number;
    setTime(time) => number;
    setUTCDate(date) => number;
    setUTCFullYear(year, month?, date?) => number;
    setUTCHours(hours, min?, sec?, ms?) => number;
    setUTCMilliseconds(ms) => number;
    setUTCMinutes(min, sec?, ms?) => number;
    setUTCMonth(month, date?) => number;
    setUTCSeconds(sec, ms?) => number;
    toDateString() => string;
    toISOString() => string;
    toJSON(key?) => string;
    toLocaleDateString() => string;
    toLocaleDateString(locales?, options?) => string;
    toLocaleDateString(locales?, options?) => string;
    toLocaleString() => string;
    toLocaleString(locales?, options?) => string;
    toLocaleString(locales?, options?) => string;
    toLocaleTimeString() => string;
    toLocaleTimeString(locales?, options?) => string;
    toLocaleTimeString(locales?, options?) => string;
    toString() => string;
    toTimeString() => string;
    toUTCString() => string;
    valueOf() => number;
}

The current time of WWT internal clock. In normal operation this variable will change with every rendered WWT frame, or every 30 ms or so.

In WWTAwareComponent this item is exposed under the name wwtCurrentTime.

Type declaration

  • getVarDate: (() => VarDate)
      • (): VarDate

      • Returns VarDate

  • [toPrimitive]:function
    • [toPrimitive](hint): string

    • Converts a Date object to a string.

      Parameters

      • hint: "default"

      Returns string

    • [toPrimitive](hint): string

    • Converts a Date object to a string.

      Parameters

      • hint: "string"

      Returns string

    • [toPrimitive](hint): number

    • Converts a Date object to a number.

      Parameters

      • hint: "number"

      Returns number

    • [toPrimitive](hint): string | number

    • Converts a Date object to a string or number.

      Parameters

      • hint: string

        The strings "number", "string", or "default" to specify what primitive to return.

      Returns string | number

      A number if 'hint' was "number", a string if 'hint' was "string" or "default".

      Throws

      If 'hint' was given something other than "number", "string", or "default".

  • getDate:function
    • getDate(): number

    • Gets the day-of-the-month, using local time.

      Returns number

  • getDay:function
    • getDay(): number

    • Gets the day of the week, using local time.

      Returns number

  • getFullYear:function
    • getFullYear(): number

    • Gets the year, using local time.

      Returns number

  • getHours:function
    • getHours(): number

    • Gets the hours in a date, using local time.

      Returns number

  • getMilliseconds:function
    • getMilliseconds(): number

    • Gets the milliseconds of a Date, using local time.

      Returns number

  • getMinutes:function
    • getMinutes(): number

    • Gets the minutes of a Date object, using local time.

      Returns number

  • getMonth:function
    • getMonth(): number

    • Gets the month, using local time.

      Returns number

  • getSeconds:function
    • getSeconds(): number

    • Gets the seconds of a Date object, using local time.

      Returns number

  • getTime:function
    • getTime(): number

    • Gets the time value in milliseconds.

      Returns number

  • getTimezoneOffset:function
    • getTimezoneOffset(): number

    • Gets the difference in minutes between the time on the local computer and Universal Coordinated Time (UTC).

      Returns number

  • getUTCDate:function
    • getUTCDate(): number

    • Gets the day-of-the-month, using Universal Coordinated Time (UTC).

      Returns number

  • getUTCDay:function
    • getUTCDay(): number

    • Gets the day of the week using Universal Coordinated Time (UTC).

      Returns number

  • getUTCFullYear:function
    • getUTCFullYear(): number

    • Gets the year using Universal Coordinated Time (UTC).

      Returns number

  • getUTCHours:function
    • getUTCHours(): number

    • Gets the hours value in a Date object using Universal Coordinated Time (UTC).

      Returns number

  • getUTCMilliseconds:function
    • getUTCMilliseconds(): number

    • Gets the milliseconds of a Date object using Universal Coordinated Time (UTC).

      Returns number

  • getUTCMinutes:function
    • getUTCMinutes(): number

    • Gets the minutes of a Date object using Universal Coordinated Time (UTC).

      Returns number

  • getUTCMonth:function
    • getUTCMonth(): number

    • Gets the month of a Date object using Universal Coordinated Time (UTC).

      Returns number

  • getUTCSeconds:function
    • getUTCSeconds(): number

    • Gets the seconds of a Date object using Universal Coordinated Time (UTC).

      Returns number

  • setDate:function
    • setDate(date): number

    • Sets the numeric day-of-the-month value of the Date object using local time.

      Parameters

      • date: number

        A numeric value equal to the day of the month.

      Returns number

  • setFullYear:function
    • setFullYear(year, month?, date?): number

    • Sets the year of the Date object using local time.

      Parameters

      • year: number

        A numeric value for the year.

      • Optional month: number

        A zero-based numeric value for the month (0 for January, 11 for December). Must be specified if numDate is specified.

      • Optional date: number

        A numeric value equal for the day of the month.

      Returns number

  • setHours:function
    • setHours(hours, min?, sec?, ms?): number

    • Sets the hour value in the Date object using local time.

      Parameters

      • hours: number

        A numeric value equal to the hours value.

      • Optional min: number

        A numeric value equal to the minutes value.

      • Optional sec: number

        A numeric value equal to the seconds value.

      • Optional ms: number

        A numeric value equal to the milliseconds value.

      Returns number

  • setMilliseconds:function
    • setMilliseconds(ms): number

    • Sets the milliseconds value in the Date object using local time.

      Parameters

      • ms: number

        A numeric value equal to the millisecond value.

      Returns number

  • setMinutes:function
    • setMinutes(min, sec?, ms?): number

    • Sets the minutes value in the Date object using local time.

      Parameters

      • min: number

        A numeric value equal to the minutes value.

      • Optional sec: number

        A numeric value equal to the seconds value.

      • Optional ms: number

        A numeric value equal to the milliseconds value.

      Returns number

  • setMonth:function
    • setMonth(month, date?): number

    • Sets the month value in the Date object using local time.

      Parameters

      • month: number

        A numeric value equal to the month. The value for January is 0, and other month values follow consecutively.

      • Optional date: number

        A numeric value representing the day of the month. If this value is not supplied, the value from a call to the getDate method is used.

      Returns number

  • setSeconds:function
    • setSeconds(sec, ms?): number

    • Sets the seconds value in the Date object using local time.

      Parameters

      • sec: number

        A numeric value equal to the seconds value.

      • Optional ms: number

        A numeric value equal to the milliseconds value.

      Returns number

  • setTime:function
    • setTime(time): number

    • Sets the date and time value in the Date object.

      Parameters

      • time: number

        A numeric value representing the number of elapsed milliseconds since midnight, January 1, 1970 GMT.

      Returns number

  • setUTCDate:function
    • setUTCDate(date): number

    • Sets the numeric day of the month in the Date object using Universal Coordinated Time (UTC).

      Parameters

      • date: number

        A numeric value equal to the day of the month.

      Returns number

  • setUTCFullYear:function
    • setUTCFullYear(year, month?, date?): number

    • Sets the year value in the Date object using Universal Coordinated Time (UTC).

      Parameters

      • year: number

        A numeric value equal to the year.

      • Optional month: number

        A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. Must be supplied if numDate is supplied.

      • Optional date: number

        A numeric value equal to the day of the month.

      Returns number

  • setUTCHours:function
    • setUTCHours(hours, min?, sec?, ms?): number

    • Sets the hours value in the Date object using Universal Coordinated Time (UTC).

      Parameters

      • hours: number

        A numeric value equal to the hours value.

      • Optional min: number

        A numeric value equal to the minutes value.

      • Optional sec: number

        A numeric value equal to the seconds value.

      • Optional ms: number

        A numeric value equal to the milliseconds value.

      Returns number

  • setUTCMilliseconds:function
    • setUTCMilliseconds(ms): number

    • Sets the milliseconds value in the Date object using Universal Coordinated Time (UTC).

      Parameters

      • ms: number

        A numeric value equal to the millisecond value.

      Returns number

  • setUTCMinutes:function
    • setUTCMinutes(min, sec?, ms?): number

    • Sets the minutes value in the Date object using Universal Coordinated Time (UTC).

      Parameters

      • min: number

        A numeric value equal to the minutes value.

      • Optional sec: number

        A numeric value equal to the seconds value.

      • Optional ms: number

        A numeric value equal to the milliseconds value.

      Returns number

  • setUTCMonth:function
    • setUTCMonth(month, date?): number

    • Sets the month value in the Date object using Universal Coordinated Time (UTC).

      Parameters

      • month: number

        A numeric value equal to the month. The value for January is 0, and other month values follow consecutively.

      • Optional date: number

        A numeric value representing the day of the month. If it is not supplied, the value from a call to the getUTCDate method is used.

      Returns number

  • setUTCSeconds:function
    • setUTCSeconds(sec, ms?): number

    • Sets the seconds value in the Date object using Universal Coordinated Time (UTC).

      Parameters

      • sec: number

        A numeric value equal to the seconds value.

      • Optional ms: number

        A numeric value equal to the milliseconds value.

      Returns number

  • toDateString:function
    • toDateString(): string

    • Returns a date as a string value.

      Returns string

  • toISOString:function
    • toISOString(): string

    • Returns a date as a string value in ISO format.

      Returns string

  • toJSON:function
    • toJSON(key?): string

    • Used by the JSON.stringify method to enable the transformation of an object's data for JavaScript Object Notation (JSON) serialization.

      Parameters

      • Optional key: any

      Returns string

  • toLocaleDateString:function
    • toLocaleDateString(): string

    • Returns a date as a string value appropriate to the host environment's current locale.

      Returns string

    • toLocaleDateString(locales?, options?): string

    • Converts a date to a string by using the current or specified locale.

      Parameters

      • Optional locales: string | string[]

        A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.

      • Optional options: DateTimeFormatOptions

        An object that contains one or more properties that specify comparison options.

      Returns string

    • toLocaleDateString(locales?, options?): string

    • Converts a date to a string by using the current or specified locale.

      Parameters

      • Optional locales: LocalesArgument

        A locale string, array of locale strings, Intl.Locale object, or array of Intl.Locale objects that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.

      • Optional options: DateTimeFormatOptions

        An object that contains one or more properties that specify comparison options.

      Returns string

  • toLocaleString:function
    • toLocaleString(): string

    • Returns a value as a string value appropriate to the host environment's current locale.

      Returns string

    • toLocaleString(locales?, options?): string

    • Converts a date and time to a string by using the current or specified locale.

      Parameters

      • Optional locales: string | string[]

        A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.

      • Optional options: DateTimeFormatOptions

        An object that contains one or more properties that specify comparison options.

      Returns string

    • toLocaleString(locales?, options?): string

    • Converts a date and time to a string by using the current or specified locale.

      Parameters

      • Optional locales: LocalesArgument

        A locale string, array of locale strings, Intl.Locale object, or array of Intl.Locale objects that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.

      • Optional options: DateTimeFormatOptions

        An object that contains one or more properties that specify comparison options.

      Returns string

  • toLocaleTimeString:function
    • toLocaleTimeString(): string

    • Returns a time as a string value appropriate to the host environment's current locale.

      Returns string

    • toLocaleTimeString(locales?, options?): string

    • Converts a time to a string by using the current or specified locale.

      Parameters

      • Optional locales: string | string[]

        A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.

      • Optional options: DateTimeFormatOptions

        An object that contains one or more properties that specify comparison options.

      Returns string

    • toLocaleTimeString(locales?, options?): string

    • Converts a time to a string by using the current or specified locale.

      Parameters

      • Optional locales: LocalesArgument

        A locale string, array of locale strings, Intl.Locale object, or array of Intl.Locale objects that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.

      • Optional options: DateTimeFormatOptions

        An object that contains one or more properties that specify comparison options.

      Returns string

  • toString:function
    • toString(): string

    • Returns a string representation of a date. The format of the string depends on the locale.

      Returns string

  • toTimeString:function
    • toTimeString(): string

    • Returns a time as a string value.

      Returns string

  • toUTCString:function
    • toUTCString(): string

    • Returns a date converted to a string using Universal Coordinated Time (UTC).

      Returns string

  • valueOf:function
    • valueOf(): number

    • Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC.

      Returns number

decRad

decRad: number

The current declination of the center of the WWT view, in radians.

TODO: define the meaning here for view modes other than "sky."

In WWTAwareComponent this item is exposed under the name wwtDecRad.

foregroundImageset

foregroundImageset: null | {
    getHashCode() => number;
    get_altUrl() => string;
    get_bandPass() => BandPass;
    get_baseLevel() => number;
    get_baseTileDegrees() => number;
    get_bottomsUp() => boolean;
    get_centerX() => number;
    get_centerY() => number;
    get_children() => Thumbnail[];
    get_creditsText() => string;
    get_creditsUrl() => string;
    get_dataSetType() => ImageSetType;
    get_defaultSet() => boolean;
    get_demUrl() => string;
    get_elevationModel() => boolean;
    get_extension() => string;
    get_fitsProperties() => FitsProperties;
    get_generic() => boolean;
    get_hipsProperties() => null | HipsProperties;
    get_imageSetID() => number;
    get_isCloudCommunityItem() => boolean;
    get_isFolder() => boolean;
    get_isImage() => boolean;
    get_isTour() => boolean;
    get_levels() => number;
    get_meanRadius() => number;
    get_mercator() => boolean;
    get_name() => string;
    get_offsetX() => number;
    get_offsetY() => number;
    get_projection() => ProjectionType;
    get_quadTreeTileMap() => string;
    get_readOnly() => boolean;
    get_referenceFrame() => string;
    get_rotation() => number;
    get_singleImage() => boolean;
    get_sparse() => boolean;
    get_thumbnailUrl() => string;
    get_url() => string;
    get_wcsImage() => null | WcsImage;
    get_widthFactor() => number;
    set_altUrl(url) => string;
    set_bandPass(bp) => BandPass;
    set_baseLevel(bl) => number;
    set_baseTileDegrees(v) => number;
    set_bottomsUp(bu) => boolean;
    set_centerX(cx) => number;
    set_centerY(cy) => number;
    set_creditsText(ct) => string;
    set_creditsUrl(cu) => string;
    set_dataSetType(st) => ImageSetType;
    set_defaultSet(ds) => boolean;
    set_demUrl(url) => string;
    set_elevationModel(em) => boolean;
    set_extension(ext) => string;
    set_generic(g) => boolean;
    set_imageSetID(id) => number;
    set_levels(levels) => number;
    set_meanRadius(mr) => number;
    set_mercator(m) => boolean;
    set_name(name) => string;
    set_offsetX(ox) => number;
    set_offsetY(oy) => number;
    set_projection(pt) => ProjectionType;
    set_quadTreeTileMap(qttm) => string;
    set_referenceFrame(rf) => string;
    set_rotation(r) => number;
    set_singleImage(si) => boolean;
    set_sparse(s) => boolean;
    set_thumbnailUrl(url) => string;
    set_url(url) => string;
    set_wcsImage(w) => null | WcsImage;
    set_widthFactor(f) => number;
}

The current foreground Imageset, or null if it is undefined.

You can cause this state variable to change using the setForegroundImageByName mutation.

In WWTAwareComponent this item is exposed under the name wwtForegroundImageset.

Type declaration

foregroundOpacity

foregroundOpacity: number

The opacity of the foreground imageset. Values range between 0 (invisible) and 100 (fully opaque).

In WWTAwareComponent this item is exposed under the name wwtForegroundOpacity.

imagesetLayers

imagesetLayers: {
    [guidtext: string]: ImageSetLayerState;
}

A table of activated imageset layers.

Use imagesetStateForLayer to access information about a particular layer.

In WWTAwareComponent this item is exposed under the name wwtImagesetLayers.

Type declaration

isTourPlayerActive

isTourPlayerActive: boolean

Whether a tour has been loaded up and is available for playback.

In WWTAwareComponent this item is exposed under the name wwtIsTourPlayerActive.

isTourPlaying

isTourPlaying: boolean

Whether a tour is actively playing back right now. This can spontaneously become false if the tour completes playing.

In WWTAwareComponent this item is exposed under the name wwtIsTourPlaying.

raRad

raRad: number

The current right ascension of the center of the WWT view, in radians.

TODO: define the meaning here for view modes other than "sky."

In WWTAwareComponent this item is exposed under the name wwtRARad.

renderType

renderType: ImageSetType

The current mode of the WWT renderer.

This is derived from the "type" of the active background imageset. To change the mode, change the background imageset with setBackgroundImageByName.

In WWTAwareComponent this item is exposed under the name wwtRenderType.

rollRad

rollRad: number

The current roll of the view camera, in radians.

In WWTAwareComponent this item is exposed under the name wwtRollRad.

showWebGl2Warning

showWebGl2Warning: boolean

Whether or not to show a warning about recommending WebGL 2

In WWTAwareComponent this item is exposed under the name wwtShowWebGl2Warning.

spreadSheetLayers

spreadSheetLayers: {
    [guidtext: string]: SpreadSheetLayerState;
}

A table of activated imageset layers.

Use imagesetStateForLayer to access information about a particular layer.

In WWTAwareComponent this item is exposed under the name wwtSpreadSheetLayers.

Type declaration

  • [guidtext: string]: SpreadSheetLayerState

timeAtStartup

timeAtStartup: number

The time at which the Vue/Pinia system started up.

tourCompletions

tourCompletions: number

The number of times that a WWT tour has completed playing.

The main use of this state variable is that you can watch for changes to it and be alerted when a tour finishes. Watching isTourPlaying doesn't suffice because that will trigger when a tour is paused.

In WWTAwareComponent this item is exposed under the name wwtTourCompletions.

tourRunTime

tourRunTime: null | number

The total runtime of the current tour, in seconds, if there is one.

In WWTAwareComponent this item is exposed under the name wwtTourRunTime.

tourStopStartTimes

tourStopStartTimes: number[]

The timecodes at which the current tour’s "stops" begin, in seconds.

Each WWT tour is composed of one or more "stops", each of which has a fixed wall-clock duration. This variable gives the start times of the stops under the assumption that they all follow one another in sequence. It is possible to have nonlinear flow from one stop to the next.

If no tour is loaded, this is an empty array.

In WWTAwareComponent this item is exposed under the name wwtTourStopStartTimes.

tourTimecode

tourTimecode: number

The "timecode" of the current tour playback progression.

The "timecode" is approximately the number of seconds elapsed since tour playback began. More precisely, however, it is the start time of the current tour stop, plus however much wall-clock time has elapsed while at that stop. Because it is possible for stops to link to each other non-linearly, it is also possible for the timecode to progress non-linearly even when the tour plays back without user interaction.

In combination with tourStopStartTimes, you can use this value to determine the index number of the currently active tour stop.

If no tour is loaded, this is zero.

In WWTAwareComponent this item is exposed under the name wwtTourTimecode.

zoomDeg

zoomDeg: number

The WWT zoom level, in degrees.

TODO: define the semantics here in 3D and other modes.

In 2D sky mode, the zoom level is the angular height of the viewport, times six.

In WWTAwareComponent this item is exposed under the name wwtZoomDeg.

Methods

Readonly activeImagesetLayerStates

activeImagesetLayerStates

Get the reactive state for the active imageset layers

These layers are created using the addImageSetLayer action. The state structures returned by this function are part of the reactive store, so you can wire them up to your UI and they will update correctly. The list is returned in the engine's render order.

Returns

The layer states

addAnnotation

addCatalogHipsByName

  • Add a "catalog HiPS" dataset to the current view, by name.

    If the catalog name is not in the engine's registry, the promise rejects.

    Parameters

    • options: AddCatalogHipsByNameOptions

    Returns Promise<Imageset>

addImageSetLayer

  • Request the creation of a image layer. Either a single FITS or an image set.

    The action resolves to a new ImageSetLayer instance. It’s asynchronous because the requested url has to be downloaded.

    Parameters

    • options: AddImageSetLayerOptions

    Returns Promise<ImageSetLayer>

addImagesetToRepository

  • Add an imageset directly into the engine's database.

    If an imageset with the same URL has already been loaded, this is a no-op.

    This returns the imageset that ultimately resides in the engine's database. It could either be the input argument, if it was newly added, or a pre-existing imageset in the no-op condition.

    Parameters

    • imgset: Imageset

    Returns Imageset

applyFitsLayerSettings

  • Alter one or more settings of the specified FITS image layer as specified in the options.

    Parameters

    • options: ApplyFitsLayerSettingsOptions

    Returns void

applySetting

applyTableLayerSettings

  • Alter one or more settings of the specified tabular data layers as specified in the options.

    Parameters

    • options: ApplyTableLayerSettingsOptions

    Returns void

captureFrame

  • Capture the current frame as an image Blob with the desired width, height, and format. The first argument is a callback function to execute on the created Blob.

    Parameters

    • options: CaptureFrameOptions

    Returns Promise<null | Blob>

captureVideo

  • Capture a video as a stream of image Blobs with the desired width, height and format. The number of frames per second and total frame count are specified as well.

    Parameters

    • options: CaptureVideoOptions

    Returns ReadableStream<null | Blob>

Readonly catalogLayerKey

clearAnnotations

clearTileCache

  • Clear the current cache of tiles. The intended use case here is if a network issue caused a necessary tile to not load. This should only be used when necessary, as any previously downloaded tiles will need to be re-fetched.

    Returns void

closeTourPlayer

  • Close the active tour player, if there is one active.

    Any tour that is currently playing will be stopped.

    Returns void

createTableLayer

deleteLayer

  • Delete the specified layer from the layer manager.

    A layer may be identified by either its name or its id.

    Parameters

    • id: string | Guid

    Returns void

Readonly findRADecForScreenPoint

  • Get the right ascension and declination, in degrees, for x, y coordinates on the screen

    Parameters

    • pt: {
          x: number;
          y: number;
      }
      • x: number
      • y: number

    Returns {
        dec: number;
        ra: number;
    }

    • dec: number
    • ra: number

Readonly findScreenPointForRADec

  • Given an RA and Dec position, return the x, y coordinates of the screen point

    Parameters

    • pt: {
          dec: number;
          ra: number;
      }
      • dec: number
      • ra: number

    Returns {
        x: number;
        y: number;
    }

    • x: number
    • y: number

getCatalogHipsDataInView

  • Request an export of the catalog HiPS data within the current viewport.

    Parameters

    • options: GetCatalogHipsDataInViewOptions

    Returns Promise<InViewReturnMessage>

gotoRADecZoom

  • Command the view to steer to a specific configuration.

    The async action completes when the view arrives, or when a subsequent view command overrides this one.

    TODO: document semantics when not in 2D sky mode!

    Parameters

    Returns Promise<void>

gotoTarget

  • Command the view to steer as specified in the options.

    The async action completes when the view arrives, or when a subsequent view command overrides this one.

    Parameters

    • options: GotoTargetOptions

    Returns Promise<void>

Readonly imagesetForLayer

  • Look up the WWT engine object for an active imageset layer.

    This getter gets the WWT Imageset object associated with an imageset layer. The returned object is not part of the Vue(x) reactivity system, so you shouldn't use it to set up UI elements, but you can obtain more detailed information about the imageset than is stored in the state management system. For UI purposes, use imagesetStateForLayer.

    Parameters

    • guidtext: string

      The GUID of the layer to query, as a string

    Returns null | Imageset

    The layer's underlying imageset, or null if the GUID is unrecognized

Readonly imagesetLayerById

  • Get the actual WWT ImageSetLayer for the imageset layer with the given ID.

    Do not use this function for UI purposes -- the WWT layer object is not integrated into the reactive state system, and so if you use it as a basis for UI elements, those elements will not be updated properly if/when the layer's settings change. Use imagesetStateForLayer instead.

    Parameters

    • id: string

      The imageset layer's identifier.

    Returns null | ImageSetLayer

Readonly imagesetStateForLayer

  • Look up the reactive state for an active imageset layer.

    These layers are created using the addImageSetLayer action. The state returned by this function is part of the reactive store, so you can wire it up to your UI and it will update as the layer settings are changed. If you need "runtime" state not captured in the reactivity system, you may need to use imagesetForLayer instead.

    Parameters

    • guidtext: string

      The GUID of the layer to query, as a string

    Returns null | ImageSetLayerState

    The layer state, or null if the GUID is unrecognized

Readonly layerById

  • Get the actual WWT Layer for the layer with the given ID.

    Do not use this function for UI purposes -- the WWT layer object is not integrated into the reactive state system, and so if you use it as a basis for UI elements, those elements will not be updated properly if/when the layer's settings change. If you know the specific type of your layer, you can use functions like imagesetStateForLayer or spreadSheetStateById to get reactive data structures.

    Parameters

    • id: string

      The layer's identifier.

    Returns null | Layer

Readonly layerForHipsCatalog

  • Get the actual WWT SpreadSheetLayer for the named HiPS catalog.

    Do not use this function for UI purposes -- the WWT layer object is not integrated into the reactive state system, and so if you use it as a basis for UI elements, those elements will not be updated properly if/when the layer's settings change. Use spreadsheetStateForHipsCatalog instead.

    Parameters

    • name: string

      The datasetName of the HiPS catalog

    Returns null | SpreadSheetLayer

loadFitsLayer

  • Deprecated. Use addImageSetLayer instead. Request the creation of a FITS image layer.

    The action resolves to a new ImageSetLayer instance. It’s asynchronous because the requested FITS file has to be downloaded.

    Parameters

    • options: LoadFitsLayerOptions

    Returns Promise<ImageSetLayer>

loadImageCollection

  • Request the engine to load the specified image collection.

    The image collection is a WTML file Images in collections loaded this way become usable for name-based lookup by interfaces such as setForegroundImageByName.

    The action resolves to a Folder instance. It’s asynchronous because the specified WTML file has to be downloaded.

    Parameters

    Returns Promise<Folder>

loadTour

  • Request the engine to load a tour file.

    The action resolves when the load is complete. It’s asynchronous because the full WTT tour file has to be downloaded.

    Parameters

    Returns Promise<void>

Readonly lookupImageset

  • Look up an Imageset in the engine’s table of ones with registered names.

    This delegates to WWTControl.getImagesetByName(), which has very eager name-matching rules. But if nothing matches, null is returned.

    Imagesets are not added to the engine’s list of names automatically. In order for an imageset to be findable by this function, its containing folder must have been loaded using the loadImageCollection action.

    Parameters

    • imagesetName: string

    Returns null | Imageset

move

  • Moves the position of the view

    Parameters

    • args: {
          x: number;
          y: number;
      }
      • x: number
      • y: number

    Returns void

removeAnnotation

removeCatalogHipsByName

  • Remove a "catalog HiPS" dataset to the current view, by name.

    Parameters

    • name: string

    Returns void

seekToTourTimecode

  • Seek tour playback to the specified timecode.

    See tourTimecode for a definition of the tour timecode.

    An important limitation is that the engine can only seek to the very beginning of a tour stop. If you request a timecode in the middle of a slide, the seek will actually occur to the start time of that slide.

    Parameters

    • value: number

    Returns void

setBackgroundImageByName

  • Set the current background Imageset based on its name.

    The name lookup here is effectively done using lookupImageset. If the name is not found, the current background imageset remains unchanged.

    Changing the background imageset may change the value of renderType, and the overall "mode" of the WWT renderer.

    Parameters

    • imagesetName: string

    Returns void

setClockRate

  • Set the rate at which the WWT clock progresses compared to wall-clock time.

    A value of 10 means that the WWT clock progresses ten times faster than real time. A value of -0.1 means that the WWT clock moves backwards, ten times slower than real time.

    Altering this causes an increment in clockDiscontinuities.

    Parameters

    • rate: number

    Returns void

setClockSync

setFitsLayerColormap

  • Set the colormap used for a FITS image layer according to the options.

    Parameters

    • options: SetFitsLayerColormapOptions

    Returns void

setForegroundImageByName

  • Set the current foreground Imageset based on its name.

    The name lookup here is effectively done using lookupImageset. If the name is not found, the current foreground imageset remains unchanged.

    Parameters

    • imagesetName: string

    Returns void

setForegroundOpacity

  • Set the opacity of the foreground imageset.

    Valid values are between 0 (invisible) and 100 (fully opaque).

    Parameters

    • opacity: number

    Returns void

setImageSetLayerOrder

setTime

setTourPlayerLeaveSettingsWhenStopped

  • Set whether the renderer settings of tours should remain applied after those tours finish playing back.

    This specialized option helps avoid jarring visual effects when tours finish playing. If a tour activates a renderer option like "local horizon mode", by default that option will turn off when the tour finishes, causing the view to suddenly change. If this option is set to True, that setting will remain active, preventing the sudden change.

    Parameters

    • value: boolean

    Returns void

setTrackedObject

setupForImageset

  • Set up the background and foreground imagesets according to the options

    The main use of this interface is that it provides a mechanism to guess the appropriate background imageset given a foreground imageset that you want to show.

    Parameters

    Returns void

Readonly spreadSheetLayer

  • Get the actual WWT SpreadSheetLayer for the table layer corresponding to the given CatalogLayerInfo.

    Do not use this function for UI purposes -- the WWT layer object is not integrated into the reactive state system, and so if you use it as a basis for UI elements, those elements will not be updated properly if/when the layer's settings change. Use spreadsheetState instead.

    Parameters

    Returns null | SpreadSheetLayer

Readonly spreadSheetLayerById

  • Get the actual WWT SpreadSheetLayer for the table layer with the given ID.

    Do not use this function for UI purposes -- the WWT layer object is not integrated into the reactive state system, and so if you use it as a basis for UI elements, those elements will not be updated properly if/when the layer's settings change. Use spreadsheetState instead.

    Parameters

    • id: string

      The table layer's identifier.

    Returns null | SpreadSheetLayer

Readonly spreadsheetState

  • Get reactive SpreadSheetLayer settings for the table layer corresponding to the given CatalogLayerInfo.

    The returned data structure is a component of the app's reactive state. You can therefore use the settings to construct UI elements, and they will update reactively as the state evolves. The actual data structures used by WWT are separate, but the two mirror each other.

    Parameters

    • catalog: CatalogLayerInfo

      A CatalogLayerInfo object corresponding to the layer.

    Returns null | SpreadSheetLayerSettingsInterfaceRO

Readonly spreadsheetStateById

  • Get reactive SpreadSheetLayer settings for the table layer with the given ID.

    The returned data structure is a component of the app's reactive state. You can therefore use the settings to construct UI elements, and they will update reactively as the state evolves. The actual data structures used by WWT are separate, but the two mirror each other.

    Parameters

    • id: string

      The identifier of the table layer.

    Returns null | SpreadSheetLayerSettingsInterfaceRO

Readonly spreadsheetStateForHipsCatalog

  • Get reactive SpreadSheetLayer settings for the named HiPS catalog.

    The returned data structure is a component of the app's reactive state. You can therefore use the settings to construct UI elements, and they will update reactively as the state evolves. The actual data structures used by WWT are separate, but the two mirror each other.

    Parameters

    • name: string

      The datasetName of the HiPS catalog

    Returns null | SpreadSheetLayerSettingsInterfaceRO

startTour

  • Start playback of the currently loaded tour.

    Nothing happens if no tour is loaded.

    Returns void

stopTour

  • Stop playing the currently loaded tour.

    Nothing happens if no tour is currently playing.

    Returns void

stretchFitsLayer

tilt

  • Tilts the position of the view

    Parameters

    • args: {
          x: number;
          y: number;
      }
      • x: number
      • y: number

    Returns void

timeToRADecZoom

toggleTourPlayPauseState

  • Toggle the play/pause state of the current tour.

    Nothing happens if no tour is loaded.

    Returns void

updateTableLayer

viewAsTourXml

  • Get the current view as a one-slide tour, serialized to XML

    Parameters

    • name: string

    Returns Promise<null | string>

waitForReady

  • Wait for the WWT engine to become ready for usage.

    You should invoke this action and wait for is completion before trying to do anything else with a WWT-aware component. The action resolves when the WWT engine has completed its initialization, which involes the download of some supporting data files.

    Returns Promise<void>

zoom

  • Set the zoom level of the view.

    This action may result in an action that takes a perceptible amount of time to resolve, if the "smooth pan" renderer option is enabled. To have proper asynchronous feedback about when the zoom operation completes, use gotoRADecZoom.

    Parameters

    • factor: number

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc