ImageViewConfigStore

Configuration of the images in the image view widget.

Index

Accessors

• colorBlendingImageMap
• colorBlendingImages
• currentImagePage
• frames
• imageNames
• imageNum
• imagePanelMode
• imagesPerPage
• numImageColumns
• numImagePages
• numImageRows
• visibleFrames
• visibleImages
• Instance

Methods

• addFrame
• createColorBlending
• getImage
• getImageListIndex
• removeAllImages
• removeColorBlending
• removeFrame
• reorderImage
• replaceFrame

Accessors

colorBlendingImageMap

• get colorBlendingImageMap(): Map<number, ColorBlendingStore>

• A map of all the color blended images with their ids as keys.

  ---

  Returns Map<number, ColorBlendingStore>

colorBlendingImages

• get colorBlendingImages(): ColorBlendingStore[]

• All the color blended images in the image list.

  ---

  Returns ColorBlendingStore[]

currentImagePage

• get currentImagePage(): number

• The index of the current page in the image view widget.

  ---

  Returns number

frames

• get frames(): FrameStore[]

• All the loaded images in the image list.

  ---

  Returns FrameStore[]

imageNames

• get imageNames(): string[]

• Filenames in the image list.

  ---

  Returns string[]

imageNum

• get imageNum(): number

• Number of images in the image list.

  ---

  Returns number

imagePanelMode

• get imagePanelMode(): ImagePanelMode

• The image panel mode.

  ---

  Returns ImagePanelMode

imagesPerPage

• get imagesPerPage(): number

• The number of image panels on a page.

  ---

  Returns number

numImageColumns

• get numImageColumns(): number

• The number of columns in the image view widget.

  ---

  Returns number

numImagePages

• get numImagePages(): number

• The total number of pages in the image view widget.

  ---

  Returns number

numImageRows

• get numImageRows(): number

• The number of rows in the image view widget.

  ---

  Returns number

visibleFrames

• get visibleFrames(): FrameStore[]

• The frames visible on the current page, including the loaded images and the layers of the color blended images.

  ---

  Returns FrameStore[]

visibleImages

• get visibleImages(): ImageViewItem[]

• The images on the current page in the image view widget.

  ---

  Returns ImageViewItem[]

staticInstance

• get Instance(): ImageViewConfigStore

• Returns ImageViewConfigStore

Methods

addFrame

• addFrame(frame: FrameStore): void

• Adds a loaded image to the image list.

  ---

  Parameters

  • frame: FrameStore

    The loaded image.

  Returns void

createColorBlending

• createColorBlending(): ColorBlendingStore

• Creates a new color blended image and adds it to the image list.

  ---

  Returns ColorBlendingStore

  The new color blended image.

getImage

• getImage(index: number): ImageViewItem

• Returns an image from the image list by index.

  ---

  Parameters

  • index: number

    The index of the image.

  Returns ImageViewItem

  A loaded image or a color blended image.

getImageListIndex

• getImageListIndex(type: FRAME | COLOR_BLENDING, id: number): number

• Returns the index of an image in the image list.

  ---

  Parameters

  • type: FRAME | COLOR_BLENDING

    The type of the image.

  • id: number

    The id of the image.

  Returns number

  The index of the image.

removeAllImages

• removeAllImages(): void

• Removes all images from the image list.

  ---

  Returns void

removeColorBlending

• removeColorBlending(image: ColorBlendingStore): void

• Removes a color blended image from the image list.

  ---

  Parameters

  • image: ColorBlendingStore

    The color blended image to remove.

  Returns void

removeFrame

• removeFrame(fileId: number): void

• Removes a loaded image from the image list.

  ---

  Parameters

  • fileId: number

    The file id of the loaded image.

  Returns void

reorderImage

• reorderImage(oldIndex: number, newIndex: number, length: number): void

• Reorders images in the image list.

  ---

  Parameters

  • oldIndex: number

    The first index of the images to move.

  • newIndex: number

    The index to move the image to.

  • length: number

    The length of the images to move.

  Returns void

replaceFrame

• replaceFrame(index: number, frame: FrameStore): void

• Replaces a loaded image in the image list.

  ---

  Parameters

  • index: number

    The image list index.

  • frame: FrameStore

    The new loaded image.

  Returns void