VectorAnnotationStore

Hierarchy

• RegionStore
  • VectorAnnotationStore

Index

Constructors

• constructor

Properties

• activeFrame
• color
• controlPoints
• coordinate
• dashLength
• fileId
• isCreating
• isEditing
• isLocked
• isSimplePolygon
• lineRegionSampleWidth
• lineWidth
• modifiedTimestamp
• name
• opacity
• pointerLength
• pointerWidth
• 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
• getAnnotationStyles
• getRegionApproximation
• initializeStyles
• moveSelectedPoint
• removeControlPoint
• removeSelectedPoint
• rotateSelectedPoint
• selectNextPoint
• selectPoint
• selectPreviousPoint
• setCenter
• setColor
• setControlPoint
• setControlPoints
• setCoordinate
• setDashLength
• setLineWidth
• setLocked
• setName
• setOpacity
• setPointerLength
• setPointerWidth
• setRegionId
• setRotation
• setSize
• setVisible
• toggleLock
• toggleVisible
• translate
• isRegionCustomIcon
• isRegionDashLengthValid
• isRegionLineWidthValid
• isRegionTypeValid
• regionIconString
• regionTypeString

Constructors

constructor

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

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

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 = CoordinateMode.Image

Inherited from RegionStore.coordinate

inheriteddashLength

dashLength: number = 0

Inherited from RegionStore.dashLength

readonlyinheritedfileId

fileId: number

Inherited from RegionStore.fileId

inheritedisCreating

isCreating: boolean = false

Inherited from RegionStore.isCreating

inheritedisEditing

isEditing: boolean = false

Inherited from RegionStore.isEditing

inheritedisLocked

isLocked: boolean = false

Inherited from RegionStore.isLocked

inheritedisSimplePolygon

isSimplePolygon: boolean = true

Inherited from RegionStore.isSimplePolygon

inheritedlineRegionSampleWidth

lineRegionSampleWidth: number = 3

Inherited from RegionStore.lineRegionSampleWidth

inheritedlineWidth

lineWidth: number = 2

Inherited from RegionStore.lineWidth

publicinheritedmodifiedTimestamp

modifiedTimestamp: number

Inherited from RegionStore.modifiedTimestamp

inheritedname

name: string = ""

Inherited from RegionStore.name

inheritedopacity

opacity: RegionOpacity = RegionOpacity.Visible

Inherited from RegionStore.opacity

pointerLength

pointerLength: number = 10

pointerWidth

pointerWidth: number = 10

inheritedregionId

regionId: number = -1

Inherited from RegionStore.regionId

inheritedregionType

regionType: RegionType = CARTA.RegionType.POINT

Inherited from RegionStore.regionType

inheritedrotation

rotation: number = 0

Inherited from RegionStore.rotation

inheritedselectedPointIndex

selectedPointIndex: number = -1

Inherited from RegionStore.selectedPointIndex

publicstaticreadonlyinheritedAVAILABLE_ANNOTATION_TYPES

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

Inherited from RegionStore.AVAILABLE_ANNOTATION_TYPES

publicstaticreadonlyinheritedAVAILABLE_REGION_TYPES

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

Inherited from RegionStore.AVAILABLE_REGION_TYPES

publicstaticreadonlyinheritedMAX_DASH_LENGTH

MAX_DASH_LENGTH: 50 = 50

Inherited from RegionStore.MAX_DASH_LENGTH

publicstaticreadonlyinheritedMAX_LABEL_OFFSET

MAX_LABEL_OFFSET: 50 = 50

Inherited from RegionStore.MAX_LABEL_OFFSET

publicstaticreadonlyinheritedMAX_LINE_WIDTH

MAX_LINE_WIDTH: 10 = 10

Inherited from RegionStore.MAX_LINE_WIDTH

publicstaticreadonlyinheritedMIN_LABEL_OFFSET

MIN_LABEL_OFFSET: -50 = -50

Inherited from RegionStore.MIN_LABEL_OFFSET

publicstaticreadonlyinheritedMIN_LINE_WIDTH

MIN_LINE_WIDTH: 0.5 = 0.5

Inherited from RegionStore.MIN_LINE_WIDTH

publicstaticreadonlyinheritedTARGET_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

inheritedcanSelectPoint

• get canSelectPoint(): boolean

• Inherited from RegionStore.canSelectPoint

  Returns boolean

inheritedcenter

• get center(): Point2D

