EmptyTerrain

Source: EmptyTerrain.ts:45

Class represents terrain provider without elevation data.

Constructor

Parameters

• options (IEmptyTerrainParams, optional) — Provider options:
  • options.name (string, optional, default: "\"empty\"") — Provider name.
  • options.attribution (string, optional, default: "\"\"") — Terrain attribution shown in the attribution area.
  • options.iconSrc (string | null, optional) — Icon for LayerSwitcher.
  • options.equalizeVertices (boolean, optional, default: false) — Enables vertex equalization on tile borders.
  • options.minZoom (number, optional, default: 2) — Minimal visible zoom index when terrain handler works.
  • options.maxZoom (number, optional, default: 19) — Maximal visible zoom index when terrain handler works.
  • options.maxNativeZoom (number, optional, default: 19) — Maximal available terrain zoom level.
  • options.gridSizeByZoom (Array.<number>, optional) — Segment triangulation grid sizes by zoom index.
  • options.geoid (Geoid, optional) — Geoid model instance.
  • options.geoidSrc (string, optional) — URL to geoid model source.

Instance Methods

setUrlRewriteCallback(ur: UrlRewriteFunc)

Sets url rewrite callback, used for custom url rewriting for every tile loading.

Parameters

• ur (UrlRewriteFunc) — The callback that returns tile custom created url.

setAttribution(html: string)

Sets terrain provider attribution text.

Parameters

• html (string) — HTML string that represents terrain provider attribution.

getAttribution(): string

Gets terrain provider attribution.

Returns

• string — Terrain provider attribution.

handleSegmentTerrain(segment: Segment)

Loads or creates segment elevation data.

Parameters

• segment (Segment) — Segment to create elevation data.

Instance Fields

iconSrc

Gets terrain provider icon.

Returns

• string | null — Icon source.

iconSrc

Sets terrain provider icon.

Parameters

• src (string | null) — Icon source.