Skip to content

Tile

Get vector tile data.

Source code in osrm/__init__.py
def Tile(self, params):
    """Get vector tile data."""
    result = self._engine.Tile(params)
    # Tile returns bytes (vector tiles), not JSON
    if isinstance(result, bytes):
        return result
    return result.to_dict()

Tile Parameters

init(self, arg: collections.abc.Sequence[int], /) -> None

Overloaded function.

  1. __init__(self) -> None

Instantiates an instance of TileParameters.

Examples:

>>> tile_params = osrm.TileParameters([17059, 11948, 15])
>>> tile_params = osrm.TileParameters(
        x = 17059,
        y = 11948,
        z = 15
    )
>>> tile_params.IsValid()
True

Parameters:

Name Type Description Default
list list of int

Instantiates an instance of TileParameters using an array [x, y, z].

required
x int

x value.

required
y int

y value.

required
z int

z value.

required

Returns:

Name Type Description
__init__ TileParameters

A TileParameters object, for usage in Tile.

IsValid bool

A bool value denoting validity of parameter values.

Attributes:

Name Type Description
x int

x value.

y int

y value.

z int

z value.

  1. __init__(self, arg0: int, arg1: int, arg2: int, /) -> None

  2. __init__(self, arg: collections.abc.Sequence[int], /) -> None