• Inherited from RegionStore.center

  Returns Point2D

inheritedhasSelectedPoint

• get hasSelectedPoint(): boolean

• Inherited from RegionStore.hasSelectedPoint

  Returns boolean

inheritedhasSelectedRotationPoint

• get hasSelectedRotationPoint(): boolean

• Inherited from RegionStore.hasSelectedRotationPoint

  Returns boolean

inheritedisAnnotation

• get isAnnotation(): boolean

• Inherited from RegionStore.isAnnotation

  Returns boolean

inheritedisClosedRegion

• get isClosedRegion(): boolean

• Inherited from RegionStore.isClosedRegion

  Returns boolean

inheritedisCompassRegion

• get isCompassRegion(): boolean

• Inherited from RegionStore.isCompassRegion

  Returns boolean

inheritedisLineLikeRegion

• get isLineLikeRegion(): boolean

• Inherited from RegionStore.isLineLikeRegion

  Returns boolean

inheritedisPointSelectionSupported

• get isPointSelectionSupported(): boolean

• Inherited from RegionStore.isPointSelectionSupported

  Returns boolean

inheritedisPolygonalRegion

• get isPolygonalRegion(): boolean

• Inherited from RegionStore.isPolygonalRegion

  Returns boolean

inheritedisPreviewCut

• get isPreviewCut(): boolean

• Inherited from RegionStore.isPreviewCut

  Returns boolean

inheritedisRotationSelectableLineLikeRegion

• get isRotationSelectableLineLikeRegion(): boolean

• Inherited from RegionStore.isRotationSelectableLineLikeRegion

  Returns boolean

inheritedisSimpleShapeRegion

• get isSimpleShapeRegion(): boolean

• Inherited from RegionStore.isSimpleShapeRegion

  Returns boolean

inheritedisTemporary

• get isTemporary(): boolean

• Inherited from RegionStore.isTemporary

  Returns boolean

inheritedisValid

• get isValid(): boolean

• Inherited from RegionStore.isValid

  Returns boolean

inheritedisVisible

• get isVisible(): boolean

• Inherited from RegionStore.isVisible

  Returns boolean

inheritednameString

• get nameString(): string

• Inherited from RegionStore.nameString

  Returns string

inheritedregionProperties

• get regionProperties(): string

• Inherited from RegionStore.regionProperties

  Returns string

inheritedrotationPointIndex

• get rotationPointIndex(): number

• Inherited from RegionStore.rotationPointIndex

  Returns number

inheritedselectablePointCount

• get selectablePointCount(): number

• Inherited from RegionStore.selectablePointCount

  Returns number

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.

inheritedvisualOpacity

• get visualOpacity(): number

• Inherited from RegionStore.visualOpacity

  Returns number

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

inheriteddeselectPoint

• deselectPoint(): void

• Inherited from RegionStore.deselectPoint

  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(): { pointerLength: number; pointerWidth: number }

• Returns { pointerLength: number; pointerWidth: number }

  • pointerLength: number

  • pointerWidth: number

publicinheritedgetRegionApproximation

• getRegionApproximation(astTransform: Mapping): Point2D[]

• Inherited from RegionStore.getRegionApproximation

  Parameters

  • astTransform: Mapping

  Returns Point2D[]

publicinitializeStyles

• initializeStyles(annotationStyles: { pointerLength: number; pointerWidth: number }): void

• Parameters

  • annotationStyles: { pointerLength: number; pointerWidth: number }

  • pointerLength: number

  • pointerWidth: number

  Returns void

inheritedmoveSelectedPoint

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

• Inherited from RegionStore.moveSelectedPoint

  Parameters

  • deltaX: number

  • deltaY: number

  Returns void

inheritedremoveControlPoint

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

• Inherited from RegionStore.removeControlPoint

  Parameters

  • index: number

  • shouldSkipUpdate: boolean = false

  • hasShapeChanged: boolean = true

  Returns void

inheritedremoveSelectedPoint

• removeSelectedPoint(): boolean

• Inherited from RegionStore.removeSelectedPoint

  Returns boolean

inheritedrotateSelectedPoint

• rotateSelectedPoint(deltaDegrees: number): void

• Inherited from RegionStore.rotateSelectedPoint

  Parameters

  • deltaDegrees: number

  Returns void

inheritedselectNextPoint

• selectNextPoint(): void

• Inherited from RegionStore.selectNextPoint

  Returns void

