Skip to main content
Version: Next

RegionSetStore

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

focusedRegion

focusedRegion: RegionStore | null

isHoverImage

isHoverImage: Boolean = false

isLocked

isLocked: boolean = false

mode

mode: RegionMode = RegionMode.MOVING

newRegionType

newRegionType: RegionType

regions

regions: RegionStore[] = []

selectedRegionIds

selectedRegionIds: Set<number> = ...

Accessors

areAllEditableRegionsLocked

  • get areAllEditableRegionsLocked(): boolean

  • Returns boolean

areAllSelectedRegionsLocked

  • get areAllSelectedRegionsLocked(): boolean

  • Returns boolean

editableRegionsList

editableRegionsOpacity

isNewRegionAnnotation

  • get isNewRegionAnnotation(): boolean

  • Returns boolean

regionList

  • get regionList(): { id: number; type: RegionType }[]

  • Returns an array of region IDs and types in the region set.

    Returns { id: number; type: RegionType }[]

regionMap

  • Returns a map associating region IDs with their corresponding RegionStore instances.

    Returns Map<number, RegionStore>

regionsAndAnnotationsForRender

selectedRegionCount

  • get selectedRegionCount(): number

  • Returns number

selectedRegionsList

selectedRegionsOpacity

visibleEditableRegionsList

Methods

addAnnCompassRegion

addAnnEllipticalRegion

  • addAnnEllipticalRegion(center: Point2D, semiMajor: number, semiMinor: number, isTemporary?: boolean): RegionStore

  • Parameters

    • center: Point2D
    • semiMajor: number
    • semiMinor: number
    • isTemporary: boolean = false

    Returns RegionStore

addAnnLineRegion

addAnnPointRegion

  • Parameters

    • center: Point2D
    • optionalshape: any
    • isCursorRegion: boolean = false

    Returns RegionStore

addAnnPolygonalRegion

addAnnPolylineRegion

addAnnRectangularRegion

  • addAnnRectangularRegion(center: Point2D, width: number, height: number, isTemporary?: boolean): RegionStore

  • Parameters

    • center: Point2D
    • width: number
    • height: number
    • isTemporary: boolean = false

    Returns RegionStore

addAnnRulerRegion

addAnnTextRegion

  • addAnnTextRegion(center: Point2D, width: number, height: number, isTemporary?: boolean): RegionStore

  • Parameters

    • center: Point2D
    • width: number
    • height: number
    • isTemporary: boolean = false

    Returns RegionStore

addAnnVectorRegion

addEllipticalRegion

  • addEllipticalRegion(center: Point2D, semiMajor: number, semiMinor: number, isTemporary?: boolean): RegionStore

  • Parameters

    • center: Point2D
    • semiMajor: number
    • semiMinor: number
    • isTemporary: boolean = false

    Returns RegionStore

addExistingRegion

  • addExistingRegion(points: Point2D[], rotation: number, regionType: RegionType, regionId: number, name: string, color: string, lineWidth: number, dashes: number[], isTemporary?: boolean, annotationStyles?: any): RegionStore

  • Parameters

    • points: Point2D[]
    • rotation: number
    • regionType: RegionType
    • regionId: number
    • name: string
    • color: string
    • lineWidth: number
    • dashes: number[]
    • isTemporary: boolean = true
    • optionalannotationStyles: any

    Returns RegionStore

addLineRegion

addPointRegion

addPolygonalRegion

addPolylineRegion

addRectangularRegion

  • addRectangularRegion(center: Point2D, width: number, height: number, isTemporary?: boolean): RegionStore

  • Parameters

    • center: Point2D
    • width: number
    • height: number
    • isTemporary: boolean = false

    Returns RegionStore

