Type Members

1.  trait Layer extends Serializable

   A layer, which could contain any number of Features of any Geometry type.

   A layer, which could contain any number of Features of any Geometry type. Here, "Feature" and "Geometry" refer specifically to the GeoTrellis classes of the same names.

   Annotations

   @experimental()

2.  case class LazyLayer(rawLayer: PBLayer, tileExtent: Extent) extends Layer with Product with Serializable

   A Layer decoded from Protobuf data.

   A Layer decoded from Protobuf data. All of its Features are decoded lazily, making for very fast extraction of single features/geometries.

   Annotations

   @experimental()

3.  case class MVTFeature[+G <: Geometry](id: Option[Long], geom: G, data: Map[String, Value]) extends Product with Serializable

   A case class that conforms to the Mapbox Vector Tile 2.0 specification

   A case class that conforms to the Mapbox Vector Tile 2.0 specification

   Users are responsible for converting their geometries, features and other objects to MVTFeatures so that they can be written to mvts using VectorTile.

   https://docs.mapbox.com/vector-tiles/specification/

4.  case class StrictLayer(name: String, tileWidth: Int, version: Int, tileExtent: Extent, points: Seq[MVTFeature[Point]], multiPoints: Seq[MVTFeature[MultiPoint]], lines: Seq[MVTFeature[LineString]], multiLines: Seq[MVTFeature[MultiLineString]], polygons: Seq[MVTFeature[Polygon]], multiPolygons: Seq[MVTFeature[MultiPolygon]]) extends Layer with Product with Serializable

   A Layer crafted through some strict ingest process.

   A Layer crafted through some strict ingest process.

   Annotations

   @experimental()

5.  case class VBool(value: Boolean) extends Value with Product with Serializable

   A wrapper for Boolean to allow all Value subtypes to be stored in the same Map.

6.  case class VDouble(value: Double) extends Value with Product with Serializable

   A wrapper for Double to allow all Value subtypes to be stored in the same Map.

7.  case class VFloat(value: Float) extends Value with Product with Serializable

   A wrapper for Float to allow all Value subtypes to be stored in the same Map.

8.  case class VInt64(value: Long) extends Value with Product with Serializable

   A wrapper for Long to allow all Value subtypes to be stored in the same Map.

9.  case class VSint64(value: Long) extends Value with Product with Serializable

   A wrapper for zig-zag encoded ints to allow all Value subtypes to be stored in the same Map.

10.  case class VString(value: String) extends Value with Product with Serializable

    A wrapper for String to allow all Value subtypes to be stored in the same Map.

11.  case class VWord64(value: Long) extends Value with Product with Serializable

    A wrapper for unsigned, 64-bit ints to allow all Value subtypes to be stored in the same Map.

12.  sealed trait Value extends Serializable

    Feature metadata key/value Maps are completely untyped.

    Feature metadata key/value Maps are completely untyped. All keys and values used by Features across a common parent Layer are stored in that parent. Raw Features themselves only store indices into the parent's key/value lists. So, for an example MultiPoint Feature of fire hydrant locations, its metadata could look like:

    { name: "Hydrants",
      colour: "red",
      model: 5
    }

    That's fine if interpreted as JSON, but bad as Scala, as it doesn't give us a clean Map[String, ConcreteTypeHere]. Furthermore, Features within the same Layer don't have to agree on the Value type for the same key:

    { name: "Stop lights",
      colour: 1,
      model: "ABC-123"
    }

    Nor, actually, do Layers have to agree on key sets for their Features. The sealed trait Value here and its extensions aim to provide some type safety in light of the situation described here.

13.  case class VectorTile(layers: Map[String, Layer], tileExtent: Extent, forcePolygonWinding: Boolean = true) extends Product with Serializable

    A concrete representation of a VectorTile, as one decoded from Protobuf bytes.

    A concrete representation of a VectorTile, as one decoded from Protobuf bytes. At its simplest, a Tile is just a collection of Layers. We opt to expose each Layer name at the Tile level, as the keys of a Map. This way, if the layer names are known by the user ahead of time, they can search through the Tile quickly.

    import geotrellis.vectortile._
    
    val bytes: Array[Byte] = ...  // from some `.mvt` file
    val key: SpatialKey = ...  // preknown
    val layout: LayoutDefinition = ...  // preknown
    val tileExtent: Extent = layout.mapTransform(key)
    
    val tile: VectorTile = VectorTile.fromBytes(bytes, tileExtent)

    Annotations

    @experimental()