inheritedselectPoint

• selectPoint(index: number): void

• Inherited from RegionStore.selectPoint

  Parameters

  • index: number

  Returns void

inheritedselectPreviousPoint

• selectPreviousPoint(): void

• Inherited from RegionStore.selectPreviousPoint

  Returns void

inheritedsetCenter

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

• Inherited from RegionStore.setCenter

  Parameters

  • p: Point2D

  • shouldSkipUpdate: boolean = false

  Returns void

inheritedsetColor

• setColor(color: string): void

• Inherited from RegionStore.setColor

  Parameters

  • color: string

  Returns void

inheritedsetControlPoint

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

• Inherited from RegionStore.setControlPoint

  Parameters

  • index: number

  • p: Point2D

  • shouldSkipUpdate: boolean = false

  Returns void

inheritedsetControlPoints

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

• Inherited from RegionStore.setControlPoints

  Parameters

  • points: Point2D[]

  • shouldSkipUpdate: boolean = false

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

inheritedsetLineWidth

• setLineWidth(lineWidth: number): void

• Inherited from RegionStore.setLineWidth

  Parameters

  • lineWidth: number

  Returns void

inheritedsetLocked

• setLocked(isLocked: boolean): void

• Inherited from RegionStore.setLocked

  Parameters

  • isLocked: boolean

  Returns void

inheritedsetName

• setName(name: string): void

• Inherited from RegionStore.setName

  Parameters

  • name: string

  Returns void

inheritedsetOpacity

• setOpacity(opacity: RegionOpacity): void

• Inherited from RegionStore.setOpacity

  Parameters

  • opacity: RegionOpacity

  Returns void

setPointerLength

• setPointerLength(pointerLength: number): void

• Parameters

  • pointerLength: number

  Returns void

setPointerWidth

• setPointerWidth(pointerWidth: number): void

• Parameters

  • pointerWidth: number

  Returns void

inheritedsetRegionId

• setRegionId(id: number): void

• Inherited from RegionStore.setRegionId

  Parameters

  • id: number

  Returns void

inheritedsetRotation

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

• Inherited from RegionStore.setRotation

  Parameters

  • angle: number

  • shouldSkipUpdate: boolean = false

  Returns void

inheritedsetSize

