Namespace classicPywwt

Messages created for older versions of the pywwt Python package.

These can be grouped into the following categories:

View Control

Image set Layers

Data Table Layers

Image Sets

Annotations

Tours

Miscellaneous

ModifySettingMessage

Index

Interfaces

Type aliases

Functions

Type aliases

PywwtMessage

PywwtSpreadSheetLayerSetting

PywwtSpreadSheetLayerSetting: ["altColumn", string | number] | ["altType", string] | ["altUnit", string] | ["astronomical", boolean] | ["barChartBitmask", number] | ["beginRange", Date] | ["cartesianCustomScale", number] | ["cartesianScale", string] | ["color", string] | ["colorMapColumn", string | number] | ["colorMapperName", string] | ["coordinatesType", string] | ["decay", number] | ["dynamicColor", boolean] | ["dynamicData", boolean] | ["enabled", boolean] | ["endDateColumn", string | number] | ["endRange", Date] | ["fadeSpan", number] | ["geometryColumn", string | number] | ["hyperlinkColumn", string | number] | ["hyperlinkFormat", string] | ["latColumn", string | number] | ["lngColumn", string | number] | ["markerColumn", string | number] | ["markerIndex", number] | ["markerScale", string] | ["name", string] | ["nameColumn", string | number] | ["normalizeColorMap", boolean] | ["normalizeColorMapMax", number] | ["normalizeColorMapMin", number] | ["normalizeSize", boolean] | ["normalizeSizeClip", boolean] | ["normalizeSizeMax", number] | ["normalizeSizeMin", number] | ["opacity", number] | ["opened", boolean] | ["plotType", string] | ["pointScaleType", number] | ["raUnits", string] | ["referenceFrame", string] | ["scaleFactor", number] | ["showFarSide", boolean] | ["sizeColumn", string | number] | ["startDateColumn", string | number] | ["timeSeries", boolean] | ["version", number] | ["xAxisColumn", string | number] | ["xAxisReverse", boolean] | ["yAxisColumn", string | number] | ["yAxisReverse", boolean] | ["zAxisColumn", string | number] | ["zAxisReverse", boolean]

Spreadsheet/table layer setting values as serialized in pywwt. Enumerations are given stringy values, columns are mapped from indices to names, etc.

Functions

applyBaseUrlIfApplicable

applyBaseUrlIfApplicable(o: any, baseurl: string): void

- Defined in classic_pywwt.ts:867
If the input object is a classic pywwt message, rewrite any relative URLs that it contains.

The motivation for this function is to allow data exchange from a Jupyter(Lab) server to the WWT research app. It is possible to publish data by hooking into the Jupyter server, but that layer of code doesn't always know the URL at which it is exposed to the world. So, such layers need to supply relative URLs in their messages, and then the JavaScript layer needs to modify those messages to turn them into absolute URLs. That's what this function enables. The input is modified in-place.

Parameters
- o: any
- baseurl: string
Returns void

isAddLinePointMessage

isAddLinePointMessage(o: any): o is AddLinePointMessage

- Defined in classic_pywwt.ts:81
Type guard function for AddLinePointMessage.

Parameters
- o: any
Returns o is AddLinePointMessage

isAddPolygonPointMessage

isAddPolygonPointMessage(o: any): o is AddPolygonPointMessage

- Defined in classic_pywwt.ts:106
Type guard function for AddPolygonPointMessage.

Parameters
- o: any
Returns o is AddPolygonPointMessage

isCenterOnCoordinatesMessage

isCenterOnCoordinatesMessage(o: any): o is CenterOnCoordinatesMessage

- Defined in classic_pywwt.ts:142
Type guard function for CenterOnCoordinatesMessage.

Parameters
- o: any
Returns o is CenterOnCoordinatesMessage

isClearAnnotationsMessage

isClearAnnotationsMessage(o: any): o is ClearAnnotationsMessage

- Defined in classic_pywwt.ts:159
Type guard function for ClearAnnotationsMessage.

Parameters
- o: any
Returns o is ClearAnnotationsMessage

isCreateAnnotationMessage

isCreateAnnotationMessage(o: any): o is CreateAnnotationMessage

