@datafire/google_vectortile

Client library for Semantic Tile API

Installation and Usage

npm install --save @datafire/google_vectortile

let google_vectortile = require('@datafire/google_vectortile').create();

.then(data => {
  console.log(data);
});

Description

Serves vector tiles containing geospatial data.

Actions

vectortile.terraintiles.get

Gets a terrain tile by its tile resource name.

google_vectortile.vectortile.terraintiles.get({
  "name": ""
}, context)

Input

• input object
  • name required string: Required. Resource name of the tile. The tile resource name is prefixed by its collection ID terraintiles/ followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as @,,z. For example, terraintiles/@1,2,3z.
  • altitudePrecisionCentimeters integer: The precision of terrain altitudes in centimeters. Possible values: between 1 (cm level precision) and 1,000,000 (10-kilometer level precision).
  • clientInfo.apiClient string: API client name and version. For example, the SDK calling the API. The exact format is up to the client.
  • clientInfo.applicationId string: Application ID, such as the package name on Android and the bundle identifier on iOS platforms.
  • clientInfo.applicationVersion string: Application version number, such as "1.2.3". The exact format is application-dependent.
  • clientInfo.deviceModel string: Device model as reported by the device. The exact format is platform-dependent.
  • clientInfo.operatingSystem string (values: PLATFORM_UNSPECIFIED, EDITOR, MAC_OS, WINDOWS, LINUX, ANDROID, IOS, WEB_GL): Operating system name and version as reported by the OS. For example, "Mac OS X 10.10.4". The exact format is platform-dependent.
  • clientInfo.platform string (values: PLATFORM_UNSPECIFIED, EDITOR, MAC_OS, WINDOWS, LINUX, ANDROID, IOS, WEB_GL): Platform where the application is running.
  • clientInfo.userId string: Required. A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.client_info).
  • maxElevationResolutionCells integer: The maximum allowed resolution for the returned elevation heightmap. Possible values: between 1 and 1024 (and not less than min_elevation_resolution_cells). Over-sized heightmaps will be non-uniformly down-sampled such that each edge is no longer than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 100px (width) * 30px (height) max_elevation_resolution: 30 New resolution: 30px (width) * 30px (height)
  • minElevationResolutionCells integer: The minimum allowed resolution for the returned elevation heightmap. Possible values: between 0 and 1024 (and not more than max_elevation_resolution_cells). Zero is supported for backward compatibility. Under-sized heightmaps will be non-uniformly up-sampled such that each edge is no shorter than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 30px (width) * 10px (height) min_elevation_resolution: 30 New resolution: 30px (width) * 30px (height)
  • terrainFormats array: Terrain formats that the client understands.
  • enablePoliticalFeatures boolean: Flag indicating whether political features should be returned.
  • enablePrivateRoads boolean: Flag indicating whether the returned tile will contain road features that are marked private. Private roads are indicated by the Feature.segment_info.road_info.is_private field.
  • enableUnclippedBuildings boolean: Flag indicating whether unclipped buildings should be returned. If this is set, building render ops will extend beyond the tile boundary. Buildings will only be returned on the tile that contains their centroid.
  • languageCode string: Required. The BCP-47 language code corresponding to the language in which the name was requested, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
  • regionCode string: Required. The Unicode country/region code (CLDR) of the location from which the request is coming from, such as "US" and "419". For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output TerrainTile

Definitions

Area

