Skip to main content
Version: Next

CatalogDisplayStore

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

angleMax

angleMax: number = CatalogDisplayStore.MAX_ANGLE

angleMin

angleMin: number = CatalogDisplayStore.MIN_ANGLE

canvasSizeUnit

canvasSizeUnit: CatalogSizeUnits = CatalogSizeUnits.SCREENPIXEL

catalogColor

catalogColor: string = Colors.TURQUOISE3

catalogDisplayMode

catalogDisplayMode: CatalogDisplayMode = CatalogDisplayMode.CANVAS

catalogFileId

catalogFileId: number = 0

catalogPlotType

catalogPlotType: CatalogPlotType = CatalogPlotType.ImageOverlay

catalogShape

catalogShape: CatalogOverlayShape = CatalogOverlayShape.CIRCLE_LINED

catalogSize

catalogSize: number = 10.0

catalogSourceRadiusType

catalogSourceRadiusType: CatalogSourceRadiusMode = "diameter"

catalogSourceRadiusTypes

catalogSourceRadiusTypes: Map<CatalogSourceRadiusMode, { label: string; value: number }> = ...

colorColumnMax

colorColumnMax: { clipd: number | undefined; default: number | undefined } = ...

Type declaration

  • clipd: number | undefined
  • default: number | undefined

colorColumnMin

colorColumnMin: { clipd: number | undefined; default: number | undefined } = ...

Type declaration

  • clipd: number | undefined
  • default: number | undefined

colorMap

colorMap: string = ColorMap.Viridis

colorMapColumn

colorMapColumn: string = CatalogOverlay.NONE

colorScalingType

colorScalingType: FrameScaling = FrameScaling.LINEAR

dataTableColumnWidths

dataTableColumnWidths: number[] = []

hasAttemptedAutoSelectImageOverlayAxes

hasAttemptedAutoSelectImageOverlayAxes: boolean = false

hasPlottedImageOverlay

hasPlottedImageOverlay: boolean = false

headerTableColumnWidths

headerTableColumnWidths: number[] = ...

highlightColor

highlightColor: string = Colors.RED2

isCatalogTableAutoScrollEnabled

isCatalogTableAutoScrollEnabled: boolean = false

isInvertedColorMap

isInvertedColorMap: boolean = false

isShowingSelectedData

isShowingSelectedData: boolean = false

isSizeAreaMode

isSizeAreaMode: boolean = false

isSizeColumnMaxLocked

isSizeColumnMaxLocked: boolean = false

isSizeColumnMinLocked

isSizeColumnMinLocked: boolean = false

isSizeMinorAreaMode

isSizeMinorAreaMode: boolean = false

isSizeMinorColumnMaxLocked

isSizeMinorColumnMaxLocked: boolean = false

isSizeMinorColumnMinLocked

isSizeMinorColumnMinLocked: boolean = false

orientationMapColumn

orientationMapColumn: string = CatalogOverlay.NONE

orientationMax

orientationMax: { clipd: number | undefined; default: number | undefined } = ...

Type declaration

  • clipd: number | undefined
  • default: number | undefined

orientationMin

orientationMin: { clipd: number | undefined; default: number | undefined } = ...

Type declaration

  • clipd: number | undefined
  • default: number | undefined

orientationScalingType

orientationScalingType: FrameScaling = FrameScaling.LINEAR

plottedImageOverlayMaxRows

plottedImageOverlayMaxRows: number | undefined = undefined

plottedImageOverlaySystem

plottedImageOverlaySystem: CatalogSystemType | undefined = undefined

plottedImageOverlayXAxis

plottedImageOverlayXAxis: string = CatalogOverlay.NONE

plottedImageOverlayYAxis

plottedImageOverlayYAxis: string = CatalogOverlay.NONE

showedCatalogSize

showedCatalogSize: number = 10.0

sizeAxisTabId

sizeAxisTabId: SIZE_MAJOR | SIZE_MINOR = CatalogSettingsTabs.SIZE_MAJOR

sizeColumnMax

sizeColumnMax: { clipd: number | undefined; default: number | undefined } = ...

Type declaration

  • clipd: number | undefined
  • default: number | undefined

sizeColumnMin

sizeColumnMin: { clipd: number | undefined; default: number | undefined } = ...

