Class FeatureTileGenerator

Creates a set of tiles within a GeoPackage by generating tiles from features

Hierarchy

TileGenerator
- FeatureTileGenerator

Constructors

constructor

new FeatureTileGenerator(geoPackage: GeoPackage, tableName: string, featureTiles: FeatureTiles, featureGeoPackage: GeoPackage, zoomLevels: number[], projection: Projection): FeatureTileGenerator
Constructor
Parameters
- geoPackage: GeoPackage
  
  GeoPackage
- tableName: string
  
  table name
- featureTiles: FeatureTiles
  
  feature tiles
- featureGeoPackage: GeoPackage
  
  feature GeoPackage if different from the destination
- zoomLevels: number[]
  
  zoom levels
- projection: Projection
  
  tiles projection
Returns FeatureTileGenerator
Overrides TileGenerator.constructor
- Defined in lib/tiles/features/featureTileGenerator.ts:32

Properties

`Protected` boundingBox

boundingBox: BoundingBox

Tile bounding box

`Protected` projection

projection: Projection

Tiles projection

Methods

addZoomLevel

addZoomLevel(zoomLevel: any): boolean
Add a zoom level

Returns
true if zoom level added
Parameters
- zoomLevel: any
  
  zoom level
Returns boolean
Inherited from TileGenerator.addZoomLevel
- Defined in lib/tiles/tileGenerator.ts:188

addZoomLevelRange

addZoomLevelRange(minZoom: number, maxZoom: number): boolean
Add a range of zoom levels

Returns
true if at least one zoom level added
Parameters
- minZoom: number
  
  min zoom level
- maxZoom: number
  
  max zoom level
Returns boolean
Inherited from TileGenerator.addZoomLevelRange
- Defined in lib/tiles/tileGenerator.ts:204

addZoomLevels

addZoomLevels(zoomLevels: number[]): boolean
Add zoom levels

Returns
true if at least one zoom level added
Parameters
- zoomLevels: number[]
  
  zoom levels
Returns boolean
Inherited from TileGenerator.addZoomLevels
- Defined in lib/tiles/tileGenerator.ts:217

close

close(): void
Close the GeoPackage

Returns void
Inherited from TileGenerator.close
- Defined in lib/tiles/tileGenerator.ts:750

`Protected` createTile

createTile(z: number, x: number, y: number): Promise<GeoPackageTile>
{@inheritDoc}
Parameters
- z: number
- x: number
- y: number
Returns Promise<GeoPackageTile>
Overrides TileGenerator.createTile
- Defined in lib/tiles/features/featureTileGenerator.ts:115

generateTiles

generateTiles(): Promise<number>
Generate the tiles

Returns
tiles created

Returns Promise<number>
Inherited from TileGenerator.generateTiles
- Defined in lib/tiles/tileGenerator.ts:383

getBoundingBox

getBoundingBox(): BoundingBox
Get bounding box

Returns
bounding box

Returns BoundingBox
Inherited from TileGenerator.getBoundingBox
- Defined in lib/tiles/tileGenerator.ts:229

getBoundingBoxWithZoom

getBoundingBoxWithZoom(zoom: number): BoundingBox
Get the bounding box, possibly expanded for the zoom level

Returns
original or expanded bounding box
Parameters
- zoom: number
  
  zoom level
Returns BoundingBox
Inherited from TileGenerator.getBoundingBoxWithZoom
- Defined in lib/tiles/tileGenerator.ts:239

getCompressFormat

getCompressFormat(): ImageType
Get the compress format

Returns
compress format

Returns ImageType
Inherited from TileGenerator.getCompressFormat
- Defined in lib/tiles/tileGenerator.ts:255

getCompressQuality

getCompressQuality(): number
Get the compress quality

Returns
compress quality or null

Returns number
Inherited from TileGenerator.getCompressQuality
- Defined in lib/tiles/tileGenerator.ts:275

getGeoPackage

getGeoPackage(): GeoPackage
Get the GeoPackage

Returns
GeoPackage

Returns GeoPackage
Inherited from TileGenerator.getGeoPackage
- Defined in lib/tiles/tileGenerator.ts:143

getMaxZoom

getMaxZoom(): number
Get the max zoom

Returns
max zoom

Returns number
Inherited from TileGenerator.getMaxZoom
- Defined in lib/tiles/tileGenerator.ts:170

getMinZoom

getMinZoom(): number
Get the min zoom

Returns
min zoom

Returns number
Inherited from TileGenerator.getMinZoom
- Defined in lib/tiles/tileGenerator.ts:161

getProgress

getProgress(): GeoPackageZoomLevelProgress
Get the progress tracker

Returns
progress

Returns GeoPackageZoomLevelProgress
Inherited from TileGenerator.getProgress
- Defined in lib/tiles/tileGenerator.ts:291

getScaling

getScaling(): TileScaling
Get the tile scaling settings

Returns
tile scaling

Returns TileScaling
Inherited from TileGenerator.getScaling
- Defined in lib/tiles/tileGenerator.ts:316

getTableName

getTableName(): string
Get the table name