• setSize(p: Point2D, shouldSkipUpdate?: 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.

  • shouldSkipUpdate: boolean = false

    Whether to update the changes with the backend.

  Returns void

inheritedsetVisible

• setVisible(isVisible: boolean): void

• Inherited from RegionStore.setVisible

  Parameters

  • isVisible: boolean

  Returns void

inheritedtoggleLock

• toggleLock(): void

• Inherited from RegionStore.toggleLock

  Returns void

inheritedtoggleVisible

• toggleVisible(): void

• Inherited from RegionStore.toggleVisible

  Returns void

inheritedtranslate

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

• Inherited from RegionStore.translate

  Parameters

  • delta: Point2D

  • shouldSkipUpdate: boolean = false

  Returns void

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): function | add-application | add-child | add-clip | add-column-left | add-column-right | add-derived-column | add-location | add-parent | add-row-bottom | add-row-top | add-tile | add-to-artifact | add-to-folder | add | aimpoints-target | airplane | align-center | align-justify | align-left | align-right | alignment-bottom | alignment-horizontal-center | alignment-left | alignment-right | alignment-top | alignment-vertical-center | ammunition | anchor | annotation | announcement | antenna | app-header | application | applications | archive | area-of-interest | array-boolean | array-date | array-floating-point | array-numeric | array-object | array-string | array-timestamp | array | arrow-bottom-left | arrow-bottom-right | arrow-down | arrow-left | arrow-right | arrow-top-left | arrow-top-right | arrow-up | arrows-arc | arrows-horizontal | arrows-vertical | asterisk | at | automatic-updates | axle | backlink | backward-ten | badge | ban-circle | bank-account | barcode | binary-number | blank | block-promote | blocked-person | bold | book | bookmark | box | branch-locked | branch-unlocked | briefcase | bring-data | bring-forward | british-pound | bug | buggy | build | bullseye | calculator | calendar | camera | caret-down | caret-left | caret-right | caret-up | cargo-ship | cell-tower | changes | chart | chat | chevron-backward | chevron-down | chevron-forward | chevron-left | chevron-right | chevron-up | circle-arrow-down | circle-arrow-left | circle-arrow-right | circle-arrow-up | circle-dashed | circle | citation | clean | clip | clipboard-file | clipboard | cloud-download | cloud-server | cloud-tick | cloud-upload | cloud | code-block | code | cog | collapse-all | color-fill | column-layout | comment | comparison | compass | compressed | confirm | console-alert | console | construction | contrast | control | credit-card | crop | cross-circle | cross | crown | crystal-ball | css-style | cube-add | cube-cutout | cube-cutouts | cube-edit | cube-remove | cube | cubes | curly-braces | curved-range-chart | cut | cycle | dashboard | data-cloud | data-connection | data-lineage | data-search | data-sync | database | delete-clip | delete | delta | derive-column | descendant | desktop | detection | diagnosis | diagram-tree | direction-left | direction-right | disable | divide | document-code | document-locked | document-open | document-share | document | dollar | dot | double-caret-horizontal | double-caret-vertical | double-chevron-down | double-chevron-left | double-chevron-right | double-chevron-up | doughnut-chart | download | drag-handle-horizontal | drag-handle-vertical | draw | drawer-left-filled | drawer-left | drawer-right-filled | drawer-right | drive-time | drone-uav | drone | duplicate | edit | eject | emoji | endnote | endorsed | engagement | envelope | equals | eraser | error | euro | excavator | exchange | exclude-row | expand-all | explain | export | eye-off | eye-on | eye-open | fast-backward | fast-forward | feed-subscribed | feed | fighter-jet | film | filter-keep | filter-list | filter-open | filter-remove | filter-sort-asc | filter-sort-desc | filter | flag | flame | flash | floating-point | floppy-disk | flow-branch | flow-end | flow-linear | flow-review-branch | flow-review | flows | folder-close | folder-new | folder-open | folder-shared-open | folder-shared | follower | following | font | fork-end | fork | form | forward-ten | frame-to-frame | fuel | full-circle | full-stacked-chart | fullscreen | function-minimal | gantt-chart | generate | geofence | geolocation | geosearch | geotime | gift-box | git-branch | git-commit | git-merge | git-new-branch | git-pull | git-push | git-rebase | git-repo | glass | globe-network-add | globe-network | globe | graph-remove | graph | greater-than-or-equal-to | greater-than | grid-view | grid | group-item | group-objects | grouped-bar-chart | hand-down | hand-left | hand-right | hand-up | hand | hat | header-one | header-three | header-two | header | headset | heart-broken | heart | heat-grid | heatmap | helicopter | help | helper-management | hexagon | high-priority | high-voltage-pole | highlight | history | home | horizontal-bar-chart-asc | horizontal-bar-chart-desc | horizontal-bar-chart | horizontal-distribution | horizontal-inbetween | hurricane | id-number | image-rotate-left | image-rotate-right | import | inbox-filtered | inbox-geo | inbox-search | inbox-update | inbox | info-sign | inheritance | inherited-group | inner-join | input | insert | intelligence | intersection | ip-address | issue-closed | issue-new | issue | italic | join-table | key-backspace | key-command | key-control | key-delete | key-enter | key-escape | key-option | key-shift | key-tab | key | known-vehicle | lab-test | label | layer-outline | layer | layers | layout-auto | layout-balloon | layout-bottom-row-three-tiles | layout-bottom-row-two-tiles | layout-circle | layout-grid | layout-group-by | layout-hierarchy | layout-left-column-three-tiles | layout-left-column-two-tiles | layout-linear | layout-right-column-three-tiles | layout-right-column-two-tiles | layout-skew-grid | layout-sorted-clusters | layout-three-columns | layout-three-rows | layout-top-row-three-tiles | layout-top-row-two-tiles | layout-two-columns | layout-two-rows | layout | learning | left-join | lengthen-text | less-than-or-equal-to | less-than | lifesaver | lightbulb | lightning | link | linked-squares | list-columns | list-detail-view | list | locate | lock | locomotive | log-in | log-out | low-voltage-pole | manual | manually-entered-data | many-to-many | many-to-one | map-create | map-marker | map | markdown | maximize | media | menu-closed | menu-open | menu | merge-columns | merge-links | microphone | minimize | minus | mobile-phone | mobile-video | modal-filled | modal | model | moon | more | mountain | move | mugshot | multi-select | music | nest | new-comment | new-drawing | new-grid-item | new-layer | new-layers | new-link | new-object | new-person | new-prescription | new-shield | new-text-box | ninja | not-equal-to | notifications-add | notifications-snooze | notifications-updated | notifications | numbered-list | numerical | object-view | office | offline | oil-field | one-column | one-to-many | one-to-one | open-application | outdated | outer-join | output | package | page-break | page-layout | panel-stats | panel-table | panel | paperclip | paragraph | paste-variable | path-search | path | pause | people | percentage | person | phone-call | phone-forward | phone-search | phone | pie-chart | pill | pin | pistol | pivot-table | pivot | play | playbook | plus | polygon-filter | popout | power | predictive-analysis | prescription | presentation | print | projects | properties | property | publish-function | pulse | rain | random | range-ring | record | rect-height | rect-width | rectangle | redo | refresh-off | refresh | regex | regression-chart | remove-column-left | remove-column-right | remove-column | remove-row-bottom | remove-row-top | remove | repeat | reset | resolve | rig | right-join | ring | rocket-slant | rocket | root-folder | rotate-ccw | rotate-cw | rotate-document | rotate-page | route | run-history | satellite | saved | scatter-plot | search-around | search-template | search-text | search | segmented-control | select | selection-box-add | selection-box-edit | selection-box-remove | selection-box | selection | send-backward | send-message | send-to-graph | send-to-map | send-to | sensor | series-add | series-configuration | series-derived | series-filtered | series-search | server-install | server | settings | shapes | share | shared-filter | shield | ship | shop | shopping-cart | shorten-text | signal-search | sim-card | slash | small-cross | small-info-sign | small-minus | small-plus | small-square | small-tick | snowflake | soccer-ball | social-media | sort-alphabetical-desc | sort-alphabetical | sort-asc | sort-desc | sort-numerical-desc | sort-numerical | sort | spell-check | spin | split-columns | sports-stadium | square | stacked-chart | stadium-geometry | star-empty | star | step-backward | step-chart | step-forward | stop | stopwatch | strikethrough | style | subscript | subtract-right-join | superscript | swap-horizontal | swap-vertical | sweep | switch | symbol-circle | symbol-cross | symbol-diamond | symbol-rectangle | symbol-square | symbol-triangle-down | symbol-triangle-up | syringe | table-sync | tag-add | tag-promote | tag-refresh | tag-undo | tag | tags | take-action | tank | target | taxi | team | temperature | text-highlight | th-add | th-derived | th-disconnect | th-filtered | th-list-add | th-list | th-virtual-add | th-virtual | th | third-party | thumbs-down | thumbs-up | tick-circle | tick | time | timeline-area-chart | timeline-bar-chart | timeline-events | timeline-line-chart | tint | torch | tractor | train | translate | trash | tree | trending-down | trending-up | trophy | truck | two-columns | unarchive | underline | undo | ungroup-objects | unknown-vehicle | unlink | unlock | unpin | unresolve | updated | upload | user | variable-layer | variable | vector | vertical-bar-chart-asc | vertical-bar-chart-desc | vertical-distribution | vertical-inbetween | video | virus | volume-down | volume-off | volume-up | walk | warning-sign | waterfall-chart | waves | widget-button | widget-footer | widget-header | widget | wind | won | wrap-lines | wrench-redo | wrench-snooze | wrench-time | wrench | yen | zoom-in | zoom-out | zoom-to-fit | stokes | line | center | contour | regionList | spatialProfiler | spectralProfiler | spectralLineQuery | smoothing | moments | distanceMeasuring | cursor | polyline | imageFitting | lineFitting | vectorOverlay

