Skip to content

API NgxUiLoaderService

t-ho edited this page Jun 9, 2019 · 2 revisions

3. API - NgxUiLoaderService

  • NgxUiLoaderService.start([taskId]='default', [time]) Starts a foreground spinner with progress bar of the master loader. Users cannot interact with the page when the loader is showed.

  • NgxUiLoaderService.stop([taskId]='default') Stops a foreground spinner with progress bar of the master loader.

  • NgxUiLoaderService.startBackground([taskId]='default', [time]) Starts a background spinner of the master loader. Users can interact with the page when the loader is showed.

  • NgxUiLoaderService.stopBackground([taskId]='default') Stops a background spinner of the master loader.

  • NgxUiLoaderService.startLoader(loaderId, [taskId]='default', [time]) Starts a foreground spinner with progress bar of a specified loader. Users cannot interact with the page when the loader is showed.

  • NgxUiLoaderService.stopLoader(loaderId, [taskId]='default') Stops a foreground spinner with progress bar of a specified loader.

  • NgxUiLoaderService.startBackgroundLoader(loaderId, [taskId]='default', [time]) Starts a background spinner of a specified loader. Users can interact with the page when the loader is showed.

  • NgxUiLoaderService.stopBackgroundLoader(loaderId, [taskId]='default') Stops a background spinner of a specified loader.

  • NgxUiLoaderService.getDefaultConfig() Returns the default configuration object of ngx-ui-loader.

  • NgxUiLoaderService.getLoader([loaderId]) Return a specified loader. If no loaderId given, it will return master loader (if exist).

  • NgxUiLoaderService.getLoaders() Return the all of loaders.

  • NgxUiLoaderService.getStatus() Deprecated - will be remove in version 8.x.x.

  • NgxUiLoaderService.stopAll() Stops all foreground and background loadings/spinners of master loader.