TimeSeriesStore

Manages the virtual time-series axis: an ordered mapping over explicitly selected member images, sorted by observation time.

Index

Accessors

• currentElement
• currentIndex
• elements
• members
• Instance

Methods

• canBeMember
• clearMembers
• ensureActiveElement
• first
• isMember
• last
• next
• prev
• setIndex
• setMember
• setMembers
• toggleMember

Accessors

currentElement

• get currentElement(): TimeSeriesElement | undefined

• The element matching the active image.

  ---

  Returns TimeSeriesElement | undefined

currentIndex

• get currentIndex(): number

• The index of the active loaded image, or -1 when the active item is not in the series.

  ---

  Returns number

elements

• get elements(): TimeSeriesElement[]

• The virtual time-series axis, sorted by ascending observation time.

  ---

  Returns TimeSeriesElement[]

members

• get members(): FrameStore[]

• Images explicitly selected as members of the time series.

  ---

  Returns FrameStore[]

publicstaticInstance

• get Instance(): TimeSeriesStore

• Returns TimeSeriesStore

Methods

canBeMember

• canBeMember(frame: FrameStore): boolean

• Parameters

  • frame: FrameStore

  Returns boolean

clearMembers

• clearMembers(): void

• Returns void

ensureActiveElement

• ensureActiveElement(): void

• Selects the first time-series element when the active image is outside the series.

  ---

  Returns void

first

• first(): void

• Returns void

isMember

• isMember(frame: FrameStore): boolean

• Parameters

  • frame: FrameStore

  Returns boolean

last

• last(): void

• Returns void

next

• next(): void

• Returns void

prev

• prev(): void

• Returns void

setIndex

• setIndex(index: number): void

• Switches the active image to the given element of the series.

  ---

  Parameters

  • index: number

  Returns void

setMember

• setMember(frame: FrameStore, isMember: boolean): boolean

• Adds or removes an image from the time series. Invalid-time and preview images cannot be added.

  ---

  Parameters

  • frame: FrameStore

  • isMember: boolean

  Returns boolean

setMembers

• setMembers(frames: readonly FrameStore[], isMember: boolean): number

• Adds or removes multiple images in a single action and returns the number changed.

  ---

  Parameters

  • frames: readonly FrameStore[]

  • isMember: boolean

  Returns number

toggleMember

• toggleMember(frame: FrameStore): boolean

• Parameters

  • frame: FrameStore

  Returns boolean