• Inherited from RegionStore.regionIconString

  Parameters

  • regionType: RegionType

  Returns function | add-application | add-child | add-clip | add-column-left | add-column-right | add-derived-column | add-location | add-parent | add-row-bottom | add-row-top | add-tile | add-to-artifact | add-to-folder | add | aimpoints-target | airplane | align-center | align-justify | align-left | align-right | alignment-bottom | alignment-horizontal-center | alignment-left | alignment-right | alignment-top | alignment-vertical-center | ammunition | anchor | annotation | announcement | antenna | app-header | application | applications | archive | area-of-interest | array-boolean | array-date | array-floating-point | array-numeric | array-object | array-string | array-timestamp | array | arrow-bottom-left | arrow-bottom-right | arrow-down | arrow-left | arrow-right | arrow-top-left | arrow-top-right | arrow-up | arrows-arc | arrows-horizontal | arrows-vertical | asterisk | at | automatic-updates | axle | backlink | backward-ten | badge | ban-circle | bank-account | barcode | binary-number | blank | block-promote | blocked-person | bold | book | bookmark | box | branch-locked | branch-unlocked | briefcase | bring-data | bring-forward | british-pound | bug | buggy | build | bullseye | calculator | calendar | camera | caret-down | caret-left | caret-right | caret-up | cargo-ship | cell-tower | changes | chart | chat | chevron-backward | chevron-down | chevron-forward | chevron-left | chevron-right | chevron-up | circle-arrow-down | circle-arrow-left | circle-arrow-right | circle-arrow-up | circle-dashed | circle | citation | clean | clip | clipboard-file | clipboard | cloud-download | cloud-server | cloud-tick | cloud-upload | cloud | code-block | code | cog | collapse-all | color-fill | column-layout | comment | comparison | compass | compressed | confirm | console-alert | console | construction | contrast | control | credit-card | crop | cross-circle | cross | crown | crystal-ball | css-style | cube-add | cube-cutout | cube-cutouts | cube-edit | cube-remove | cube | cubes | curly-braces | curved-range-chart | cut | cycle | dashboard | data-cloud | data-connection | data-lineage | data-search | data-sync | database | delete-clip | delete | delta | derive-column | descendant | desktop | detection | diagnosis | diagram-tree | direction-left | direction-right | disable | divide | document-code | document-locked | document-open | document-share | document | dollar | dot | double-caret-horizontal | double-caret-vertical | double-chevron-down | double-chevron-left | double-chevron-right | double-chevron-up | doughnut-chart | download | drag-handle-horizontal | drag-handle-vertical | draw | drawer-left-filled | drawer-left | drawer-right-filled | drawer-right | drive-time | drone-uav | drone | duplicate | edit | eject | emoji | endnote | endorsed | engagement | envelope | equals | eraser | error | euro | excavator | exchange | exclude-row | expand-all | explain | export | eye-off | eye-on | eye-open | fast-backward | fast-forward | feed-subscribed | feed | fighter-jet | film | filter-keep | filter-list | filter-open | filter-remove | filter-sort-asc | filter-sort-desc | filter | flag | flame | flash | floating-point | floppy-disk | flow-branch | flow-end | flow-linear | flow-review-branch | flow-review | flows | folder-close | folder-new | folder-open | folder-shared-open | folder-shared | follower | following | font | fork-end | fork | form | forward-ten | frame-to-frame | fuel | full-circle | full-stacked-chart | fullscreen | function-minimal | gantt-chart | generate | geofence | geolocation | geosearch | geotime | gift-box | git-branch | git-commit | git-merge | git-new-branch | git-pull | git-push | git-rebase | git-repo | glass | globe-network-add | globe-network | globe | graph-remove | graph | greater-than-or-equal-to | greater-than | grid-view | grid | group-item | group-objects | grouped-bar-chart | hand-down | hand-left | hand-right | hand-up | hand | hat | header-one | header-three | header-two | header | headset | heart-broken | heart | heat-grid | heatmap | helicopter | help | helper-management | hexagon | high-priority | high-voltage-pole | highlight | history | home | horizontal-bar-chart-asc | horizontal-bar-chart-desc | horizontal-bar-chart | horizontal-distribution | horizontal-inbetween | hurricane | id-number | image-rotate-left | image-rotate-right | import | inbox-filtered | inbox-geo | inbox-search | inbox-update | inbox | info-sign | inheritance | inherited-group | inner-join | input | insert | intelligence | intersection | ip-address | issue-closed | issue-new | issue | italic | join-table | key-backspace | key-command | key-control | key-delete | key-enter | key-escape | key-option | key-shift | key-tab | key | known-vehicle | lab-test | label | layer-outline | layer | layers | layout-auto | layout-balloon | layout-bottom-row-three-tiles | layout-bottom-row-two-tiles | layout-circle | layout-grid | layout-group-by | layout-hierarchy | layout-left-column-three-tiles | layout-left-column-two-tiles | layout-linear | layout-right-column-three-tiles | layout-right-column-two-tiles | layout-skew-grid | layout-sorted-clusters | layout-three-columns | layout-three-rows | layout-top-row-three-tiles | layout-top-row-two-tiles | layout-two-columns | layout-two-rows | layout | learning | left-join | lengthen-text | less-than-or-equal-to | less-than | lifesaver | lightbulb | lightning | link | linked-squares | list-columns | list-detail-view | list | locate | lock | locomotive | log-in | log-out | low-voltage-pole | manual | manually-entered-data | many-to-many | many-to-one | map-create | map-marker | map | markdown | maximize | media | menu-closed | menu-open | menu | merge-columns | merge-links | microphone | minimize | minus | mobile-phone | mobile-video | modal-filled | modal | model | moon | more | mountain | move | mugshot | multi-select | music | nest | new-comment | new-drawing | new-grid-item | new-layer | new-layers | new-link | new-object | new-person | new-prescription | new-shield | new-text-box | ninja | not-equal-to | notifications-add | notifications-snooze | notifications-updated | notifications | numbered-list | numerical | object-view | office | offline | oil-field | one-column | one-to-many | one-to-one | open-application | outdated | outer-join | output | package | page-break | page-layout | panel-stats | panel-table | panel | paperclip | paragraph | paste-variable | path-search | path | pause | people | percentage | person | phone-call | phone-forward | phone-search | phone | pie-chart | pill | pin | pistol | pivot-table | pivot | play | playbook | plus | polygon-filter | popout | power | predictive-analysis | prescription | presentation | print | projects | properties | property | publish-function | pulse | rain | random | range-ring | record | rect-height | rect-width | rectangle | redo | refresh-off | refresh | regex | regression-chart | remove-column-left | remove-column-right | remove-column | remove-row-bottom | remove-row-top | remove | repeat | reset | resolve | rig | right-join | ring | rocket-slant | rocket | root-folder | rotate-ccw | rotate-cw | rotate-document | rotate-page | route | run-history | satellite | saved | scatter-plot | search-around | search-template | search-text | search | segmented-control | select | selection-box-add | selection-box-edit | selection-box-remove | selection-box | selection | send-backward | send-message | send-to-graph | send-to-map | send-to | sensor | series-add | series-configuration | series-derived | series-filtered | series-search | server-install | server | settings | shapes | share | shared-filter | shield | ship | shop | shopping-cart | shorten-text | signal-search | sim-card | slash | small-cross | small-info-sign | small-minus | small-plus | small-square | small-tick | snowflake | soccer-ball | social-media | sort-alphabetical-desc | sort-alphabetical | sort-asc | sort-desc | sort-numerical-desc | sort-numerical | sort | spell-check | spin | split-columns | sports-stadium | square | stacked-chart | stadium-geometry | star-empty | star | step-backward | step-chart | step-forward | stop | stopwatch | strikethrough | style | subscript | subtract-right-join | superscript | swap-horizontal | swap-vertical | sweep | switch | symbol-circle | symbol-cross | symbol-diamond | symbol-rectangle | symbol-square | symbol-triangle-down | symbol-triangle-up | syringe | table-sync | tag-add | tag-promote | tag-refresh | tag-undo | tag | tags | take-action | tank | target | taxi | team | temperature | text-highlight | th-add | th-derived | th-disconnect | th-filtered | th-list-add | th-list | th-virtual-add | th-virtual | th | third-party | thumbs-down | thumbs-up | tick-circle | tick | time | timeline-area-chart | timeline-bar-chart | timeline-events | timeline-line-chart | tint | torch | tractor | train | translate | trash | tree | trending-down | trending-up | trophy | truck | two-columns | unarchive | underline | undo | ungroup-objects | unknown-vehicle | unlink | unlock | unpin | unresolve | updated | upload | user | variable-layer | variable | vector | vertical-bar-chart-asc | vertical-bar-chart-desc | vertical-distribution | vertical-inbetween | video | virus | volume-down | volume-off | volume-up | walk | warning-sign | waterfall-chart | waves | widget-button | widget-footer | widget-header | widget | wind | won | wrap-lines | wrench-redo | wrench-snooze | wrench-time | wrench | yen | zoom-in | zoom-out | zoom-to-fit | stokes | line | center | contour | regionList | spatialProfiler | spectralProfiler | spectralLineQuery | smoothing | moments | distanceMeasuring | cursor | polyline | imageFitting | lineFitting | vectorOverlay

publicstaticinheritedregionTypeString

• regionTypeString(regionType: RegionType): string

• Inherited from RegionStore.regionTypeString

  Parameters

  • regionType: RegionType

  Returns string