• Area object: Represents an area. Used to represent regions such as water, parks, etc. Next ID: 10
  • basemapZOrder BasemapZOrder
  • hasExternalEdges boolean: True if the polygon is not entirely internal to the feature that it belongs to: that is, some of the edges are bordering another feature.
  • internalEdges array: When has_external_edges is true, the polygon has some edges that border another feature. This field indicates the internal edges that do not border another feature. Each value is an index into the vertices array, and denotes the start vertex of the internal edge (the next vertex in the boundary loop is the end of the edge). If the selected vertex is the last vertex in the boundary loop, then the edge between that vertex and the starting vertex of the loop is internal. This field may be used for styling. For example, building parapets could be placed only on the external edges of a building polygon, or water could be lighter colored near the external edges of a body of water. If has_external_edges is false, all edges are internal and this field will be empty.
    • items integer
  • loopBreaks array: Identifies the boundary loops of the polygon. Only set for INDEXED_TRIANGLE polygons. Each value is an index into the vertices array indicating the beginning of a loop. For instance, values of [2, 5] would indicate loop_data contained 3 loops with indices 0-1, 2-4, and 5-end. This may be used in conjunction with the internal_edges field for styling polygon boundaries. Note that an edge may be on a polygon boundary but still internal to the feature. For example, a feature split across multiple tiles will have an internal polygon boundary edge along the edge of the tile.
    • items integer
  • triangleIndices array: When the polygon encoding is of type INDEXED_TRIANGLES, this contains the indices of the triangle vertices in the vertex_offsets field. There are 3 vertex indices per triangle.
    • items integer
  • type string (values: TRIANGLE_FAN, INDEXED_TRIANGLES, TRIANGLE_STRIP): The polygon encoding type used for this area.
  • vertexOffsets Vertex2DList
  • zOrder integer: The z-ordering of this area. Areas with a lower z-order should be rendered beneath areas with a higher z-order. This z-ordering does not imply anything about the altitude of the line relative to the ground, but it can be used to prevent z-fighting during rendering on the client. This z-ordering can only be used to compare areas, and cannot be compared with the z_order field in the Line message. The z-order may be negative or zero. Prefer Area.basemap_z_order.

BasemapZOrder

• BasemapZOrder object: Metadata necessary to determine the ordering of a particular basemap element relative to others. To render the basemap correctly, sort by z-plane, then z-grade, then z-within-grade.
  • zGrade integer: The second most significant component of the ordering of a component to be rendered onto the basemap.
  • zPlane integer: The most significant component of the ordering of a component to be rendered onto the basemap.
  • zWithinGrade integer: The least significant component of the ordering of a component to be rendered onto the basemap.

ExtrudedArea

• ExtrudedArea object: Represents a height-extruded area: a 3D prism with a constant X-Y plane cross section. Used to represent extruded buildings. A single building may consist of several extruded areas. The min_z and max_z fields are scaled to the size of the tile. An extruded area with a max_z value of 4096 has the same height as the width of the tile that it is on.
  • area Area
  • maxZ integer: The z-value in local tile coordinates where the extruded area ends.
  • minZ integer: The z-value in local tile coordinates where the extruded area begins. This is non-zero for extruded areas that begin off the ground. For example, a building with a skybridge may have an extruded area component with a non-zero min_z.

Feature

• Feature object: A feature representing a single geographic entity.
  • displayName string: The localized name of this feature. Currently only returned for roads.
  • geometry Geometry
  • placeId string: Place ID of this feature, suitable for use in Places API details requests.
  • relations array: Relations to other features.
    • items Relation
  • segmentInfo SegmentInfo
  • type string (values: FEATURE_TYPE_UNSPECIFIED, STRUCTURE, BAR, BANK, LODGING, CAFE, RESTAURANT, EVENT_VENUE, TOURIST_DESTINATION, SHOPPING, SCHOOL, SEGMENT, ROAD, LOCAL_ROAD, ARTERIAL_ROAD, HIGHWAY, CONTROLLED_ACCESS_HIGHWAY, FOOTPATH, RAIL, FERRY, REGION, PARK, BEACH, FOREST, POLITICAL, ADMINISTRATIVE_AREA1, LOCALITY, SUBLOCALITY, WATER): The type of this feature.

FeatureTile

• FeatureTile object: A tile containing information about the map features located in the region it covers.
  • coordinates TileCoordinates
  • features array: Features present on this map tile.
    • items Feature
  • name string: Resource name of the tile. The tile resource name is prefixed by its collection ID tiles/ followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as @,,z. For example, tiles/@1,2,3z.
  • providers array: Data providers for the data contained in this tile.
    • items ProviderInfo
  • status string (values: STATUS_OK, STATUS_OK_DATA_UNCHANGED): Tile response status code to support tile caching.
  • versionId string: An opaque value, usually less than 30 characters, that contains version info about this tile and the data that was used to generate it. The client should store this value in its tile cache and pass it back to the API in the client_tile_version_id field of subsequent tile requests in order to enable the API to detect when the new tile would be the same as the one the client already has in its cache. Also see STATUS_OK_DATA_UNCHANGED.

FirstDerivativeElevationGrid