Type declaration

  • clipd: number | undefined
  • default: number | undefined

sizeMapColumn

sizeMapColumn: string = CatalogOverlay.NONE

sizeMax

sizeMax: { area: number; diameter: number } = ...

Type declaration

  • area: number
  • diameter: number

sizeMin

sizeMin: { area: number; diameter: number } = ...

Type declaration

  • area: number
  • diameter: number

sizeMinorColumnMax

sizeMinorColumnMax: { clipd: number | undefined; default: number | undefined } = ...

Type declaration

  • clipd: number | undefined
  • default: number | undefined

sizeMinorColumnMin

sizeMinorColumnMin: { clipd: number | undefined; default: number | undefined } = ...

Type declaration

  • clipd: number | undefined
  • default: number | undefined

sizeMinorMapColumn

sizeMinorMapColumn: string = CatalogOverlay.NONE

sizeMinorMax

sizeMinorMax: { area: number; diameter: number } = ...

Type declaration

  • area: number
  • diameter: number

sizeMinorMin

sizeMinorMin: { area: number; diameter: number } = ...

Type declaration

  • area: number
  • diameter: number

sizeMinorScalingType

sizeMinorScalingType: FrameScaling = FrameScaling.LINEAR

sizeScalingType

sizeScalingType: FrameScaling = FrameScaling.LINEAR

thickness

thickness: number = 2.0

worldSizeUnit

worldSizeUnit: AngularSizeUnit = AngularSizeUnit.ARCSEC

xAxis

xAxis: string = CatalogOverlay.NONE

yAxis

yAxis: string = CatalogOverlay.NONE

publicstaticreadonlyMAX_ANGLE

MAX_ANGLE: 720 = 720

publicstaticreadonlyMAX_AREA_SIZE

MAX_AREA_SIZE: 4000 = 4000

publicstaticreadonlyMAX_OVERLAY_SIZE

MAX_OVERLAY_SIZE: 50 = 50

publicstaticreadonlyMAX_TABLE_SEPARATOR_POSITION

MAX_TABLE_SEPARATOR_POSITION: 100 = 100

publicstaticreadonlyMAX_THICKNESS

MAX_THICKNESS: 10 = 10

publicstaticreadonlyMIN_ANGLE

MIN_ANGLE: 0 = 0

publicstaticreadonlyMIN_OVERLAY_SIZE

MIN_OVERLAY_SIZE: 1 = 1

publicstaticreadonlyMIN_TABLE_SEPARATOR_POSITION

MIN_TABLE_SEPARATOR_POSITION: 0 = 0

publicstaticreadonlyMIN_THICKNESS

MIN_THICKNESS: 1 = 1.0

publicstaticreadonlySIZE_MAP_MIN

SIZE_MAP_MIN: 0 = 0

Accessors

colorMapData

  • get colorMapData(): Float32Array

  • Color data for catalog sources

    Returns Float32Array

colorScalingParameter

  • get colorScalingParameter(): number

  • Returns number

isAngularSize

  • get isAngularSize(): boolean

  • If the catalog source is in angular size

    Returns boolean

isColorMapDisabled

  • get isColorMapDisabled(): boolean

  • Returns boolean

isImagePixelSize

  • get isImagePixelSize(): boolean

  • If the catalog source is in image pixel

    Returns boolean

isOrientationMapDisabled

  • get isOrientationMapDisabled(): boolean

  • Returns boolean

isSizeMajor

  • get isSizeMajor(): boolean

  • Returns boolean

isSizeMapDisabled

  • get isSizeMapDisabled(): boolean

  • Returns boolean

isSizeMinorMapDisabled

  • get isSizeMinorMapDisabled(): boolean

  • Returns boolean

isSizeMinorTabEnabled

  • get isSizeMinorTabEnabled(): boolean

  • Returns boolean

isSourceSizeDefined

  • get isSourceSizeDefined(): boolean

  • Whether the sources have a size to be drawn at. An angular size is the size the source has on the sky, which only the mapped column states, so without one there is nothing to draw.

    Returns boolean

maxOverlaySize

  • get maxOverlaySize(): number

  • Returns number

maxPointSizebyType

  • get maxPointSizebyType(): number

  • Returns number