- Defined in classic_pywwt.ts:181
Type guard function for CreateAnnotationMessage.

Parameters
- o: any
Returns o is CreateAnnotationMessage

isCreateFitsLayerMessage

isCreateFitsLayerMessage(o: any): o is CreateFitsLayerMessage

- Defined in classic_pywwt.ts:252
Type guard function for CreateFitsLayerMessage.

These messages may not have a mode field, so that they can be distinguished from CreateImageSetLayerMessage instances.

Parameters
- o: any
Returns o is CreateFitsLayerMessage

isCreateImageSetLayerMessage

isCreateImageSetLayerMessage(o: any): o is CreateImageSetLayerMessage

- Defined in classic_pywwt.ts:222
Type guard function for CreateImageSetLayerMessage.

Parameters
- o: any
Returns o is CreateImageSetLayerMessage

isCreateTableLayerMessage

isCreateTableLayerMessage(o: any): o is CreateTableLayerMessage

- Defined in classic_pywwt.ts:298
Type guard function for CreateTableLayerMessage.

Parameters
- o: any
Returns o is CreateTableLayerMessage

isLoadImageCollectionCompletedMessage

isLoadImageCollectionCompletedMessage(o: any): o is LoadImageCollectionCompletedMessage

- Defined in classic_pywwt.ts:352
Type guard function for LoadImageCollectionCompletedMessage.

Parameters
- o: any
Returns o is LoadImageCollectionCompletedMessage

isLoadImageCollectionMessage

isLoadImageCollectionMessage(o: any): o is LoadImageCollectionMessage

- Defined in classic_pywwt.ts:329
Type guard function for LoadImageCollectionMessage.

Parameters
- o: any
Returns o is LoadImageCollectionMessage

isLoadTourMessage

isLoadTourMessage(o: any): o is LoadTourMessage

- Defined in classic_pywwt.ts:369
Type guard function for LoadTourMessage.

Parameters
- o: any
Returns o is LoadTourMessage

isModifyAnnotationMessage

isModifyAnnotationMessage(o: any): o is ModifyAnnotationMessage

- Defined in classic_pywwt.ts:395
Type guard function for ModifyAnnotationMessage.

Parameters
- o: any
Returns o is ModifyAnnotationMessage

isModifyFitsLayerMessage

isModifyFitsLayerMessage(o: any): o is ModifyFitsLayerMessage

- Defined in classic_pywwt.ts:423
Type guard function for ModifyFitsLayerMessage.

Parameters
- o: any
Returns o is ModifyFitsLayerMessage

isModifySettingMessage

isModifySettingMessage(o: any): o is ModifySettingMessage

- Defined in classic_pywwt.ts:448
Type guard function for ModifySettingMessage.

Parameters
- o: any
Returns o is ModifySettingMessage

isModifyTableLayerMessage

isModifyTableLayerMessage(o: any): o is ModifyTableLayerMessage

- Defined in classic_pywwt.ts:475
Type guard function for ModifyTableLayerMessage.

Parameters
- o: any
Returns o is ModifyTableLayerMessage

isPauseTimeMessage

isPauseTimeMessage(o: any): o is PauseTimeMessage

- Defined in classic_pywwt.ts:491
Type guard function for PauseTimeMessage.

Parameters
- o: any
Returns o is PauseTimeMessage

isPauseTourMessage

isPauseTourMessage(o: any): o is PauseTourMessage

- Defined in classic_pywwt.ts:504
Type guard function for PauseTourMessage.

Parameters
- o: any
Returns o is PauseTourMessage

isPywwtSpreadSheetLayerSetting

isPywwtSpreadSheetLayerSetting(obj: [string, any]): obj is PywwtSpreadSheetLayerSetting

- Defined in classic_pywwt.ts:1020
Type guard function for PywwtSpreadSheetSetting.

Parameters
- obj: [string, any]
Returns obj is PywwtSpreadSheetLayerSetting

isRemoveAnnotationMessage

isRemoveAnnotationMessage(o: any): o is RemoveAnnotationMessage

- Defined in classic_pywwt.ts:520
Type guard function for RemoveAnnotationMessage.

Parameters
- o: any
Returns o is RemoveAnnotationMessage

