Skip to main content
Version: Next

CompassAnnotationStore

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • CompassAnnotationStore(backendService: BackendService, fileId: number, activeFrame: FrameStore, controlPoints: Point2D[], regionType: RegionType, regionId?: number, rotation?: number, name?: string, color?: string, lineWidth?: number, dashLength?: number): CompassAnnotationStore

  • Parameters

    • backendService: BackendService
    • fileId: number
    • activeFrame: FrameStore
    • controlPoints: Point2D[]
    • regionType: RegionType
    • regionId: number = -1
    • rotation: number = 0
    • name: string = ""
    • color: string = Colors.TURQUOISE5
    • lineWidth: number = 2
    • dashLength: number = 0

    Returns CompassAnnotationStore

Properties

inheritedactiveFrame

activeFrame: FrameStore = ...

inheritedcolor

color: string = ""

inheritedcontrolPoints

controlPoints: Point2D[] = []

inheritedcoordinate

coordinate: CoordinateMode = CoordinateMode.Image

inheriteddashLength

dashLength: number = 0

eastLabel

eastLabel: string = "E"

eastTextOffset

eastTextOffset: Point2D = ...

readonlyinheritedfileId

fileId: number

font

font: Font = Font.HELVETICA

fontSize

fontSize: number = 20

fontStyle

fontStyle: FontStyle = FontStyle.NORMAL

hasEastArrowhead

hasEastArrowhead: boolean = true

hasNorthArrowhead

hasNorthArrowhead: boolean = true

inheritedisCreating

isCreating: boolean = false

inheritedisEditing

isEditing: boolean = false

inheritedisLocked

isLocked: boolean = false

inheritedisSimplePolygon

isSimplePolygon: boolean = true

length

length: number = 100

inheritedlineRegionSampleWidth

lineRegionSampleWidth: number = 3

inheritedlineWidth

lineWidth: number = 2

publicinheritedmodifiedTimestamp

modifiedTimestamp: number

inheritedname

name: string = ""

northLabel

northLabel: string = "N"

northTextOffset

northTextOffset: Point2D = ...

pointerLength

pointerLength: number = 10

pointerWidth

pointerWidth: number = 10

inheritedregionId

regionId: number = -1

inheritedregionType

regionType: RegionType = CARTA.RegionType.POINT

inheritedrotation

rotation: number = 0

publicstaticreadonlyinheritedAVAILABLE_ANNOTATION_TYPES

AVAILABLE_ANNOTATION_TYPES: Map<RegionType, string> = ...

publicstaticreadonlyinheritedAVAILABLE_REGION_TYPES

AVAILABLE_REGION_TYPES: Map<RegionType, string> = ...

publicstaticreadonlyinheritedMAX_DASH_LENGTH

MAX_DASH_LENGTH: 50 = 50

publicstaticreadonlyinheritedMAX_LABEL_OFFSET

MAX_LABEL_OFFSET: 50 = 50

publicstaticreadonlyinheritedMAX_LINE_WIDTH

MAX_LINE_WIDTH: 10 = 10

publicstaticreadonlyinheritedMIN_LABEL_OFFSET

MIN_LABEL_OFFSET: -50 = -50

publicstaticreadonlyinheritedMIN_LINE_WIDTH

MIN_LINE_WIDTH: 0.5 = 0.5

publicstaticreadonlyinheritedTARGET_VERTEX_COUNT

TARGET_VERTEX_COUNT: 200 = 200

Accessors

inheritedboundingBox

  • Returns Point2D

inheritedboundingBoxArea

  • get boundingBoxArea(): number

  • Returns number

inheritedcenter

  • Returns Point2D

inheritedisAnnotation

  • get isAnnotation(): boolean

  • Returns boolean

inheritedisClosedRegion

  • get isClosedRegion(): boolean

  • Returns boolean

inheritedisPreviewCut

  • get isPreviewCut(): boolean

  • Returns boolean

inheritedisTemporary

  • get isTemporary(): boolean

  • Returns boolean

inheritedisValid

  • get isValid(): boolean

  • Returns boolean

inheritednameString

  • get nameString(): string

  • Returns string

inheritedregionProperties

  • get regionProperties(): string

  • Returns string

inheritedsize

  • Returns the sizes of regions and annotations. For line regions and annotations, vector annotations, and ruler annotations, returns x and y absolute displacements.

    Returns Point2D

    The x and y size components.

inheritedwcsSize

  • Returns Point2D

