Interface Loader

Loader component

interface Loader {
    container: HTMLElement;
    parent: Viewer | AbstractComponent;
    viewer: Viewer;
    hide(options?: any): void;
    isVisible(): boolean;
    setProgress(value: number): void;
    show(options?: any): void;
    showUndefined(): void;
    toggle(visible?: boolean): void;
}

Hierarchy (View Summary)

AbstractComponent
- Loader

Index

Properties

container parent viewer

Methods

hide isVisible setProgress show showUndefined toggle

Properties

`Readonly`container

container: HTMLElement

Container element

`Protected` `Readonly`parent

parent: Viewer | AbstractComponent

`Protected` `Readonly`viewer

viewer: Viewer

Reference to main controller

Methods

hide

hide(options?: any): void
Hides the component
Parameters
- Optionaloptions: any
Returns void
Inherited from AbstractComponent.hide
- Defined in packages/core/src/components/AbstractComponent.ts:75

isVisible

isVisible(): boolean
Checks if the component is visible

Returns boolean
Inherited from AbstractComponent.isVisible
- Defined in packages/core/src/components/AbstractComponent.ts:93

setProgress

setProgress(value: number): void
Sets the loader progression
Parameters
- value: number
Returns void
- Defined in packages/core/src/components/Loader.ts:75

show

show(options?: any): void
Displays the component
Parameters
- Optionaloptions: any
Returns void
Inherited from AbstractComponent.show
- Defined in packages/core/src/components/AbstractComponent.ts:85

showUndefined

showUndefined(): void
Animates the loader with an unknown state

Returns void
- Defined in packages/core/src/components/Loader.ts:95

toggle

toggle(visible?: boolean): void
Displays or hides the component
Parameters
- visible: boolean = ...
Returns void
Inherited from AbstractComponent.toggle
- Defined in packages/core/src/components/AbstractComponent.ts:62