• FirstDerivativeElevationGrid object: A packed representation of a 2D grid of uniformly spaced points containing elevation data. Each point within the grid represents the altitude in meters above average sea level at that location within the tile. Elevations provided are (generally) relative to the EGM96 geoid, however some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0].a[m] +-----------------+ | | | N | | ^ | | | | | W <-----> E | | | | | v | | S | | | +-----------------+ rows[n].a[0] rows[n].a[m] Rather than storing the altitudes directly, we store the diffs between them as integers at some requested level of precision to take advantage of integer packing. The actual altitude values a[] can be reconstructed using the scale and each row's first_altitude and altitude_diff fields.
  • altitudeMultiplier number: A multiplier applied to the altitude fields below to extract the actual altitudes in meters from the elevation grid.
  • rows array: Rows of points containing altitude data making up the elevation grid. Each row is the same length. Rows are ordered from north to south. E.g: rows[0] is the north-most row, and rows[n] is the south-most row.
    • items Row

Geometry

• Geometry object: Represents the geometry of a feature, that is, the shape that it has on the map. The local tile coordinate system has the origin at the north-west (upper-left) corner of the tile, and is scaled to 4096 units across each edge. The height (Z) axis has the same scale factor: an extruded area with a max_z value of 4096 has the same height as the width of the tile that it is on. There is no clipping boundary, so it is possible that some coordinates will lie outside the tile boundaries.
  • areas array: The areas present in this geometry.
    • items Area
  • extrudedAreas array: The extruded areas present in this geometry.
    • items ExtrudedArea
  • lines array: The lines present in this geometry.
    • items Line
  • modeledVolumes array: The modeled volumes present in this geometry.
    • items ModeledVolume

Line

• Line object: Represents a 2D polyline. Used to represent segments such as roads, train tracks, etc.
  • basemapZOrder BasemapZOrder
  • vertexOffsets Vertex2DList
  • zOrder integer: The z-order of the line. Lines with a lower z-order should be rendered beneath lines with a higher z-order. This z-ordering does not imply anything about the altitude of the area relative to the ground, but it can be used to prevent z-fighting during rendering on the client. In general, larger and more important road features will have a higher z-order line associated with them. This z-ordering can only be used to compare lines, and cannot be compared with the z_order field in the Area message. The z-order may be negative or zero. Prefer Line.basemap_z_order.

ModeledVolume

• ModeledVolume object: Represents a modeled volume in 3D space. Used to represent 3D buildings.
  • strips array: The triangle strips present in this mesh.
    • items TriangleStrip
  • vertexOffsets Vertex3DList

ProviderInfo

• ProviderInfo object: Information about the data providers that should be included in the attribution string shown by the client.
  • description string: Attribution string for this provider. This string is not localized.

Relation

• Relation object: Represents a relation to another feature in the tile. For example, a building might be occupied by a given POI. The related feature can be retrieved using the related feature index.
  • relatedFeatureIndex integer: Zero-based index to look up the related feature from the list of features in the tile.
  • relationType string (values: RELATION_TYPE_UNSPECIFIED, OCCUPIES, PRIMARILY_OCCUPIED_BY): Relation type between the origin feature to the related feature.

RoadInfo

• RoadInfo object: Extra metadata relating to roads.
  • isPrivate boolean: Road has signage discouraging or prohibiting use by the general public. E.g., roads with signs that say "Private", or "No trespassing."

Row

• Row object: A row of altitude points in the elevation grid, ordered from west to east.
  • altitudeDiffs array: The difference between each successive pair of altitudes, from west to east. The first, westmost point, is just the altitude rather than a diff. The units are specified by the altitude_multiplier parameter above; the value in meters is given by altitude_multiplier * altitude_diffs[n]. The altitude row (in metres above sea level) can be reconstructed with: a[0] = altitude_diffs[0] * altitude_multiplier when n > 0, a[n] = a[n-1] + altitude_diffs[n-1] * altitude_multiplier.
    • items integer

SecondDerivativeElevationGrid