Methods

inheritedbeginCreating

  • beginCreating(): void

  • Returns void

inheritedbeginEditing

  • beginEditing(): void

  • Returns void

inheritedendCreating

  • endCreating(): Generator<Promise<ISetRegionAck>, void, unknown>

  • Returns Generator<Promise<ISetRegionAck>, void, unknown>

inheritedendEditing

  • endEditing(): void

  • Returns void

inheritedfocusCenter

  • focusCenter(): void

  • Returns void

publicgetAnnotationStyles

  • getAnnotationStyles(): { eastTextOffset: Point2D; font: Font; fontSize: number; fontStyle: FontStyle; isEastArrow: boolean; isNorthArrow: boolean; length: number; northTextOffset: Point2D; pointerLength: number; pointerWidth: number; textLabel0: string; textLabel1: string }

  • Returns { eastTextOffset: Point2D; font: Font; fontSize: number; fontStyle: FontStyle; isEastArrow: boolean; isNorthArrow: boolean; length: number; northTextOffset: Point2D; pointerLength: number; pointerWidth: number; textLabel0: string; textLabel1: string }

    • eastTextOffset: Point2D
    • font: Font
    • fontSize: number
    • fontStyle: FontStyle
    • isEastArrow: boolean
    • isNorthArrow: boolean
    • length: number
    • northTextOffset: Point2D
    • pointerLength: number
    • pointerWidth: number
    • textLabel0: string
    • textLabel1: string

publicgetAnnotationStylesForExport

  • getAnnotationStylesForExport(): { coordinateSystem: string; font: Font; fontSize: number; fontStyle: FontStyle; isEastArrow: boolean; isNorthArrow: boolean; textLabel0: string; textLabel1: string }

  • Returns { coordinateSystem: string; font: Font; fontSize: number; fontStyle: FontStyle; isEastArrow: boolean; isNorthArrow: boolean; textLabel0: string; textLabel1: string }

    • coordinateSystem: string
    • font: Font
    • fontSize: number
    • fontStyle: FontStyle
    • isEastArrow: boolean
    • isNorthArrow: boolean
    • textLabel0: string
    • textLabel1: string

publicgetCompassApproximation

  • getCompassApproximation(wcsInfo: FrameSet, isSpatiallyMatched?: boolean, spatialTransform?: any): { eastApproximatePoints: number[]; northApproximatePoints: number[] }

  • Parameters

    • wcsInfo: FrameSet
    • optionalisSpatiallyMatched: boolean
    • optionalspatialTransform: any

    Returns { eastApproximatePoints: number[]; northApproximatePoints: number[] }

    • eastApproximatePoints: number[]
    • northApproximatePoints: number[]

publicinheritedgetRegionApproximation

  • getRegionApproximation(astTransform: Mapping): Point2D[]

  • Parameters

    • astTransform: Mapping

    Returns Point2D[]

publicinitializeStyles

  • initializeStyles(annotationStyles: { eastTextOffset: Point2D; font: Font; fontSize: number; fontStyle: FontStyle; isEastArrow: boolean; isNorthArrow: boolean; length: number; northTextOffset: Point2D; pointerLength: number; pointerWidth: number; textLabel0: string; textLabel1: string }): void

  • Parameters

    • annotationStyles: { eastTextOffset: Point2D; font: Font; fontSize: number; fontStyle: FontStyle; isEastArrow: boolean; isNorthArrow: boolean; length: number; northTextOffset: Point2D; pointerLength: number; pointerWidth: number; textLabel0: string; textLabel1: string }
      • eastTextOffset: Point2D
      • font: Font
      • fontSize: number
      • fontStyle: FontStyle
      • isEastArrow: boolean
      • isNorthArrow: boolean
      • length: number
      • northTextOffset: Point2D
      • pointerLength: number
      • pointerWidth: number
      • textLabel0: string
      • textLabel1: string

    Returns void

inheritedsetCenter

  • setCenter(p: Point2D, shouldSkipUpdate?: boolean): void

  • Parameters

    • p: Point2D
    • shouldSkipUpdate: boolean = false

    Returns void

inheritedsetColor

  • setColor(color: string): void

  • Parameters

    • color: string

    Returns void

inheritedsetControlPoint

  • setControlPoint(index: number, p: Point2D, shouldSkipUpdate?: boolean): void

  • Parameters

    • index: number
    • p: Point2D
    • shouldSkipUpdate: boolean = false

    Returns void