Returns
table name

Returns string
Inherited from TileGenerator.getTableName
- Defined in lib/tiles/tileGenerator.ts:152

getTileCount

getTileCount(): number
Get the tile count of tiles to be generated

Returns
tile count

Returns number
Inherited from TileGenerator.getTileCount
- Defined in lib/tiles/tileGenerator.ts:348

getZoomLevels

getZoomLevels(): number[]
Get the zoom levels (read only)

Returns
zoom levels

Returns number[]
Inherited from TileGenerator.getZoomLevels
- Defined in lib/tiles/tileGenerator.ts:179

isLinkTables

isLinkTables(): boolean
Is the feature table going to be linked with the tile table? Defaults to true.

Returns
true if tables will be linked upon generation

Returns boolean
- Defined in lib/tiles/features/featureTileGenerator.ts:86

isSkipExisting

isSkipExisting(): boolean
Is skip existing tiles on

Returns
true if skipping existing tiles

Returns boolean
Inherited from TileGenerator.isSkipExisting
- Defined in lib/tiles/tileGenerator.ts:332

isXYZTiles

isXYZTiles(): boolean
Is the XYZ Tiles flag set to generate XYZ tile format tiles.

Returns
true if XYZ Tiles format, false if GeoPackage

Returns boolean
Inherited from TileGenerator.isXYZTiles
- Defined in lib/tiles/tileGenerator.ts:308

`Protected` preTileGeneration

preTileGeneration(): void
{@inheritDoc}

Returns void
Overrides TileGenerator.preTileGeneration
- Defined in lib/tiles/features/featureTileGenerator.ts:101

setCompressFormat

setCompressFormat(compressFormat: ImageType): void
Set the compress format
Parameters
- compressFormat: ImageType
  
  compression format
Returns void
Inherited from TileGenerator.setCompressFormat
- Defined in lib/tiles/tileGenerator.ts:247

setCompressQuality

setCompressQuality(compressQuality: number): void
Set the compress quality (0.0 to 1.0). The Compress format must be set for this to be used.
Parameters
- compressQuality: number
  
  compression quality
Returns void
Inherited from TileGenerator.setCompressQuality
- Defined in lib/tiles/tileGenerator.ts:264

setLinkTables

setLinkTables(linkTables: boolean): void
Set the link tables flag
Parameters
- linkTables: boolean
  
  link tables flag
Returns void
- Defined in lib/tiles/features/featureTileGenerator.ts:94

setProgress

setProgress(progress: GeoPackageZoomLevelProgress): void
Set the progress tracker
Parameters
- progress: GeoPackageZoomLevelProgress
  
  progress tracker
Returns void
Inherited from TileGenerator.setProgress
- Defined in lib/tiles/tileGenerator.ts:283

setScaling

setScaling(scaling: TileScaling): void
Set the tile scaling settings
Parameters
- scaling: TileScaling
  
  tile scaling
Returns void
Inherited from TileGenerator.setScaling
- Defined in lib/tiles/tileGenerator.ts:324

setSkipExisting

setSkipExisting(skipExisting: boolean): void
Set the skip existing tiles flag
Parameters
- skipExisting: boolean
  
  true to skip existing tiles
Returns void
Inherited from TileGenerator.setSkipExisting
- Defined in lib/tiles/tileGenerator.ts:340

setXYZTiles

setXYZTiles(xyzTiles: boolean): void
Set the XYZ Tiles flag to true to generate XYZ tile format tiles. Default is false
Parameters
- xyzTiles: boolean
  
  XYZ Tiles flag
Returns void
Inherited from TileGenerator.setXYZTiles
- Defined in lib/tiles/tileGenerator.ts:300

Class FeatureTileGenerator

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

geoPackage: GeoPackage

tableName: string

featureTiles: FeatureTiles

featureGeoPackage: GeoPackage

zoomLevels: number[]

projection: Projection

Returns FeatureTileGenerator

Properties

Protected boundingBox

Protected projection

Methods

addZoomLevel

Returns

Parameters

zoomLevel: any

Returns boolean

addZoomLevelRange

Returns

Parameters

minZoom: number

maxZoom: number

Returns boolean

addZoomLevels

Returns

Parameters

zoomLevels: number[]

Returns boolean

close

Returns void

Protected createTile

Parameters

z: number

x: number

y: number

Returns Promise<GeoPackageTile>

generateTiles

Returns

Returns Promise<number>

getBoundingBox

Returns

Returns BoundingBox

getBoundingBoxWithZoom

Returns

Parameters

zoom: number

Returns BoundingBox

getCompressFormat

Returns

Returns ImageType

getCompressQuality

Returns

Returns number

getGeoPackage

Returns

Returns GeoPackage

getMaxZoom

Returns

Returns number

getMinZoom

Returns

Returns number

getProgress

Returns

Returns GeoPackageZoomLevelProgress

getScaling

Returns

Returns TileScaling

getTableName

Returns

Returns string

getTileCount

`Protected` boundingBox

`Protected` projection

`Protected` createTile

`Protected` preTileGeneration