• SecondDerivativeElevationGrid object: A packed representation of a 2D grid of uniformly spaced points containing elevation data. Each point within the grid represents the altitude in meters above average sea level at that location within the tile. Elevations provided are (generally) relative to the EGM96 geoid, however some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0].a[m] +-----------------+ | | | N | | ^ | | | | | W <-----> E | | | | | v | | S | | | +-----------------+ rows[n].a[0] rows[n].a[m] Rather than storing the altitudes directly, we store the diffs of the diffs between them as integers at some requested level of precision to take advantage of integer packing. Note that the data is packed in such a way that is fast to decode in Unity and that further optimizes wire size.
  • altitudeMultiplier number: A multiplier applied to the elements in the encoded data to extract the actual altitudes in meters.
  • columnCount integer: The number of columns included in the encoded elevation data (i.e. the horizontal resolution of the grid).
  • encodedData string: A stream of elements each representing a point on the tile running across each row from left to right, top to bottom. There will be precisely horizontal_resolution * vertical_resolution elements in the stream. The elements are not the heights, rather the second order derivative of the values one would expect in a stream of height data. Each element is a varint with the following encoding: ------------------------------------------------------------------------| | Head Nibble | ------------------------------------------------------------------------| | Bit 0 | Bit 1 | Bits 2-3 | | Terminator| Sign (1=neg) | Least significant 2 bits of absolute error | ------------------------------------------------------------------------| | Tail Nibble #1 | ------------------------------------------------------------------------| | Bit 0 | Bit 1-3 | | Terminator| Least significant 3 bits of absolute error | ------------------------------------------------------------------------| | ... | Tail Nibble #n | ------------------------------------------------------------------------| | Bit 0 | Bit 1-3 | | Terminator| Least significant 3 bits of absolute error | ------------------------------------------------------------------------|
  • rowCount integer: The number of rows included in the encoded elevation data (i.e. the vertical resolution of the grid).

SegmentInfo

• SegmentInfo object: Extra metadata relating to segments.
  • roadInfo RoadInfo

TerrainTile

• TerrainTile object: A tile containing information about the terrain located in the region it covers.
  • coordinates TileCoordinates
  • firstDerivative FirstDerivativeElevationGrid
  • name string: Resource name of the tile. The tile resource name is prefixed by its collection ID terrain/ followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as @,,z. For example, terrain/@1,2,3z.
  • secondDerivative SecondDerivativeElevationGrid

TileCoordinates

• TileCoordinates object: Global tile coordinates. Global tile coordinates reference a specific tile on the map at a specific zoom level. The origin of this coordinate system is always at the northwest corner of the map, with x values increasing from west to east and y values increasing from north to south. Tiles are indexed using x, y coordinates from that origin. The zoom level containing the entire world in a tile is 0, and it increases as you zoom in. Zoom level n + 1 will contain 4 times as many tiles as zoom level n. The zoom level controls the level of detail of the data that is returned. In particular, this affects the set of feature types returned, their density, and geometry simplification. The exact tile contents may change over time, but care will be taken to keep supporting the most important use cases. For example, zoom level 15 shows roads for orientation and planning in the local neighborhood and zoom level 17 shows buildings to give users on foot a sense of situational awareness.
  • x integer: Required. The x coordinate.
  • y integer: Required. The y coordinate.
  • zoom integer: Required. The Google Maps API zoom level.

TriangleStrip

• TriangleStrip object: Represents a strip of triangles. Each triangle uses the last edge of the previous one. The following diagram shows an example of a triangle strip, with each vertex labeled with its index in the vertex_index array. (1)-----(3) / \ / \ / \ / \ / \ / \ (0)-----(2)-----(4) Vertices may be in either clockwise or counter-clockwise order.
  • vertexIndices array: Index into the vertex_offset array representing the next vertex in the triangle strip.
    • items integer

Vertex2DList

• Vertex2DList object: 2D vertex list used for lines and areas. Each entry represents an offset from the previous one in local tile coordinates. The first entry is offset from (0, 0). For example, the list of vertices [(1,1), (2, 2), (1, 2)] would be encoded in vertex offsets as [(1, 1), (1, 1), (-1, 0)].
  • xOffsets array: List of x-offsets in local tile coordinates.
    • items integer
  • yOffsets array: List of y-offsets in local tile coordinates.
    • items integer

Vertex3DList

• Vertex3DList object: 3D vertex list used for modeled volumes. Each entry represents an offset from the previous one in local tile coordinates. The first coordinate is offset from (0, 0, 0).
  • xOffsets array: List of x-offsets in local tile coordinates.
    • items integer
  • yOffsets array: List of y-offsets in local tile coordinates.
    • items integer
  • zOffsets array: List of z-offsets in local tile coordinates.
    • items integer