Class FeaturePreview

Feature Preview for drawing a preview tile from a feature table

Hierarchy

FeaturePreview

Index

Constructors

Methods

addColumn addColumns appendWhere draw getBufferPercentage getColumns getFeatureTiles getGeoPackage getLimit getWhere getWhereArgs isManual setBufferPercentage setLimit setManual setWhere setWhereArgs

Constructors

constructor

new FeaturePreview(geoPackage: GeoPackage, featureTable: string): FeaturePreview
Constructor
Parameters
- geoPackage: GeoPackage
  
  GeoPackage
- featureTable: string
  
  feature table
Returns FeaturePreview
- Defined in lib/tiles/features/featurePreview.ts:63
new FeaturePreview(geoPackage: GeoPackage, featureDao: FeatureDao): FeaturePreview
Constructor
Parameters
- geoPackage: GeoPackage
  
  GeoPackage
- featureDao: FeatureDao
  
  feature DAO
Returns FeaturePreview
- Defined in lib/tiles/features/featurePreview.ts:70
new FeaturePreview(geoPackage: GeoPackage, featureTiles: FeatureTiles): FeaturePreview
Constructor
Parameters
- geoPackage: GeoPackage
  
  GeoPackage
- featureTiles: FeatureTiles
  
  feature tiles
Returns FeaturePreview
- Defined in lib/tiles/features/featurePreview.ts:77

Methods

addColumn

addColumn(column: string): void
Add a query column
Parameters
- column: string
  
  column
Returns void
- Defined in lib/tiles/features/featurePreview.ts:173

addColumns

addColumns(columns: string[]): void
Add query columns
Parameters
- columns: string[]
  
  columns
Returns void
- Defined in lib/tiles/features/featurePreview.ts:165

appendWhere

appendWhere(where: string): void
Append to the where clause
Parameters
- where: string
  
  where
Returns void
- Defined in lib/tiles/features/featurePreview.ts:197

draw

draw(canvas?: HTMLCanvasElement | OffscreenCanvas | EmulatedCanvas2D): Promise<GeoPackageTile>
Draw a preview image

Returns
preview image
Parameters
- Optional canvas: HTMLCanvasElement | OffscreenCanvas | EmulatedCanvas2D
  
  optional canvas to draw into
Returns Promise<GeoPackageTile>
- Defined in lib/tiles/features/featurePreview.ts:242

getBufferPercentage

getBufferPercentage(): number
Get the buffer percentage for drawing empty non features edges (i.e. 0.1 equals 10% buffer edges)

Returns
buffer percentage (greater than or equal to 0.0 and less than 0.5)

Returns number
- Defined in lib/tiles/features/featurePreview.ts:135

getColumns

getColumns(): string[]
Get the query columns

Returns
columns

Returns string[]
- Defined in lib/tiles/features/featurePreview.ts:157

getFeatureTiles

getFeatureTiles(): FeatureTiles
Get the feature tiles

Returns
feature tiles

Returns FeatureTiles
- Defined in lib/tiles/features/featurePreview.ts:108

getGeoPackage

getGeoPackage(): GeoPackage
Get the GeoPackage

Returns
GeoPackage

Returns GeoPackage
- Defined in lib/tiles/features/featurePreview.ts:100

getLimit

getLimit(): number
Get the feature query limit

Returns
limit

Returns number
- Defined in lib/tiles/features/featurePreview.ts:223

getWhere

getWhere(): string
Get the where clause

Returns
where

Returns string
- Defined in lib/tiles/features/featurePreview.ts:181

getWhereArgs

getWhereArgs(): any[]
Get the where arguments

Returns
where args

Returns any[]
- Defined in lib/tiles/features/featurePreview.ts:206

isManual

isManual(): boolean
Is manual bounding box query enabled for non indexed and empty contents bounds feature tables

Returns
manual flag

Returns boolean
- Defined in lib/tiles/features/featurePreview.ts:117

setBufferPercentage

setBufferPercentage(bufferPercentage: number): void
Set the buffer percentage for drawing empty non features edges (i.e. 0.1 equals 10% buffer edges)
Parameters
- bufferPercentage: number
  
  buffer percentage (greater than or equal to 0.0 and less than 0.5)
Returns void
- Defined in lib/tiles/features/featurePreview.ts:144

setLimit

setLimit(limit: number): void
Set the feature query limit
Parameters
- limit: number
  
  limit
Returns void
- Defined in lib/tiles/features/featurePreview.ts:233

setManual

setManual(manual: boolean): void
Set the manual bounding box query flag for non indexed and empty contents bounds feature tables
Parameters
- manual: boolean
  
  manual flag
Returns void
- Defined in lib/tiles/features/featurePreview.ts:126

setWhere

setWhere(where: string): void
Set the where clause
Parameters
- where: string
  
  where
Returns void
- Defined in lib/tiles/features/featurePreview.ts:189

setWhereArgs

setWhereArgs(whereArgs: any[]): void
Set the where arguments
Parameters
- whereArgs: any[]
  
  where arguments
Returns void
- Defined in lib/tiles/features/featurePreview.ts:214

Class FeaturePreview

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

geoPackage: GeoPackage

featureTable: string

Returns FeaturePreview

Parameters

geoPackage: GeoPackage

featureDao: FeatureDao

Returns FeaturePreview

Parameters

geoPackage: GeoPackage

featureTiles: FeatureTiles

Returns FeaturePreview

Methods

addColumn

Parameters

column: string

Returns void

addColumns

Parameters

columns: string[]

Returns void

appendWhere

Parameters

where: string

Returns void

draw

Returns

Parameters

Optional canvas: HTMLCanvasElement | OffscreenCanvas | EmulatedCanvas2D

Returns Promise<GeoPackageTile>

getBufferPercentage

Returns

Returns number

getColumns

Returns

Returns string[]

getFeatureTiles

Returns

Returns FeatureTiles

getGeoPackage

Returns

Returns GeoPackage

getLimit

Returns

Returns number

getWhere

Returns

Returns string

getWhereArgs

Returns

Returns any[]

isManual

Returns

Returns boolean

setBufferPercentage

Parameters

bufferPercentage: number

Returns void

setLimit

Parameters

limit: number

Returns void

setManual

Parameters

manual: boolean

Returns void

setWhere

Parameters

where: string

Returns void

setWhereArgs

Parameters

whereArgs: any[]

`Optional` canvas: HTMLCanvasElement | OffscreenCanvas | EmulatedCanvas2D