Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProgressBar

Hierarchy

  • ProgressBar

Index

Constructors

Methods

Constructors

constructor

  • new ProgressBar(parentElement: HTMLElement): ProgressBar

  • Parameters

    • parentElement: HTMLElement

    Returns ProgressBar

Methods

addProgressItem

  • addProgressItem(progressItemId: string, message?: string): void

  • Adds a progress item

    Parameters

    • progressItemId: string
    • Optional message: string

      Initial message

    Returns void

delayRemoveProgressItem

  • delayRemoveProgressItem(progressItemId: string, delayInMs?: number): void

  • Removes a progress item after some time

    Parameters

    • progressItemId: string
    • delayInMs: number = 3000

    Returns void

removeProgressItem

  • removeProgressItem(progressItemId: string): void

  • Removes a progress item

    Parameters

    • progressItemId: string

    Returns void

setVisibility

  • setVisibility(visible: boolean): void

  • Parameters

    • visible: boolean

    Returns void

updateProgress

  • updateProgress(progressItemId: string, message?: string, progress?: number): void

  • Updates a progress item

    Parameters

    • progressItemId: string
    • Optional message: string
    • Optional progress: number

      number between 0-100

    Returns void

Generated using TypeDoc