TileOptions

Options describing image or video map tiles to export.

JSON representation
{
  "startZoom": integer,
  "minZoom": integer,
  "skipEmpty": boolean,
  "skipEmptyTiles": boolean,
  "mapsApiKey": string,
  "dimensions": {
    object (GridDimensions)
  },
  "tileDimensions": {
    object (GridDimensions)
  },
  "stride": integer,
  "zoomSubset": {
    object (ZoomSubset)
  },

  // Union field end_zoom_or_scale can be only one of the following:
  "endZoom": integer,
  "maxZoom": integer,
  "scale": number
  // End of list of possible types for union field end_zoom_or_scale.
}
Fields
startZoom

integer

The zoom level to start generating map tiles for export. Defaults to zero.

minZoom
(deprecated)

integer

The zoom level to start generating map tiles for export. Defaults to zero.

skipEmpty

boolean

If true, skip writing empty (i.e. fully-transparent) map tiles.

skipEmptyTiles
(deprecated)

boolean

If true, skip writing empty (i.e. fully-transparent) map tiles.

mapsApiKey

string

Optional Google Maps Platform API Key for generated map tile viewer.

dimensions

object (GridDimensions)

The width and height of output video tiles, used only for exporting tiled video pyramids (videoMap.export).

tileDimensions
(deprecated)

object (GridDimensions)

The width and height of output video tiles, used only for exporting tiled video pyramids (videoMap.export).

stride

integer

Tile row and column stride. (videoMap.export) Set to 4 for sparse tiles (WebGL-only) or 1 (default) for maximum compatibility.

zoomSubset

object (ZoomSubset)

A subset of zoom levels for which to generate tiles. May only be specified in a call to videoMap.export.

Union field end_zoom_or_scale. The zoom level or scale at which to stop generating map tiles for. One or the other of these must be specified. end_zoom_or_scale can be only one of the following:
endZoom

integer

The zoom level to stop generating map tiles for.

maxZoom
(deprecated)

integer

The zoom level to stop generating map tiles for.

scale

number

The max image resolution in meters per pixel. The scale will be converted to the most appropriate maximum zoom level at the equator.

ZoomSubset

A subset of zoom levels for which to generate tiles (videoMap.export), Start and end subsets are double precision values, allowing you to render a zoom level or levels incrementally. To render a whole pyramid with a start zoom of 12: startZoom=0, endZoom=12, don't set this message. To render levels 0-11 and the first 10% of level 12: startZoom=0, endZoom=12, subset = {min=0, max=12.1 } To render the next 10% of level 12: startZoom=0, endZoom=12, subset = {min=12.1, max=12.2 } To render the remaining 80% of level 12: startZoom=0, endZoom=12, subset = {min=12.2, max=13 } Also note that all export shards must have the same (full) pyramid size in start/endZoom.

JSON representation
{
  "start": number,
  "end": number,
  "min": number,
  "max": number
}
Fields
start

number

Starting zoom level subset for which to generate tiles (videoMap.export) Here, subset is a double precision value, allowing you to render a zoom level incrementally, so 12.1 for example is the first 10% of the tiles in zoom 12 in some unspecified but deterministic order.

end

number

Ending zoom level subset for which to generate tiles (videoMap.export), allowing you to render a zoom level incrementally, up to but not including the maximum subset (if provided) in some unspecified but deterministic order.

min
(deprecated)

number

Starting zoom level subset for which to generate tiles (videoMap.export) Here, subset is a double precision value, allowing you to render a zoom level incrementally, so 12.1 for example is the first 10% of the tiles in zoom 12 in some unspecified but deterministic order.

max
(deprecated)

number

Ending zoom level subset for which to generate tiles (videoMap.export), allowing you to render a zoom level incrementally, up to but not including the maximum subset (if provided) in some unspecified but deterministic order.