inheritedsetControlPoints

  • setControlPoints(points: Point2D[], shouldSkipUpdate?: boolean, hasShapeChanged?: boolean): void

  • Parameters

    • points: Point2D[]
    • shouldSkipUpdate: boolean = false
    • hasShapeChanged: boolean = true

    Returns void

inheritedsetCoordinate

  • Parameters

    Returns void

inheritedsetDashLength

  • setDashLength(dashLength: number): void

  • Parameters

    • dashLength: number

    Returns void

setEastArrowhead

  • setEastArrowhead(hasEastArrowhead: boolean): void

  • Parameters

    • hasEastArrowhead: boolean

    Returns void

setEastTextOffset

  • setEastTextOffset(offset: number, isX: boolean, shouldSkipTimestampUpdate?: boolean): void

  • Parameters

    • offset: number
    • isX: boolean
    • shouldSkipTimestampUpdate: boolean = false

    Returns void

setFont

  • setFont(font: Font): void

  • Parameters

    Returns void

setFontSize

  • setFontSize(fontSize: number): void

  • Parameters

    • fontSize: number

    Returns void

setFontStyle

  • setFontStyle(fontStyle: string): void

  • Parameters

    • fontStyle: string

    Returns void

setLabel

  • setLabel(label: string, isNorth: boolean): void

  • Parameters

    • label: string
    • isNorth: boolean

    Returns void

setLength

  • setLength(length: number, shouldSkipUpdate?: boolean): void

  • Parameters

    • length: number
    • shouldSkipUpdate: boolean = false

    Returns void

inheritedsetLineWidth

  • setLineWidth(lineWidth: number): void

  • Parameters

    • lineWidth: number

    Returns void

inheritedsetLocked

  • setLocked(isLocked: boolean): void

  • Parameters

    • isLocked: boolean

    Returns void

inheritedsetName

  • setName(name: string): void

  • Parameters

    • name: string

    Returns void

setNorthArrowhead

  • setNorthArrowhead(hasNorthArrowhead: boolean): void

  • Parameters

    • hasNorthArrowhead: boolean

    Returns void

setNorthTextOffset

  • setNorthTextOffset(offset: number, isX: boolean, shouldSkipTimestampUpdate?: boolean): void

  • Parameters

    • offset: number
    • isX: boolean
    • shouldSkipTimestampUpdate: boolean = false

    Returns void

setPointerLength

  • setPointerLength(length: number): void

  • Parameters

    • length: number

    Returns void

setPointerWidth

  • setPointerWidth(width: number): void

  • Parameters

    • width: number

    Returns void

inheritedsetRegionId

  • setRegionId(id: number): void

  • Parameters

    • id: number

    Returns void

inheritedsetRotation

  • setRotation(angle: number, shouldSkipUpdate?: boolean): void

  • Parameters

    • angle: number
    • shouldSkipUpdate: boolean = false

    Returns void

inheritedsetSize

  • setSize(p: Point2D, shouldSkipUpdate?: boolean): void

  • Sets the size for regions and annotations

    Parameters

    • p: Point2D

      Specifies the x and y size components. For line regions and annotations, vector annotations, and ruler annotations, the function sets the new start and end positions while keeping the rotation within the same quadrant.

    • shouldSkipUpdate: boolean = false

    Returns void

inheritedtoggleLock

  • toggleLock(): void

  • Returns void

publicstaticinheritedisRegionCustomIcon

  • isRegionCustomIcon(regionType: RegionType): boolean

  • Parameters

    • regionType: RegionType

    Returns boolean

publicstaticinheritedisRegionDashLengthValid

  • isRegionDashLengthValid(regionDashLength: number): boolean

  • Parameters

    • regionDashLength: number

    Returns boolean

publicstaticinheritedisRegionLineWidthValid

  • isRegionLineWidthValid(regionLineWidth: number): boolean

  • Parameters

    • regionLineWidth: number

    Returns boolean

publicstaticinheritedisRegionTypeValid

  • isRegionTypeValid(regionType: RegionType): boolean

  • Parameters

    • regionType: RegionType

    Returns boolean

publicstaticinheritedregionIconString

  • regionIconString(regionType: RegionType): any

  • Parameters

    • regionType: RegionType

    Returns any

publicstaticinheritedregionTypeString

  • regionTypeString(regionType: RegionType): string

  • Parameters

    • regionType: RegionType

    Returns string

Page Options