minorPointSizebyType

  • get minorPointSizebyType(): { max: number; min: number }

  • Returns { max: number; min: number }

    • max: number
    • min: number

minOverlaySize

  • get minOverlaySize(): number

  • Returns number

orientationMapData

  • get orientationMapData(): Float32Array

  • Orientation data for catalog sources

    Returns Float32Array

orientationScalingParameter

  • get orientationScalingParameter(): number

  • Returns number

pixelSizeFactor

  • get pixelSizeFactor(): number

  • The pixel size factor if plotting angular size (factor-to-arcsec / arcsec)

    Returns number

pointSizebyType

  • get pointSizebyType(): { max: number; min: number }

  • Returns { max: number; min: number }

    • max: number
    • min: number

shapeSettings

  • get shapeSettings(): { areaBase: number; diameterBase: number; featherWidth: number | undefined; thicknessBase: number | undefined } | undefined

  • Returns { areaBase: number; diameterBase: number; featherWidth: number | undefined; thicknessBase: number | undefined } | undefined

sizeMapData

  • get sizeMapData(): Float32Array

  • Size data for catalog sources

    Returns Float32Array

sizeMinorMapData

  • get sizeMinorMapData(): Float32Array

  • Minor size data for catalog sources

    Returns Float32Array

sizeMinorScalingParameter

  • get sizeMinorScalingParameter(): number

  • Returns number

sizeScalingParameter

  • get sizeScalingParameter(): number

  • Returns number

Methods

applyConfig

  • Apply a complete display config. The assignment order is deliberate and load bearing:

    1. display mode and size units, because the allowed source size depends on both
    2. mapped columns, whose change resets the clipped bounds of their own group
    3. scaling, sizes and the clipped bounds themselves
    4. the column locks last, so that restoring the minor axis is not overwritten by the major Data-derived values and widget presentation state are not part of a config and are left alone.

    Parameters

    Returns CatalogConfigApplyResult

applyConfigWhenReady

clearPlottedImageOverlayState

  • clearPlottedImageOverlayState(): void

  • Returns void

colorArray

  • colorArray(): Float32Array

  • Returns Float32Array

publicdispose

  • dispose(): void

  • Returns void

publicgetConfigForSerialization

  • Return the config waiting for catalog validation, if any, for workspace serialization.

    Returns WorkspaceCatalogConfig

handleCatalogRequestSuperseded

  • handleCatalogRequestSuperseded(requestId: number): void

  • Drop a restore whose data request was superseded before it could complete.

    Parameters

    • requestId: number

    Returns void

orientationArray

  • orientationArray(): Float32Array

  • Returns Float32Array

resetColorColumnValue

  • resetColorColumnValue(type: min | max): void

  • Reset the maximum or minimum values for color mapping data to default

    Parameters

    • type: min | max

      "min" or "max"

    Returns void

resetMaps

  • resetMaps(): void

  • Reset all settings of catalog source plot to default

    Returns void

resetOrientationValue

  • resetOrientationValue(type: min | max): void

  • Reset the orientation value for mapping data to default

    Parameters

    • type: min | max

      "min" or "max"

    Returns void

resetSize

  • resetSize(): void

  • Reset the maximum and minimum values for catalog source size to default

    Returns void

resetSizeColumnValue

  • resetSizeColumnValue(type: min | max): void

  • Reset the maximum or minimum values for size mapping data to default

    Parameters

    • type: min | max

      "min" or "max"

    Returns void

resetSizeMinorColumnValue

  • resetSizeMinorColumnValue(type: min | max): void

  • Reset the maximum or minimum values of minor axis for size mapping data to default

    Parameters

    • type: min | max

      "min" or "max"

    Returns void

setAngleMax

  • setAngleMax(max: number): void

  • Set the maximum orientation value

    Parameters

    • max: number

      max degree of orientation

    Returns void

setAngleMin

  • setAngleMin(min: number): void

  • Set the minimum orientation value

    Parameters

    • min: number

      min degree of orientation

    Returns void

setAutoSelectImageOverlayAxesAttempted

  • setAutoSelectImageOverlayAxesAttempted(hasAttemptedAutoSelectImageOverlayAxes: boolean): void

  • Parameters

    • hasAttemptedAutoSelectImageOverlayAxes: boolean

    Returns void

