CompassAnnotationStore

Hierarchy

• RegionStore
  • CompassAnnotationStore

Index

Constructors

• constructor

Properties

• activeFrame
• color
• controlPoints
• coordinate
• creating
• dashLength
• eastArrowhead
• eastLabel
• eastTextOffset
• editing
• fileId
• font
• fontSize
• fontStyle
• isSimplePolygon
• length
• lineRegionSampleWidth
• lineWidth
• locked
• modifiedTimestamp
• name
• northArrowhead
• northLabel
• northTextOffset
• pointerLength
• pointerWidth
• regionId
• regionType
• rotation
• AVAILABLE_ANNOTATION_TYPES
• AVAILABLE_REGION_TYPES
• MAX_DASH_LENGTH
• MAX_LABEL_OFFSET
• MAX_LINE_WIDTH
• MIN_LABEL_OFFSET
• MIN_LINE_WIDTH
• TARGET_VERTEX_COUNT

Accessors

• boundingBox
• boundingBoxArea
• center
• isAnnotation
• isClosedRegion
• isPreviewCut
• isTemporary
• isValid
• nameString
• regionProperties
• size
• wcsSize

Methods

• beginCreating
• beginEditing
• endCreating
• endEditing
• focusCenter
• getAnnotationStyles
• getAnnotationStylesForExport
• getCompassApproximation
• getRegionApproximation
• initializeStyles
• setCenter
• setColor
• setControlPoint
• setControlPoints
• setCoordinate
• setDashLength
• setEastArrowhead
• setEastTextOffset
• setFont
• setFontSize
• setFontStyle
• setLabel
• setLength
• setLineWidth
• setLocked
• setName
• setNorthArrowhead
• setNorthTextOffset
• setPointerLength
• setPointerWidth
• setRegionId
• setRotation
• setSize
• toggleLock
• GetRegionProperties
• IsRegionCustomIcon
• IsRegionDashLengthValid
• IsRegionLineWidthValid
• IsRegionTypeValid
• RegionIconString
• RegionTypeString

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

• Overrides RegionStore.constructor

  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

Inherited from RegionStore.activeFrame

inheritedcolor

color: string

Inherited from RegionStore.color

inheritedcontrolPoints

controlPoints: Point2D[]

Inherited from RegionStore.controlPoints

inheritedcoordinate

coordinate: CoordinateMode

Inherited from RegionStore.coordinate

inheritedcreating

creating: boolean

Inherited from RegionStore.creating

inheriteddashLength

dashLength: number

Inherited from RegionStore.dashLength

eastArrowhead

eastArrowhead: boolean = true

eastLabel

eastLabel: string = "E"

eastTextOffset

eastTextOffset: Point2D = ...

inheritedediting

editing: boolean

Inherited from RegionStore.editing

readonlyinheritedfileId

fileId: number

Inherited from RegionStore.fileId

font

font: Font = Font.HELVETICA

fontSize

fontSize: number = 20

fontStyle

fontStyle: FontStyle = FontStyle.NORMAL

inheritedisSimplePolygon

isSimplePolygon: boolean

Inherited from RegionStore.isSimplePolygon

length

length: number = 100

inheritedlineRegionSampleWidth

lineRegionSampleWidth: number = 3

Inherited from RegionStore.lineRegionSampleWidth

inheritedlineWidth

lineWidth: number

Inherited from RegionStore.lineWidth

inheritedlocked

locked: boolean = false

Inherited from RegionStore.locked

publicinheritedmodifiedTimestamp

modifiedTimestamp: number

Inherited from RegionStore.modifiedTimestamp

inheritedname

name: string

Inherited from RegionStore.name

northArrowhead

northArrowhead: boolean = true

northLabel

northLabel: string = "N"

northTextOffset

northTextOffset: Point2D = ...

pointerLength

pointerLength: number = 10

pointerWidth

pointerWidth: number = 10

inheritedregionId

regionId: number

Inherited from RegionStore.regionId

inheritedregionType

regionType: RegionType

Inherited from RegionStore.regionType

inheritedrotation

rotation: number

Inherited from RegionStore.rotation

staticreadonlyinheritedAVAILABLE_ANNOTATION_TYPES

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

