Skip to content

loading-widget.md

Latest commit

 

History

History
57 lines (34 loc) · 1.75 KB

loading-widget.md

File metadata and controls

57 lines (34 loc) · 1.75 KB
Raw

import {WidgetPreview} from '@site/src/doc-demos/widgets'; import {_LoadingWidget} from '@deck.gl/widgets';

LoadingWidget (Experimental)

from v9.2

This widget shows a spinning indicator while any deck.gl layers are loading data.

import {_LoadingWidget as LoadingWidget} from '@deck.gl/widgets';
import {Deck} from '@deck.gl/core';

const deck = new Deck({
  widgets: [new LoadingWidget()]
});

Types

LoadingnWidgetProps

The LoadingnWidget accepts the generic WidgetProps:

  • id (default 'loading') - Unique id for this widget
  • placement (default 'top-left') - Widget position within the view relative to the map container
  • viewId (default null) - The viewId prop controls how a widget interacts with views.
  • style (default {}) - Additional inline styles on the top HTML element.
  • className (default '') - Additional classnames on the top HTML element.

Props

id (string, optional) {#id}

Default: 'loading'

The id must be unique among all your widgets at a given time.

Note: It is necessary to set id explicitly if you have more than once instance of the same widget.

placement (string, optional) {#placement}

Default: 'top-left'

Widget position within the view relative to the map container. Valid options are top-left, top-right, bottom-left, bottom-right, or fill.

label (string, optional) {#label}

Tooltip message displayed while hovering a mouse over the widget.

Default: 'Loading data'

Source

modules/widgets/src/loading-widget.tsx