setCanvasSizeUnit

setCatalogColor

  • setCatalogColor(color: string): void

  • Set the color of catalog source

    Parameters

    • color: string

      color of catalog source

    Returns void

setCatalogDisplayMode

  • Set the catalog source display mode

    Parameters

    Returns void

setCatalogPlotType

setCatalogShape

  • Set the shape of catalog source

    Parameters

    Returns void

setCatalogSize

  • setCatalogSize(size: number): void

  • Set the size of catalog source

    Parameters

    • size: number

      size of catalog source in pixel or arcsec

    Returns void

setCatalogSourceRadiusType

setCatalogTableAutoScroll

  • setCatalogTableAutoScroll(isCatalogTableAutoScrollEnabled: boolean): void

  • Parameters

    • isCatalogTableAutoScrollEnabled: boolean

    Returns void

setColorColumnMax

  • setColorColumnMax(val: number, type: default | clipd): void

  • Set the maximum value for color mapping data

    Parameters

    • val: number

      maximum value for color mapping data

    • type: default | clipd

      "default" or "clipd"

    Returns void

setColorColumnMin

  • setColorColumnMin(val: number, type: default | clipd): void

  • Set the minimum value for color mapping data

    Parameters

    • val: number

      minimum value for color mapping data

    • type: default | clipd

      "default" or "clipd"

    Returns void

setColorMap

  • setColorMap(colorMap: string): void

  • Set the colormap

    Parameters

    • colorMap: string

      colormap name

    Returns void

setColorMapColumn

  • setColorMapColumn(column: string): void

  • Select the column for color mapping data

    Parameters

    • column: string

      column name of color mapping data

    Returns void

setColorMapDirection

  • setColorMapDirection(isInvertedColorMap: boolean): void

  • Set the colormap direction

    Parameters

    • isInvertedColorMap: boolean

      true for inverted colormap, false for normal colormap

    Returns void

setColorScalingParameter

  • setColorScalingParameter(value: number): void

  • Parameters

    • value: number

    Returns void

setColorScalingType

  • Set the scaling type for color mapping data

    Parameters

    Returns void

setDataTableColumnWidths

  • setDataTableColumnWidths(vals: number[]): void

  • Parameters

    • vals: number[]

    Returns void

setHeaderTableColumnWidths

  • setHeaderTableColumnWidths(vals: number[]): void

  • Parameters

    • vals: number[]

    Returns void

setHighlightColor

  • setHighlightColor(color: string): void

  • Set the color of highlighted catalog source

    Parameters

    • color: string

      color of highlight

    Returns void

setMinorSizeMax

  • setMinorSizeMax(val: number): void

  • Set the maximum minor axis of catalog source

    Parameters

    • val: number

      maximum minor axis of catalog source in pixel or square pixel

    Returns void

setMinorSizeMin

  • setMinorSizeMin(val: number): void

  • Set the minimum minor axis of catalog source

    Parameters

    • val: number

      minimum minor axis of catalog source in pixel or square pixel

    Returns void

setOrientationMapColumn

  • setOrientationMapColumn(column: string): void

  • Select the column for orientation data

    Parameters

    • column: string

      column name of orientation data

    Returns void

setOrientationMax

  • setOrientationMax(val: number, type: default | clipd): void

  • Set the maximum value for orientation mapping data

    Parameters

    • val: number

      maximum orientation degree for mapping data

    • type: default | clipd

      "default" or "clipd"

    Returns void

setOrientationMin

  • setOrientationMin(val: number, type: default | clipd): void

  • Set the minimum value for orientation mapping data

    Parameters

    • val: number

      minimum orientation degree for mapping data

    • type: default | clipd

      "default" or "clipd"

    Returns void

setOrientationScalingParameter

  • setOrientationScalingParameter(value: number): void

  • Parameters

    • value: number

    Returns void

setOrientationScalingType

  • Set the scaling type for orientation data

    Parameters

    Returns void

setPlottedImageOverlayState

  • setPlottedImageOverlayState(xColumnName: string, yColumnName: string, system: CatalogSystemType, maxRows?: number): void

  • Parameters

    • xColumnName: string
    • yColumnName: string
    • system: CatalogSystemType
    • optionalmaxRows: number

    Returns void

