Packages

c

com.wherobots.VTiles

GenerationConfig

case class GenerationConfig(minZoom: Int = 0, maxZoom: Int = 15, tileResolution: Int = 4096, buffer: Double = 0.1, featureFilter: Option[Column] = None, tileFilter: Option[Column] = None, featureSimplify: Option[Column] = None, maxFeaturesPerTile: Option[Int] = Some(50000), cacheFrequency: Option[Int] = Some(2), persistStorageLevel: StorageLevel = StorageLevel.MEMORY_AND_DISK, maxDatasetSize: Option[Int] = None, partitionCount: Option[Int] = None, repartitionFrequency: Option[Int] = None, convertPolygonsToLabelPoints: Boolean = false) extends Product with Serializable

minZoom

the lowest zoom for which to generate tiles

maxZoom

the highest zoom for which to generate tiles

tileResolution

the resolution of the tiles to generate

buffer

the buffer (as a fraction) to apply to the tiles. the margin on a 1000 resolution tile with a buffer of .1 would be 100

featureFilter

a predicate Column for filtering features, optional

tileFilter

a Column for manipulating the array of features within a tile, optional

featureSimplify

a Column for manipulating feature geometries, optional

maxFeaturesPerTile

the maximum number of features to include in each tile, optional

cacheFrequency

the frequency at which to cache the dataset, optional. e.g 2 means every 2nd zoom level. Default is 2

persistStorageLevel

the storage level to persist the dataset at. Default is DISK_ONLY

maxDatasetSize

the maximum size of the dataset from which to generate tiles, optional. if the dataset is larger than this, it will be reduced to this size by randomly sampling features

partitionCount

the number of partitions to use in tile generation. Default is 2x the number of worker cores

repartitionFrequency

the frequency (ie number of zoom levels) at which to repartition the dataset. Default behavior not to repartition a certain zooms. Repartitioning helps when the geometries are large relative to the tiles, for example processing a collection of countries to zoom 16.

convertPolygonsToLabelPoints

Experimental, Unstable feature. whether to replace polygons with a point in each tile the Polygon appears in. Default is false.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GenerationConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GenerationConfig(minZoom: Int = 0, maxZoom: Int = 15, tileResolution: Int = 4096, buffer: Double = 0.1, featureFilter: Option[Column] = None, tileFilter: Option[Column] = None, featureSimplify: Option[Column] = None, maxFeaturesPerTile: Option[Int] = Some(50000), cacheFrequency: Option[Int] = Some(2), persistStorageLevel: StorageLevel = StorageLevel.MEMORY_AND_DISK, maxDatasetSize: Option[Int] = None, partitionCount: Option[Int] = None, repartitionFrequency: Option[Int] = None, convertPolygonsToLabelPoints: Boolean = false)

    minZoom

    the lowest zoom for which to generate tiles

    maxZoom

    the highest zoom for which to generate tiles

    tileResolution

    the resolution of the tiles to generate

    buffer

    the buffer (as a fraction) to apply to the tiles. the margin on a 1000 resolution tile with a buffer of .1 would be 100

    featureFilter

    a predicate Column for filtering features, optional

    tileFilter

    a Column for manipulating the array of features within a tile, optional

    featureSimplify

    a Column for manipulating feature geometries, optional

    maxFeaturesPerTile

    the maximum number of features to include in each tile, optional

    cacheFrequency

    the frequency at which to cache the dataset, optional. e.g 2 means every 2nd zoom level. Default is 2

    persistStorageLevel

    the storage level to persist the dataset at. Default is DISK_ONLY

    maxDatasetSize

    the maximum size of the dataset from which to generate tiles, optional. if the dataset is larger than this, it will be reduced to this size by randomly sampling features

    partitionCount

    the number of partitions to use in tile generation. Default is 2x the number of worker cores

    repartitionFrequency

    the frequency (ie number of zoom levels) at which to repartition the dataset. Default behavior not to repartition a certain zooms. Repartitioning helps when the geometries are large relative to the tiles, for example processing a collection of countries to zoom 16.

    convertPolygonsToLabelPoints

    Experimental, Unstable feature. whether to replace polygons with a point in each tile the Polygon appears in. Default is false.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val buffer: Double
  6. val cacheFrequency: Option[Int]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  8. val convertPolygonsToLabelPoints: Boolean
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. val featureFilter: Option[Column]
  11. val featureSimplify: Option[Column]
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. val getFeatureFilter: Column
  14. val getFeatureSimplify: Column
  15. val getPartitionCount: Int
  16. val getTileFilter: Column
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val maxDatasetSize: Option[Int]
  19. val maxFeaturesPerTile: Option[Int]
  20. val maxZoom: Int
  21. val minZoom: Int
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  25. val partitionCount: Option[Int]
  26. val persistStorageLevel: StorageLevel
  27. val repartitionFrequency: Option[Int]
  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. val tileFilter: Option[Column]
  30. val tileResolution: Int
  31. def validate(): Unit
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def withSuggestedMaxZoom(df: Dataset[Row]): GenerationConfig

    Sets the maxZoom based on heuristics of the input dataframe

    Sets the maxZoom based on heuristics of the input dataframe

    df

    The dataframe that will be used along with this Config to generate tiles.

    returns

    a new GenerationConfig with the maxZoom set based on heuristics of the input dataframe

  36. def withSuggestedMinZoom(df: Dataset[Row]): GenerationConfig

    Sets the minZoom based on heuristics of the input dataframe

    Sets the minZoom based on heuristics of the input dataframe

    df

    The dataframe that will be used along with this Config to generate tiles.

    returns

    a new GenerationConfig with the minZoom set based on heuristics of the input dataframe

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped