RegionStore

Hierarchy

• RegionStore
  • PointAnnotationStore
  • TextAnnotationStore
  • VectorAnnotationStore
  • CompassAnnotationStore
  • RulerAnnotationStore

Index

Constructors

• constructor

Properties

• activeFrame
• color
• controlPoints
• coordinate
• dashLength
• fileId
• isCreating
• isEditing
• isLocked
• isSimplePolygon
• lineRegionSampleWidth
• lineWidth
• modifiedTimestamp
• name
• opacity
• regionId
• regionType
• rotation
• selectedPointIndex
• 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
• canSelectPoint
• center
• hasSelectedPoint
• hasSelectedRotationPoint
• isAnnotation
• isClosedRegion
• isCompassRegion
• isLineLikeRegion
• isPointSelectionSupported
• isPolygonalRegion
• isPreviewCut
• isRotationSelectableLineLikeRegion
• isSimpleShapeRegion
• isTemporary
• isValid
• isVisible
• nameString
• regionProperties
• rotationPointIndex
• selectablePointCount
• size
• visualOpacity
• wcsSize

Methods

• beginCreating
• beginEditing
• deselectPoint
• endCreating
• endEditing
• focusCenter
• getRegionApproximation
• moveSelectedPoint
• removeControlPoint
• removeSelectedPoint
• rotateSelectedPoint
• selectNextPoint
• selectPoint
• selectPreviousPoint
• setCenter
• setColor
• setControlPoint
• setControlPoints
• setCoordinate
• setDashLength
• setLineWidth
• setLocked
• setName
• setOpacity
• setRegionId
• setRotation
• setSize
• setVisible
• toggleLock
• toggleVisible
• translate
• isRegionCustomIcon
• isRegionDashLengthValid
• isRegionLineWidthValid
• isRegionTypeValid
• regionIconString
• regionTypeString

Constructors

constructor

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

• 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 RegionStore

Properties

activeFrame

activeFrame: FrameStore = ...

color

color: string = ""

controlPoints

controlPoints: Point2D[] = []

coordinate

coordinate: CoordinateMode = CoordinateMode.Image

dashLength

dashLength: number = 0

readonlyfileId

fileId: number

isCreating

isCreating: boolean = false

isEditing

isEditing: boolean = false

isLocked

isLocked: boolean = false

isSimplePolygon

isSimplePolygon: boolean = true

lineRegionSampleWidth

lineRegionSampleWidth: number = 3

lineWidth

lineWidth: number = 2

publicmodifiedTimestamp

modifiedTimestamp: number

name

name: string = ""

opacity

opacity: RegionOpacity = RegionOpacity.Visible

regionId

regionId: number = -1

regionType

regionType: RegionType = CARTA.RegionType.POINT

rotation

rotation: number = 0

selectedPointIndex

selectedPointIndex: number = -1

publicstaticreadonlyAVAILABLE_ANNOTATION_TYPES

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

publicstaticreadonlyAVAILABLE_REGION_TYPES

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

publicstaticreadonlyMAX_DASH_LENGTH

MAX_DASH_LENGTH: 50 = 50

publicstaticreadonlyMAX_LABEL_OFFSET

MAX_LABEL_OFFSET: 50 = 50

publicstaticreadonlyMAX_LINE_WIDTH

MAX_LINE_WIDTH: 10 = 10

publicstaticreadonlyMIN_LABEL_OFFSET

MIN_LABEL_OFFSET: -50 = -50

publicstaticreadonlyMIN_LINE_WIDTH

MIN_LINE_WIDTH: 0.5 = 0.5

publicstaticreadonlyTARGET_VERTEX_COUNT

TARGET_VERTEX_COUNT: 200 = 200

Accessors

boundingBox

• get boundingBox(): Point2D

• Returns Point2D

boundingBoxArea

• get boundingBoxArea(): number

• Returns number

canSelectPoint

• get canSelectPoint(): boolean

• Returns boolean

center

• get center(): Point2D

• Returns Point2D

hasSelectedPoint

• get hasSelectedPoint(): boolean

• Returns boolean

hasSelectedRotationPoint

• get hasSelectedRotationPoint(): boolean

• Returns boolean

isAnnotation

• get isAnnotation(): boolean

• Returns boolean

isClosedRegion

• get isClosedRegion(): boolean

• Returns boolean

isCompassRegion

• get isCompassRegion(): boolean

• Returns boolean

isLineLikeRegion

• get isLineLikeRegion(): boolean

• Returns boolean

isPointSelectionSupported

• get isPointSelectionSupported(): boolean

• Returns boolean

isPolygonalRegion

• get isPolygonalRegion(): boolean

• Returns boolean

isPreviewCut

• get isPreviewCut(): boolean

• Returns boolean

isRotationSelectableLineLikeRegion

• get isRotationSelectableLineLikeRegion(): boolean

• Returns boolean

isSimpleShapeRegion

• get isSimpleShapeRegion(): boolean

• Returns boolean

isTemporary

• get isTemporary(): boolean

• Returns boolean

isValid

• get isValid(): boolean

• Returns boolean

isVisible

• get isVisible(): boolean

• Returns boolean

nameString

• get nameString(): string

• Returns string

regionProperties

• get regionProperties(): string

• Returns string

rotationPointIndex

• get rotationPointIndex(): number

• Returns number

selectablePointCount

• get selectablePointCount(): number

• Returns number

size

• get size(): Point2D

• 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.

visualOpacity

• get visualOpacity(): number

• Returns number

wcsSize

• get wcsSize(): Point2D

• Returns Point2D

Methods

beginCreating

• beginCreating(): void

• Returns void

beginEditing

• beginEditing(): void

• Returns void

deselectPoint

• deselectPoint(): void

• Returns void

endCreating

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

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

endEditing

• endEditing(): void

• Returns void

focusCenter

• focusCenter(): void

• Returns void

publicgetRegionApproximation

• getRegionApproximation(astTransform: Mapping): Point2D[]

• Parameters

  • astTransform: Mapping

  Returns Point2D[]

moveSelectedPoint

• moveSelectedPoint(deltaX: number, deltaY: number): void

• Parameters

  • deltaX: number

  • deltaY: number

  Returns void

removeControlPoint

• removeControlPoint(index: number, shouldSkipUpdate?: boolean, hasShapeChanged?: boolean): void

• Parameters

  • index: number

  • shouldSkipUpdate: boolean = false

  • hasShapeChanged: boolean = true

  Returns void

removeSelectedPoint

• removeSelectedPoint(): boolean

• Returns boolean

rotateSelectedPoint

• rotateSelectedPoint(deltaDegrees: number): void

• Parameters

  • deltaDegrees: number

  Returns void

selectNextPoint

• selectNextPoint(): void

• Returns void

selectPoint

• selectPoint(index: number): void

• Parameters

  • index: number

  Returns void

selectPreviousPoint

• selectPreviousPoint(): void

• Returns void

setCenter

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

• Parameters

  • p: Point2D

  • shouldSkipUpdate: boolean = false

  Returns void

setColor

• setColor(color: string): void

• Parameters

  • color: string

  Returns void

setControlPoint

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

• Parameters

  • index: number

  • p: Point2D

  • shouldSkipUpdate: boolean = false

  Returns void

setControlPoints

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

• Parameters

  • points: Point2D[]

  • shouldSkipUpdate: boolean = false

  • hasShapeChanged: boolean = true

  Returns void

setCoordinate

• setCoordinate(coordinate: CoordinateMode): void

• Parameters

  • coordinate: CoordinateMode

  Returns void

setDashLength

• setDashLength(dashLength: number): void

• Parameters

  • dashLength: number

  Returns void

setLineWidth

• setLineWidth(lineWidth: number): void

• Parameters

  • lineWidth: number

  Returns void

setLocked

• setLocked(isLocked: boolean): void

• Parameters

  • isLocked: boolean

  Returns void

setName

• setName(name: string): void

• Parameters

  • name: string

  Returns void

setOpacity

• setOpacity(opacity: RegionOpacity): void

• Parameters

  • opacity: RegionOpacity

  Returns void

setRegionId

• setRegionId(id: number): void

• Parameters

  • id: number

  Returns void

setRotation

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

• Parameters

  • angle: number

  • shouldSkipUpdate: boolean = false

  Returns void

setSize

• 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

setVisible

• setVisible(isVisible: boolean): void

• Parameters

  • isVisible: boolean

  Returns void

toggleLock

• toggleLock(): void

• Returns void

toggleVisible

• toggleVisible(): void

• Returns void

translate

• translate(delta: Point2D, shouldSkipUpdate?: boolean): void

• Parameters

  • delta: Point2D

  • shouldSkipUpdate: boolean = false

  Returns void

publicstaticisRegionCustomIcon

• isRegionCustomIcon(regionType: RegionType): boolean

• Parameters

  • regionType: RegionType

  Returns boolean

publicstaticisRegionDashLengthValid

• isRegionDashLengthValid(regionDashLength: number): boolean

• Parameters

  • regionDashLength: number

  Returns boolean

publicstaticisRegionLineWidthValid

• isRegionLineWidthValid(regionLineWidth: number): boolean

• Parameters

  • regionLineWidth: number

  Returns boolean

publicstaticisRegionTypeValid

• isRegionTypeValid(regionType: RegionType): boolean

• Parameters

  • regionType: RegionType

  Returns boolean

publicstaticregionIconString

• regionIconString(regionType: RegionType): any

• Parameters

  • regionType: RegionType

  Returns any

publicstaticregionTypeString

• regionTypeString(regionType: RegionType): string

• Parameters

  • regionType: RegionType

  Returns string