Inherited from RegionStore.AVAILABLE_ANNOTATION_TYPES

staticreadonlyinheritedAVAILABLE_REGION_TYPES

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

Inherited from RegionStore.AVAILABLE_REGION_TYPES

staticreadonlyinheritedMAX_DASH_LENGTH

MAX_DASH_LENGTH: 50 = 50

Inherited from RegionStore.MAX_DASH_LENGTH

staticreadonlyinheritedMAX_LABEL_OFFSET

MAX_LABEL_OFFSET: 50 = 50

Inherited from RegionStore.MAX_LABEL_OFFSET

staticreadonlyinheritedMAX_LINE_WIDTH

MAX_LINE_WIDTH: 10 = 10

Inherited from RegionStore.MAX_LINE_WIDTH

staticreadonlyinheritedMIN_LABEL_OFFSET

MIN_LABEL_OFFSET: -50 = -50

Inherited from RegionStore.MIN_LABEL_OFFSET

staticreadonlyinheritedMIN_LINE_WIDTH

MIN_LINE_WIDTH: 0.5 = 0.5

Inherited from RegionStore.MIN_LINE_WIDTH

staticreadonlyinheritedTARGET_VERTEX_COUNT

TARGET_VERTEX_COUNT: 200 = 200

Inherited from RegionStore.TARGET_VERTEX_COUNT

Accessors

inheritedboundingBox

• get boundingBox(): Point2D

• Inherited from RegionStore.boundingBox

  Returns Point2D

inheritedboundingBoxArea

• get boundingBoxArea(): number

• Inherited from RegionStore.boundingBoxArea

  Returns number

inheritedcenter

• get center(): Point2D

• Inherited from RegionStore.center

  Returns Point2D

inheritedisAnnotation

• get isAnnotation(): boolean

• Inherited from RegionStore.isAnnotation

  Returns boolean

inheritedisClosedRegion

• get isClosedRegion(): boolean

• Inherited from RegionStore.isClosedRegion

  Returns boolean

inheritedisPreviewCut

• get isPreviewCut(): boolean

• Inherited from RegionStore.isPreviewCut

  Returns boolean

inheritedisTemporary

• get isTemporary(): boolean

• Inherited from RegionStore.isTemporary

  Returns boolean

inheritedisValid

• get isValid(): boolean

• Inherited from RegionStore.isValid

  Returns boolean

inheritednameString

• get nameString(): string

• Inherited from RegionStore.nameString

  Returns string

inheritedregionProperties

• get regionProperties(): string

• Inherited from RegionStore.regionProperties

  Returns string

inheritedsize

• get size(): Point2D

• Inherited from RegionStore.size

  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

• get wcsSize(): Point2D

• Inherited from RegionStore.wcsSize

  Returns Point2D

Methods

inheritedbeginCreating

• beginCreating(): void

• Inherited from RegionStore.beginCreating

  Returns void

inheritedbeginEditing

• beginEditing(): void

• Inherited from RegionStore.beginEditing

  Returns void

inheritedendCreating

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

• Inherited from RegionStore.endCreating

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

inheritedendEditing

• endEditing(): void

• Inherited from RegionStore.endEditing

  Returns void

inheritedfocusCenter

• focusCenter(): void

• Inherited from RegionStore.focusCenter

  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, spatiallyMatched?: boolean, spatialTransform?: Mapping): { eastApproximatePoints: number[]; northApproximatePoints: number[] }

• Parameters

  • wcsInfo: FrameSet

  • optionalspatiallyMatched: boolean

  • optionalspatialTransform: Mapping

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

  • eastApproximatePoints: number[]

  • northApproximatePoints: number[]

publicinheritedgetRegionApproximation

• getRegionApproximation(astTransform: Mapping): Point2D[]

• Inherited from RegionStore.getRegionApproximation

  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, skipUpdate?: boolean): void

• Inherited from RegionStore.setCenter

  Parameters

  • p: Point2D

  • skipUpdate: boolean = false

  Returns void

inheritedsetColor

• setColor(color: string): void

• Inherited from RegionStore.setColor

  Parameters

  • color: string

  Returns void

inheritedsetControlPoint

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

• Inherited from RegionStore.setControlPoint

  Parameters

  • index: number

  • p: Point2D

  • skipUpdate: boolean = false

  Returns void

