Class Progress

Progress control. Displays a progress ring or bar on the ui.

Hierarchy

Progress

Index

Constructors

Properties

element htmlStrings

Methods

createControl dispose hide show

Constructors

constructor

new Progress(element: HTMLElement, type?: ProgressType, size?: ProgressSize): Progress
Parameters
- element: HTMLElement
- type: ProgressType = ProgressType.ring
  
  Use numbers for the progressType. 0 = ring, 1 = bar; See ProgressType
- size: ProgressSize = ProgressSize.small
  
  Use numbers for the progress size. 0 = xsmall, 1 = small, 2 = medium, 3 = large. See ProgressSize
Returns Progress

Properties

element

element: HTMLElement

`Private` htmlStrings

htmlStrings: { bar: string; ring: string } = ...

Type declaration

bar: string
ring: string

Methods

`Protected` createControl

createControl(): Promise<void>
Returns Promise<void>

dispose

dispose(): void
Disposes the control.

Returns void

hide

hide(delay?: number): Promise<void>
Hides the progress. When not needed again the control should be disposed afterwards.
Parameters
- delay: number = 300
  
  Fade-out delay of the progress. Default: 300ms.
Returns Promise<void>

show

show(delay?: number): void
Shows the progress on the ui.
Parameters
- delay: number = 300
  
  [optional] Fade-in delay in milliseconds of the progress. Default: 300ms;
Returns void

Generated using TypeDoc