Module: ol/source/Source

ol/source/Source


Classes

Source

Type Definitions

Attribution()

A function that takes a module:ol/PluggableMap~FrameState and returns a string or an array of strings representing source attributions.

AttributionLike{string} {Array.<string>} {module:ol/source/Source~Attribution}

A type that can be used to provide attribution information for data sources.

It represents either

  • a simple string (e.g. '© Acme Inc.')
  • an array of simple strings (e.g. ['© Acme Inc.', '© Bacme Inc.'])
  • a function that returns a string or array of strings (module:ol/source/Source~Attribution)

Options{Object}

Properties:
Name Type Argument Default Description
attributions module:ol/source/Source~AttributionLike <optional>

Attributions.

attributionsCollapsible boolean <optional>
true

Attributions are collapsible.

projection module:ol/proj~ProjectionLike <optional>

Projection. Default is the view projection.

state module:ol/source/Source~State <optional>
'ready'

State.

wrapX boolean <optional>
false

WrapX.

interpolate boolean <optional>
false

Use interpolated values when resampling. By default, the nearest neighbor is used when resampling.

State{'undefined'} {'loading'} {'ready'} {'error'}

State of the source, one of 'undefined', 'loading', 'ready' or 'error'.