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.
- Alphabetic
- By Inheritance
- GenerationConfig
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val buffer: Double
- val cacheFrequency: Option[Int]
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- val convertPolygonsToLabelPoints: Boolean
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val featureFilter: Option[Column]
- val featureSimplify: Option[Column]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- val getFeatureFilter: Column
- val getFeatureSimplify: Column
- val getPartitionCount: Int
- val getTileFilter: Column
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val maxDatasetSize: Option[Int]
- val maxFeaturesPerTile: Option[Int]
- val maxZoom: Int
- val minZoom: Int
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- val partitionCount: Option[Int]
- val persistStorageLevel: StorageLevel
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val repartitionFrequency: Option[Int]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val tileFilter: Option[Column]
- val tileResolution: Int
- def validate(): Unit
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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
- 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
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)