AnimatorStore

Index

Constructors

• constructor

Properties

• animationMode
• frameRate
• isAnimationActive
• maxFrameRate
• maxStep
• minFrameRate
• minStep
• playMode
• step

Accessors

• frameInterval
• isFrontendAnimationMode
• isServerAnimationActive
• shouldStartAnimationDisable
• Instance

Methods

• animate
• selectFirstAvailableAnimationMode
• setAnimationMode
• setFrameRate
• setStep
• startAnimation
• stopAnimation

Constructors

constructor

• AnimatorStore(): AnimatorStore

• Returns AnimatorStore

Properties

animationMode

animationMode: AnimationMode = AnimationMode.CHANNEL

frameRate

frameRate: number = 5

isAnimationActive

isAnimationActive: boolean = false

maxFrameRate

maxFrameRate: number = 15

maxStep

maxStep: number = 50

minFrameRate

minFrameRate: number = 1

minStep

minStep: number = 1

playMode

playMode: PlayMode = PlayMode.FORWARD

step

step: number = 1

Accessors

frameInterval

• get frameInterval(): number

• Returns number

isFrontendAnimationMode

• get isFrontendAnimationMode(): boolean

• Whether the current mode is driven by the frontend, stepping through images rather than asking the backend for frames.

  ---

  Returns boolean

isServerAnimationActive

• get isServerAnimationActive(): boolean

• Returns boolean

shouldStartAnimationDisable

• get shouldStartAnimationDisable(): boolean

• Whether the animation feature should be disabled. It is disabled when no image is loaded or only one animation step is available, e.g., animating channels of a 2D image.

  ---

  Returns boolean

publicstaticInstance

• get Instance(): AnimatorStore

• Returns AnimatorStore

Methods

animate

• animate(): void

• Returns void

selectFirstAvailableAnimationMode

• selectFirstAvailableAnimationMode(): boolean

• Selects the first available Animator control, following the order shown in the widget.

  ---

  Returns boolean

setAnimationMode

• setAnimationMode(val: AnimationMode): void

• Parameters

  • val: AnimationMode

  Returns void

setFrameRate

• setFrameRate(val: number): void

• Parameters

  • val: number

  Returns void

setStep

• setStep(val: number): void

• Parameters

  • val: number

  Returns void

startAnimation

• startAnimation(): Generator<Promise<$Properties>, void, unknown>

• Returns Generator<Promise<$Properties>, void, unknown>

stopAnimation

• stopAnimation(): void

• Returns void