Class EngineLoadingView

Implements

ILoadingViewHandler

Index

Constructors

Methods

onLoadingBegin onLoadingFinished onLoadingUpdate setMessage

Constructors

constructor

new EngineLoadingView(owner, opts?): EngineLoadingView
Creates a new loading view
Parameters
- owner: HTMLElement
  the element that will contain the loading view (should be the NeedleEngineHTMLElement)
- Optional opts: LoadingElementOptions
Returns EngineLoadingView

Methods

onLoadingBegin

onLoadingBegin(message?): Promise<void>
Parameters
- Optional message: string
Returns Promise<void>
Implementation of ILoadingViewHandler.onLoadingBegin

onLoadingFinished

onLoadingFinished(): void
Returns void
Implementation of ILoadingViewHandler.onLoadingFinished

onLoadingUpdate

onLoadingUpdate(progress, message?): void
Parameters
- progress: number | ProgressEvent<EventTarget> | LoadingProgressArgs
- Optional message: string
Returns void
Implementation of ILoadingViewHandler.onLoadingUpdate

setMessage

setMessage(message): void
Parameters
- message: string
Returns void
Implementation of ILoadingViewHandler.setMessage

Generated using TypeDoc