inheritedsetControlPoints

• setControlPoints(points: Point2D[], skipUpdate?: boolean, shapeChanged?: boolean): void

• Inherited from RegionStore.setControlPoints

  Parameters

  • points: Point2D[]

  • skipUpdate: boolean = false

  • shapeChanged: boolean = true

  Returns void

inheritedsetCoordinate

• setCoordinate(coordinate: CoordinateMode): void

• Inherited from RegionStore.setCoordinate

  Parameters

  • coordinate: CoordinateMode

  Returns void

inheritedsetDashLength

• setDashLength(dashLength: number): void

• Inherited from RegionStore.setDashLength

  Parameters

  • dashLength: number

  Returns void

setEastArrowhead

• setEastArrowhead(eastArrowhead: boolean): void

• Parameters

  • eastArrowhead: boolean

  Returns void

setEastTextOffset

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

• Parameters

  • offset: number

  • isX: boolean

  • skipTimeStampUpdate: boolean = false

  Returns void

setFont

• setFont(font: Font): void

• Parameters

  • font: Font

  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, skipUpdate?: boolean): void

• Parameters

  • length: number

  • skipUpdate: boolean = false

  Returns void

inheritedsetLineWidth

• setLineWidth(lineWidth: number): void

• Inherited from RegionStore.setLineWidth

  Parameters

  • lineWidth: number

  Returns void

inheritedsetLocked

• setLocked(locked: boolean): void

• Inherited from RegionStore.setLocked

  Parameters

  • locked: boolean

  Returns void

inheritedsetName

• setName(name: string): void

• Inherited from RegionStore.setName

  Parameters

  • name: string

  Returns void

setNorthArrowhead

• setNorthArrowhead(northArrowhead: boolean): void

• Parameters

  • northArrowhead: boolean

  Returns void

setNorthTextOffset

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

• Parameters

  • offset: number

  • isX: boolean

  • skipTimeStampUpdate: 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

• Inherited from RegionStore.setRegionId

  Parameters

  • id: number

  Returns void

inheritedsetRotation

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

• Inherited from RegionStore.setRotation

  Parameters

  • angle: number

  • skipUpdate: boolean = false

  Returns void

inheritedsetSize

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

• Inherited from RegionStore.setSize

  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.

  • skipUpdate: boolean = false

    Whether to update the changes with the backend.

  Returns void

inheritedtoggleLock

• toggleLock(): void

• Inherited from RegionStore.toggleLock

  Returns void

publicstaticinheritedGetRegionProperties

• GetRegionProperties(regionType: RegionType, controlPoints: Point2D[], rotation: number): string

• Inherited from RegionStore.GetRegionProperties

  Parameters

  • regionType: RegionType

  • controlPoints: Point2D[]

  • rotation: number

  Returns string

publicstaticinheritedIsRegionCustomIcon

• IsRegionCustomIcon(regionType: RegionType): boolean

• Inherited from RegionStore.IsRegionCustomIcon

  Parameters

  • regionType: RegionType

  Returns boolean

publicstaticinheritedIsRegionDashLengthValid

• IsRegionDashLengthValid(regionDashLength: number): boolean

• Inherited from RegionStore.IsRegionDashLengthValid

  Parameters

  • regionDashLength: number

  Returns boolean

publicstaticinheritedIsRegionLineWidthValid

• IsRegionLineWidthValid(regionLineWidth: number): boolean

• Inherited from RegionStore.IsRegionLineWidthValid

  Parameters

  • regionLineWidth: number

  Returns boolean

publicstaticinheritedIsRegionTypeValid

• IsRegionTypeValid(regionType: RegionType): boolean

• Inherited from RegionStore.IsRegionTypeValid

  Parameters

  • regionType: RegionType

  Returns boolean

publicstaticinheritedRegionIconString

• RegionIconString(regionType: RegionType): any

• Inherited from RegionStore.RegionIconString

  Parameters

  • regionType: RegionType

  Returns any

publicstaticinheritedRegionTypeString

• RegionTypeString(regionType: RegionType): string

• Inherited from RegionStore.RegionTypeString

  Parameters

  • regionType: RegionType

  Returns string