setShowSelectedData

  • setShowSelectedData(isShowingSelectedData: boolean): void

  • Parameters

    • isShowingSelectedData: boolean

    Returns void

setSizeArea

  • setSizeArea(isSizeAreaMode: boolean): void

  • Set the size mapping depending on the area or diameter

    Parameters

    • isSizeAreaMode: boolean

      true for area, false for diameter

    Returns void

setSizeAxisTab

  • setSizeAxisTab(tab: SIZE_MAJOR | SIZE_MINOR): void

  • Parameters

    • tab: SIZE_MAJOR | SIZE_MINOR

    Returns void

setSizeColumnMax

  • setSizeColumnMax(val: number, type: default | clipd): void

  • Set the maximum value for size mapping data

    Parameters

    • val: number

      maximum value for size mapping data

    • type: default | clipd

      "default" or "clipd"

    Returns void

setSizeColumnMin

  • setSizeColumnMin(val: number, type: default | clipd): void

  • Set the minimum value for size mapping data

    Parameters

    • val: number

      minimum value for size mapping data

    • type: default | clipd

      "default" or "clipd"

    Returns void

setSizeMap

  • setSizeMap(column: string): void

  • Select the size mapping column

    Parameters

    • column: string

      column name for size mapping

    Returns void

setSizeMax

  • setSizeMax(val: number): void

  • Set the maximum catalog source size

    Parameters

    • val: number

      maximum size of catalog source in pixel or square pixel

    Returns void

setSizeMin

  • setSizeMin(val: number): void

  • Set the minimum catalog source size

    Parameters

    • val: number

      minimum size of catalog source in pixel or square pixel

    Returns void

setSizeMinorArea

  • setSizeMinorArea(isSizeMinorAreaMode: boolean): void

  • Set the minor axis mapping depending on the area or diameter

    Parameters

    • isSizeMinorAreaMode: boolean

      true for area, false for diameter

    Returns void

setSizeMinorColumnMax

  • setSizeMinorColumnMax(val: number, type: default | clipd): void

  • Set the maximum value for minor size mapping data

    Parameters

    • val: number

      maximum value for minor size mapping data

    • type: default | clipd

      "default" or "clipd"

    Returns void

setSizeMinorColumnMin

  • setSizeMinorColumnMin(val: number, type: default | clipd): void

  • Set the minimum value of minor axis for size mapping data

    Parameters

    • val: number

      minimum value of minor axis for size mapping data

    • type: default | clipd

      "default" or "clipd"

    Returns void

setSizeMinorMap

  • setSizeMinorMap(column: string): void

  • Select the column for minor axis size mapping

    Parameters

    • column: string

      column name for minor axis size mapping

    Returns void

setSizeMinorScalingParameter

  • setSizeMinorScalingParameter(value: number): void

  • Parameters

    • value: number

    Returns void

setSizeMinorScalingType

  • Set the scaling type of minor axis for size mapping

    Parameters

    • type: FrameScaling

      scaling type of minor axis for size mapping

    Returns void

setSizeScalingParameter

  • setSizeScalingParameter(value: number): void

  • Parameters

    • value: number

    Returns void

setSizeScalingType

  • Set the scaling type for size mapping

    Parameters

    Returns void

setThickness

  • setThickness(val: number): void

  • Set the thickness of catalog source

    Parameters

    • val: number

      thickness of catalog source

    Returns void

setWorldSizeUnit

setxAxis

  • setxAxis(xColumnName: string): void

  • Parameters

    • xColumnName: string

    Returns void

setyAxis

  • setyAxis(yColumnName: string): void

  • Parameters

    • yColumnName: string

    Returns void

sizeArray

  • sizeArray(): Float32Array

  • Returns Float32Array

sizeMinorArray

  • sizeMinorArray(): Float32Array

  • Returns Float32Array

publictoConfig

toggleSizeColumnMaxLock

  • toggleSizeColumnMaxLock(): void

  • Returns void

toggleSizeColumnMinLock

  • toggleSizeColumnMinLock(): void

  • Returns void

toggleSizeMinorColumnMaxLock

  • toggleSizeMinorColumnMaxLock(): void

  • Returns void

toggleSizeMinorColumnMinLock

  • toggleSizeMinorColumnMinLock(): void

  • Returns void

Page Options