isRemoveImageSetLayerMessage

isRemoveImageSetLayerMessage(o: any): o is RemoveImageSetLayerMessage

- Defined in classic_pywwt.ts:537
Type guard function for RemoveImageSetLayerMessage.

Parameters
- o: any
Returns o is RemoveImageSetLayerMessage

isRemoveTableLayerMessage

isRemoveTableLayerMessage(o: any): o is RemoveTableLayerMessage

- Defined in classic_pywwt.ts:554
Type guard function for RemoveTableLayerMessage.

Parameters
- o: any
Returns o is RemoveTableLayerMessage

isResumeTimeMessage

isResumeTimeMessage(o: any): o is ResumeTimeMessage

- Defined in classic_pywwt.ts:571
Type guard function for ResumeTimeMessage.

Parameters
- o: any
Returns o is ResumeTimeMessage

isResumeTourMessage

isResumeTourMessage(o: any): o is ResumeTourMessage

- Defined in classic_pywwt.ts:590
Type guard function for ResumeTourMessage.

Parameters
- o: any
Returns o is ResumeTourMessage

isSetBackgroundByNameMessage

isSetBackgroundByNameMessage(o: any): o is SetBackgroundByNameMessage

- Defined in classic_pywwt.ts:606
Type guard function for SetBackgroundByNameMessage.

Parameters
- o: any
Returns o is SetBackgroundByNameMessage

isSetCircleCenterMessage

isSetCircleCenterMessage(o: any): o is SetCircleCenterMessage

- Defined in classic_pywwt.ts:632
Type guard function for SetCircleCenterMessage.

Parameters
- o: any
Returns o is SetCircleCenterMessage

isSetDatetimeMessage

isSetDatetimeMessage(o: any): o is SetDatetimeMessage

- Defined in classic_pywwt.ts:651
Type guard function for SetDatetimeMessage.

Parameters
- o: any
Returns o is SetDatetimeMessage

isSetFitsLayerColormapMessage

isSetFitsLayerColormapMessage(o: any): o is SetFitsLayerColormapMessage

- Defined in classic_pywwt.ts:678
Type guard function for SetFitsLayerColormapMessage.

Parameters
- o: any
Returns o is SetFitsLayerColormapMessage

isSetForegroundByNameMessage

isSetForegroundByNameMessage(o: any): o is SetForegroundByNameMessage

- Defined in classic_pywwt.ts:697
Type guard function for SetForegroundByNameMessage.

Parameters
- o: any
Returns o is SetForegroundByNameMessage

isSetForegroundOpacityMessage

isSetForegroundOpacityMessage(o: any): o is SetForegroundOpacityMessage

- Defined in classic_pywwt.ts:714
Type guard function for SetForegroundOpacityMessage.

Parameters
- o: any
Returns o is SetForegroundOpacityMessage

isSetLayerOrderMessage

isSetLayerOrderMessage(o: any): o is SetLayerOrderMessage

- Defined in classic_pywwt.ts:274
Type guard function for SetLayerOrderMessage.

Parameters
- o: any
Returns o is SetLayerOrderMessage

isSetViewerModeMessage

isSetViewerModeMessage(o: any): o is SetViewerModeMessage

- Defined in classic_pywwt.ts:738
Type guard function for SetViewerModeMessage.

Parameters
- o: any
Returns o is SetViewerModeMessage

isStretchFitsLayerMessage

isStretchFitsLayerMessage(o: any): o is StretchFitsLayerMessage

- Defined in classic_pywwt.ts:772
Type guard function for StretchFitsLayerMessage.

Parameters
- o: any
Returns o is StretchFitsLayerMessage

isTrackObjectMessage

isTrackObjectMessage(o: any): o is TrackObjectMessage

- Defined in classic_pywwt.ts:794
Type guard function for TrackObjectMessage.

Parameters
- o: any
Returns o is TrackObjectMessage

isUpdateTableLayerMessage

isUpdateTableLayerMessage(o: any): o is UpdateTableLayerMessage

- Defined in classic_pywwt.ts:814
Type guard function for UpdateTableLayerMessage.

Parameters
- o: any
Returns o is UpdateTableLayerMessage

Generated using TypeDoc