Class UrlTileGenerator

Creates a set of tiles within a GeoPackage by downloading the tiles from a URL

Hierarchy

TileGenerator
- UrlTileGenerator

Constructors

constructor

new UrlTileGenerator(geoPackage: GeoPackage, tableName: string, tileUrl: string, zoomLevels: number[], boundingBox: BoundingBox, projection: Projection): UrlTileGenerator
Constructor
Parameters
- geoPackage: GeoPackage
  
  GeoPackage
- tableName: string
  
  table name
- tileUrl: string
  
  tile URL
- zoomLevels: number[]
  
  zoom levels
- boundingBox: BoundingBox
  
  tiles bounding box
- projection: Projection
  
  tiles projection
Returns UrlTileGenerator
Overrides TileGenerator.constructor
- Defined in lib/tiles/urlTileGenerator.ts:97

Properties

`Protected` boundingBox

boundingBox: BoundingBox

Tile bounding box

`Protected` projection

projection: Projection

Tiles projection

Methods

addHTTPHeaderValue

addHTTPHeaderValue(field: string, value: string): void
Add a HTTP Header field value, appending to any existing values for the field
Parameters
- field: string
  
  field name
- value: string
  
  field value
Returns void
- Defined in lib/tiles/urlTileGenerator.ts:209

addHTTPHeaderValues

addHTTPHeaderValues(field: string, values: string[]): void
Add HTTP Header field values, appending to any existing values for the field
Parameters
- field: string
  
  field name
- values: string[]
  
  field values
Returns void
- Defined in lib/tiles/urlTileGenerator.ts:227

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/urlTileGenerator.ts:316

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

getDownloadAttempts

getDownloadAttempts(): number
Get the number of download attempts per tile

Returns
download attempts

Returns number
- Defined in lib/tiles/urlTileGenerator.ts:154

getGeoPackage

getGeoPackage(): GeoPackage
Get the GeoPackage

Returns
GeoPackage

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

getHttpHeader

getHttpHeader(): Map<string, string[]>
Get the HTTP Header fields and field values

Returns
header map

Returns Map<string, string[]>
- Defined in lib/tiles/urlTileGenerator.ts:186

getHttpHeaderValues

getHttpHeaderValues(field: string): string[]
Get the HTTP Header field values

Returns
field values
Parameters
- field: string
  
  field name
Returns string[]
- Defined in lib/tiles/urlTileGenerator.ts:195

getHttpMethod

getHttpMethod(): string
Get the HTTP request method, when null default is "GET"

Returns
method

Returns string
- Defined in lib/tiles/urlTileGenerator.ts:170

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

getTileFormat

getTileFormat(): TileFormatType
Get the tile format

Returns
tile format

Returns TileFormatType
- Defined in lib/tiles/urlTileGenerator.ts:127

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

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/urlTileGenerator.ts:311

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

setDownloadAttempts

setDownloadAttempts(downloadAttempts: number): void
Set the number of download attempts per tile
Parameters
- downloadAttempts: number
  
  download attempts per tile
Returns void
- Defined in lib/tiles/urlTileGenerator.ts:162

setHttpMethod

setHttpMethod(httpMethod: string): void
Set the HTTP request method
Parameters
- httpMethod: string
  
  method ("GET", "POST")
Returns void
- Defined in lib/tiles/urlTileGenerator.ts:178

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

setTileFormat

setTileFormat(tileFormat: TileFormatType): void
Set the tile format
Parameters
- tileFormat: TileFormatType
  
  tile format
Returns void
- Defined in lib/tiles/urlTileGenerator.ts:135

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 UrlTileGenerator

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

geoPackage: GeoPackage

tableName: string

tileUrl: string

zoomLevels: number[]

boundingBox: BoundingBox

projection: Projection

Returns UrlTileGenerator

Properties

Protected boundingBox

Protected projection

Methods

addHTTPHeaderValue

Parameters

field: string

value: string

Returns void

addHTTPHeaderValues

Parameters

field: string

values: string[]

Returns void

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

getDownloadAttempts

Returns

Returns number

getGeoPackage

Returns

Returns GeoPackage

getHttpHeader

Returns

Returns Map<string, string[]>

`Protected` boundingBox

`Protected` projection

`Protected` createTile

`Protected` preTileGeneration