addRegionAsync

  • addRegionAsync(regionType: RegionType, points: Point2D[], rotation?: number, regionName?: string): Promise<RegionStore>

  • Adds a new region and returns the corresponding RegionStore object.

    Parameters

    • regionType: RegionType

      Type of the region.

    • points: Point2D[]

      Points defining the shape of the region. For rectangles, ellipses, text annotations, and compass annotations, provide [center, size]; for other types, provide an array of positions.

    • rotation: number = 0

      Rotation angle of the region in degrees. Only applicable for rectangles, ellipses, and text annotations.

    • regionName: string = ""

      Optional name for the region. If it is not provided or is an empty string, a default name will be applied.

    Returns Promise<RegionStore>

    A promise that resolves to the RegionStore object representing the added region.

applyRegionBoxSelection

  • applyRegionBoxSelection(regionIds: number[]): void

  • Parameters

    • regionIds: number[]

    Returns void

beginRegionDrag

clearSelection

  • clearSelection(): void

  • Returns void

deleteRegion

endRegionDrag

publicgetTempRegionId

  • getTempRegionId(): number

  • Returns number

isRegionInMultiSelection

  • isRegionInMultiSelection(region: RegionStore | null | undefined): boolean

  • Parameters

    Returns boolean

migrateRegionsFromExistingSet

  • migrateRegionsFromExistingSet(sourceRegionSet: RegionSetStore, spatialTransformAST: Mapping, isForward?: boolean): void

  • Parameters

    • sourceRegionSet: RegionSetStore
    • spatialTransformAST: Mapping
    • isForward: boolean = false

    Returns void

replaceRegionId

  • replaceRegionId(previousRegionId: number, regionId: number): void

  • Parameters

    • previousRegionId: number
    • regionId: number

    Returns void

selectAdjacentRegionFromList

  • selectAdjacentRegionFromList(regions: RegionStore[], direction: -1 | 1, options?: Pick<AdjacentRegionOptions, wrap | range | includeCursor>): void

  • Parameters

    • regions: RegionStore[]
    • direction: -1 | 1
    • options: Pick<AdjacentRegionOptions, wrap | range | includeCursor> = {}

    Returns void

selectAllRegions

  • selectAllRegions(): void

  • Returns void

selectNextRegion

  • selectNextRegion(): void

  • Returns void

selectPreviousRegion

  • selectPreviousRegion(): void

  • Returns void

selectRegionFromList

  • selectRegionFromList(region: RegionStore, regions: RegionStore[], options?: { range?: boolean; toggle?: boolean }): void

  • Parameters

    • region: RegionStore
    • regions: RegionStore[]
    • options: { range?: boolean; toggle?: boolean } = {}
      • optionalrange: boolean
      • optionaltoggle: boolean

    Returns void

selectSingleRegion

setEditableRegionsOpacity

setFocusedRegion

setIsHover

  • setIsHover(isHover: boolean): void

  • Parameters

    • isHover: boolean

    Returns void

setLocked

  • setLocked(shouldLock?: boolean): void

  • Parameters

    • optionalshouldLock: boolean

    Returns void

setMode

  • setMode(mode: any): void

  • Parameters

    • mode: any

    Returns void

setNewRegionType

  • setNewRegionType(type: RegionType): void

  • Parameters

    • type: RegionType

    Returns void

setSelectionByIds

  • setSelectionByIds(ids: number[], focusRegionId?: number): void

  • Parameters

    • ids: number[]
    • optionalfocusRegionId: number

    Returns void

toggleEditableRegionsLocked

  • toggleEditableRegionsLocked(): void

  • Returns void

toggleEditableRegionsVisibility

  • toggleEditableRegionsVisibility(): void

  • Returns void

toggleMode

  • toggleMode(): void

  • Returns void

toggleRegionSelection

toggleSelectedRegionsLocked

  • toggleSelectedRegionsLocked(): void

  • Returns void

toggleSelectedRegionsVisibility

  • toggleSelectedRegionsVisibility(): void

  • Returns void

translateRegionDrag

publicupdateCursorRegionPosition

  • updateCursorRegionPosition(pos: Point2D): void
Page Options