GuidesAPI Reference
Guides

water

Content: default
Geometry: line, point, polygon
Zoom: 0–17

The water layer in the HERE Vector Tile API includes information about various water features such as rivers, lakes, oceans, and other bodies of water. The features of the water layer provide data on the classification and attributes of these features, allowing you to visualize them on a map.

The following figure illustrates sample features of the water layer rendered from the data: View of the Mexico Gulf

The water layer comprises polygon geometries that depict oceans, riverbanks, and lakes. Additionally, it incorporates line geometries representing the centerlines of rivers and streams, as well as point geometries indicating the optimal positions for labeling polygons, ensuring duplication is avoided across tile boundaries.

Properties

kind | kind:{country_code} | name | name:{language_code} | translit:{language_code} | depth | display_class | intermittent | is_label

Common properties

min_zoom | sort_rank

Common properties specific to Japan - core map

source


kind

Type: string
Optional

The general type of water feature. For disputed water feature labels, see kind:{country_code} properties.

📘

Note

All polygons correspond to water area while points and lines are used for labeling.

Values

ValueGeometryZoomDescription
waterpolygon0–17A generic polygon representing various water bodies such as oceans, rivers, and lakes.
bathymetrypolygon0–17A polygon representing the depth of the ocean floor.
streamline5–17A small, narrow natural flowing waterway.
riverline, point0–17A large natural flowing watercourse, represented as a line or label placement point.
canalline, point5–17An artificial waterway constructed for navigation or irrigation.
oceanpoint1–17A vast body of saltwater covering major portions of the Earth's surface.
seapoint0–17A large body of saltwater partially enclosed by land.
baypoint0–17A broad inlet of the sea where the land curves inward.
fjordpoint6–17A long, narrow inlet with steep sides formed by glacial activity.
lakepoint4–17A large inland body of water surrounded by land.
straitpoint2–17A narrow waterway connecting two larger bodies of water.

Values specific to Japan - core map

ValueGeometryZoomDescription
swimming_poolpoint, polygon12–17An artificially constructed pool for swimming or recreation.

Type: string
Present when zoom is: 2, 3, 4, 6, 7, 8

An alternative to kind that reflects the geopolitical perspective of a country. To display map features according to a specific political perspective {country_code}, a renderer must utilize kind:{country_code} if available; otherwise, default to kind.

For example:

International view:

kind: bay
kind:us=unrecognized_sea

USA view:

kind:us=sea
View of the Mexico Gulf
ValueDescription
seaA large body of saltwater partially enclosed by land.
unrecognized_seaA sea not recognized from the perspective of the requested country.

name

Type: string
Optional

The common local name for the water body feature, in the local language script. For more information, see Feature names.


Type: string
Present when kind is: ocean, sea

The name of the feature in the specified language. If no data is available for the requested language code, the value may be compiled from an English or Latin transliteration of existing language representations. For more information, see Name localization.


translit:{language_code}

Type: string
Present when kind is: bay, canal, lake, river, sea

The localized transliteration of the default name (name). For more information, see Name localization.


depth

Type: int
Present when kind is: bathymetry

The distance from sea level to the ocean floor.

Value
4000
5000
6000

display_class

Type: int
Optional

This property indicates the importance of the corresponding water feature. The value is an integer from 1 (more important) to 8 (less important). Available for line and point geometries.

ValueDescriptionAssociated kind
1Most important feature.canal, fjord, ocean, sea, strait, stream
2canal, stream
3canal, stream
4canal, stream
5canal, stream
6canal, stream
7canal, stream, lake
8Least important feature.canal, stream

intermittent

Type: flag
Present when kind is: stream

This property marks features that sometimes run dry or disappear seasonally.


is_label

Type: flag
Present when kind is: canal, river

This property marks linear features which are generated from polygonal geometries. This property is available only for the line geometry.

Common properties


min_zoom

See min_zoom.


sort_rank

Type: int
Always present

The ordering of features, which determines which features are rendered "on top of" other features, can be an important issue when rendering maps. To assist map rendering, there is a sort_rank property on some features that suggests in what order the features should appear.

A feature with a higher sort_rank value is displayed on top of feature with a lower sort_rank value.

Values

ValueAssociated kind
200bay, fjord, sea, strait, water
201canal, river, stream
204lake
205bay, ocean
206bathymetry

Values specific to Japan - core map

ValueAssociated kind
415swimming_pool

Common properties specific to Japan - core map


source

See source.