Class FeatureIndexManager

Feature Index Manager to manage indexing of feature geometries within a GeoPackage using the Geometry Index Extension and the RTree extension

Hierarchy

FeatureIndexManager

Index

Constructors

constructor

Methods

Constructors

constructor

new FeatureIndexManager(geoPackage: GeoPackage, featureTableNameOrDao: string | FeatureDao): FeatureIndexManager
Constructor
Parameters
- geoPackage: GeoPackage
  
  GeoPackage
- featureTableNameOrDao: string | FeatureDao
  
  feature DAO
Returns FeatureIndexManager
- Defined in lib/features/index/featureIndexManager.ts:75

Methods

close

close(): void
Close the index connections

Returns void
- Defined in lib/features/index/featureIndexManager.ts:95

count

count(where: string, whereArgs: any[]): number
Query for feature index count

Returns
count
Parameters
- where: string
  
  where clause
- whereArgs: any[]
  
  where arguments
Returns number
- Defined in lib/features/index/featureIndexManager.ts:898

countAll

countAll(): number
Query for all feature index count

Returns
count

Returns number
- Defined in lib/features/index/featureIndexManager.ts:654

countAllWithColumn

countAllWithColumn(column: string): number
Query for all feature index count

Returns
count
Parameters
- column: string
  
  count column name
Returns number
- Defined in lib/features/index/featureIndexManager.ts:672

countAllWithDistinct

countAllWithDistinct(distinct: boolean): number
Query for all feature index count

Returns
count
Parameters
- distinct: boolean
  
  distinct column values
Returns number
- Defined in lib/features/index/featureIndexManager.ts:663

countAllWithDistinctAndColumn

countAllWithDistinctAndColumn(distinct: boolean, column: string): number
Query for all feature index count

Returns
count
Parameters
- distinct: boolean
  
  distinct column values
- column: string
  
  count column name
Returns number
- Defined in lib/features/index/featureIndexManager.ts:682

countColumn

countColumn(column: string): number
Query for all feature index count

Returns
count
Parameters
- column: string
  
  count column name
Returns number
- Defined in lib/features/index/featureIndexManager.ts:646

countWithBoundingBox

countWithBoundingBox(boundingBox: BoundingBox, where?: string, whereArgs?: any[]): number
Query for feature index count within the bounding box, projected correctly

Returns
count
Parameters
- boundingBox: BoundingBox
  
  bounding box
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1251

countWithBoundingBoxAndColumn

countWithBoundingBoxAndColumn(boundingBox: BoundingBox, column: string, where?: string, whereArgs?: any[]): number
Query for feature index count within the bounding box, projected correctly

Returns
count
Parameters
- boundingBox: BoundingBox
  
  bounding box
- column: string
  
  count column value
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1282

countWithBoundingBoxAndDistinct

countWithBoundingBoxAndDistinct(boundingBox: BoundingBox, distinct: boolean, where?: string, whereArgs?: any[]): number
Query for feature index count within the bounding box, projected correctly

Returns
count
Parameters
- boundingBox: BoundingBox
  
  bounding box
- distinct: boolean
  
  distinct column values
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1264

countWithBoundingBoxAndDistinctAndColumn

countWithBoundingBoxAndDistinctAndColumn(boundingBox: BoundingBox, distinct: boolean, column: string, where?: string, whereArgs?: any[]): number
Query for feature index count within the bounding box, projected correctly

Returns
count
Parameters
- boundingBox: BoundingBox
  
  bounding box
- distinct: boolean
  
  distinct column values
- column: string
  
  count column value
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1307

countWithBoundingBoxAndFieldValues

countWithBoundingBoxAndFieldValues(boundingBox: BoundingBox, fieldValues: FieldValues): number
Query for feature index count within the bounding box, projected correctly

Returns
count
Parameters
- boundingBox: BoundingBox
  
  bounding box
- fieldValues: FieldValues
  
  field values
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1110

countWithBoundingBoxAndFieldValuesAndColumn

countWithBoundingBoxAndFieldValuesAndColumn(boundingBox: BoundingBox, fieldValues: FieldValues, column: string): number
Query for feature index count within the bounding box, projected correctly

Returns
count
Parameters
- boundingBox: BoundingBox
  
  bounding box
- fieldValues: FieldValues
  
  field values
- column: string
  
  column name
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1138

countWithBoundingBoxAndFieldValuesAndDistinct

countWithBoundingBoxAndFieldValuesAndDistinct(boundingBox: BoundingBox, fieldValues: FieldValues, distinct: boolean): number
Query for feature index count within the bounding box, projected correctly

Returns
count
Parameters
- boundingBox: BoundingBox
  
  bounding box
- fieldValues: FieldValues
  
  field values
- distinct: boolean
  
  distinct column values
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1122

countWithBoundingBoxAndFieldValuesAndDistinctAndColumn

countWithBoundingBoxAndFieldValuesAndDistinctAndColumn(boundingBox: BoundingBox, fieldValues: FieldValues, distinct: boolean, column: string): number
Query for feature index count within the bounding box, projected correctly

Returns
count
Parameters
- boundingBox: BoundingBox
  
  bounding box
- fieldValues: FieldValues
  
  field values
- distinct: boolean
  
  distinct column values
- column: string
  
  column name
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1155

countWithBoundingBoxAndProjection

countWithBoundingBoxAndProjection(boundingBox: BoundingBox, projection: Projection, where?: string, whereArgs?: any[]): number
Query for feature index count intersecting the bounding box in the provided projection

Returns
count
Parameters
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1985

countWithBoundingBoxAndProjectionAndColumn

countWithBoundingBoxAndProjectionAndColumn(boundingBox: BoundingBox, projection: Projection, column: string, where?: string, whereArgs?: any[]): number
Query for feature index count within the bounding box in the provided projection

Returns
count
Parameters
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- column: string
  
  count column name
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns number
- Defined in lib/features/index/featureIndexManager.ts:2038

countWithBoundingBoxAndProjectionAndDistinct

countWithBoundingBoxAndProjectionAndDistinct(boundingBox: BoundingBox, projection: Projection, distinct: boolean, where?: string, whereArgs?: any[]): number
Query for feature index count within the bounding box in the provided projection

Returns
count
Parameters
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- distinct: boolean
  
  distinct column values
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns number
- Defined in lib/features/index/featureIndexManager.ts:2011

countWithBoundingBoxAndProjectionAndDistinctAndColumn

countWithBoundingBoxAndProjectionAndDistinctAndColumn(boundingBox: BoundingBox, projection: Projection, distinct: boolean, column: string, where?: string, whereArgs?: any[]): number
Query for feature index count within the bounding box in the provided projection

Returns
count
Parameters
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- distinct: boolean
  
  distinct column values
- column: string
  
  count column name
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns number
- Defined in lib/features/index/featureIndexManager.ts:2066

countWithBoundingBoxAndProjectionAndFieldValues

countWithBoundingBoxAndProjectionAndFieldValues(boundingBox: BoundingBox, projection: Projection, fieldValues: FieldValues): number
Query for feature index count within the bounding box in the provided projection

Returns
count
Parameters
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- fieldValues: FieldValues
  
  field values
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1782

countWithBoundingBoxAndProjectionAndFieldValuesAndColumn

countWithBoundingBoxAndProjectionAndFieldValuesAndColumn(distinct: boolean, column: string, boundingBox: BoundingBox, projection: Projection, fieldValues: FieldValues): number
Query for feature index count within the bounding box in the provided projection

Returns
count
Parameters
- distinct: boolean
  
  distinct column values
- column: string
  
  count column value
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- fieldValues: FieldValues
  
  field values
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1830

countWithBoundingBoxAndProjectionAndFieldValuesAndDistinct

countWithBoundingBoxAndProjectionAndFieldValuesAndDistinct(distinct: boolean, boundingBox: BoundingBox, projection: Projection, fieldValues: FieldValues): number
Query for feature index count within the bounding box in the provided projection

Returns
count
Parameters
- distinct: boolean
  
  distinct column values
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- fieldValues: FieldValues
  
  field values
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1805

countWithBoundingBoxAndProjectionAndFieldValuesAndDistinctAndColumn

countWithBoundingBoxAndProjectionAndFieldValuesAndDistinctAndColumn(boundingBox: BoundingBox, projection: Projection, fieldValues: FieldValues, distinct: boolean, column: string): number
Query for feature index count within the bounding box in the provided projection

Returns
count
Parameters
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- fieldValues: FieldValues
  
  field values
- distinct: boolean
  
  distinct column values
- column: string
  
  count column value
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1856

countWithColumns

countWithColumns(column: string, where: string, whereArgs: any[]): number
Query for feature index count

Returns
count
Parameters
- column: string
  
  count column name
- where: string
  
  where clause
- whereArgs: any[]
  
  where arguments
Returns number
- Defined in lib/features/index/featureIndexManager.ts:922

countWithDistinct

countWithDistinct(distinct: boolean, where: string, whereArgs: any[]): number
Query for feature index count

Returns
count
Parameters
- distinct: boolean
  
  distinct column values
- where: string
  
  where clause
- whereArgs: any[]
  
  where arguments
Returns number
- Defined in lib/features/index/featureIndexManager.ts:910

countWithDistinctAndColumns

countWithDistinctAndColumns(distinct: boolean, column: string, where: string, whereArgs: any[]): number
Query for feature index count

Returns
count
Parameters
- distinct: boolean
  
  distinct column values
- column: string
  
  count column name
- where: string
  
  where clause
- whereArgs: any[]
  
  where arguments
Returns number
- Defined in lib/features/index/featureIndexManager.ts:935

countWithFieldValues

countWithFieldValues(fieldValues: FieldValues): number
Query for feature index count

Returns
feature index results, close when done
Parameters
- fieldValues: FieldValues
  
  field values
Returns number
- Defined in lib/features/index/featureIndexManager.ts:762

countWithFieldValuesAndColumn

countWithFieldValuesAndColumn(fieldValues: FieldValues, column: string): number
Query for feature index count

Returns
feature index results, close when done
Parameters
- fieldValues: FieldValues
  
  field values
- column: string
  
  count column name
Returns number
- Defined in lib/features/index/featureIndexManager.ts:783

countWithFieldValuesAndDistinct

countWithFieldValuesAndDistinct(fieldValues: FieldValues, distinct: boolean, column: string): number
Query for feature index count

Returns
feature index results, close when done
Parameters
- fieldValues: FieldValues
  
  field values
- distinct: boolean
  
  distinct column values
- column: string
  
  count column name
Returns number
- Defined in lib/features/index/featureIndexManager.ts:773

countWithFieldValuesAndDistinctAndColumns

countWithFieldValuesAndDistinctAndColumns(fieldValues: FieldValues, distinct: boolean, column: string): number
Query for feature index count

Returns
feature index results, close when done
Parameters
- fieldValues: FieldValues
  
  field values
- distinct: boolean
  
  distinct column values
- column: string
  
  count column name
Returns number
- Defined in lib/features/index/featureIndexManager.ts:794

countWithGeometryEnvelope

countWithGeometryEnvelope(envelope: GeometryEnvelope, where?: string, whereArgs?: any[]): number
Query for feature index count within the Geometry Envelope

Returns
count
Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1576

countWithGeometryEnvelopeAndColumn

countWithGeometryEnvelopeAndColumn(envelope: GeometryEnvelope, column: string, where?: string, whereArgs?: any[]): number
Query for feature index count within the Geometry Envelope

Returns
count
Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
- column: string
  
  count column name
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1605

countWithGeometryEnvelopeAndDistinct

countWithGeometryEnvelopeAndDistinct(envelope: GeometryEnvelope, distinct: boolean, where?: string, whereArgs?: any[]): number
Query for feature index count within the Geometry Envelope

Returns
count
Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
- distinct: boolean
  
  distinct column values
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1588

countWithGeometryEnvelopeAndDistinctAndColumn

countWithGeometryEnvelopeAndDistinctAndColumn(envelope: GeometryEnvelope, distinct: boolean, column: string, where?: string, whereArgs?: any[]): number
Query for feature index count within the Geometry Envelope

Returns
count
Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
- distinct: boolean
  
  distinct column values
- column: string
  
  count column name
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1623

countWithGeometryEnvelopeAndFieldValues

countWithGeometryEnvelopeAndFieldValues(envelope: GeometryEnvelope, fieldValues: FieldValues): number
Query for feature index count within the Geometry Envelope

Returns
count
Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
- fieldValues: FieldValues
  
  field values
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1401

countWithGeometryEnvelopeAndFieldValuesAndColumn

countWithGeometryEnvelopeAndFieldValuesAndColumn(column: string, envelope: GeometryEnvelope, fieldValues: FieldValues): number
Query for feature index count within the Geometry Envelope

Returns
count
Parameters
- column: string
  
  count column name
- envelope: GeometryEnvelope
  
  geometry envelope
- fieldValues: FieldValues
  
  field values
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1432

countWithGeometryEnvelopeAndFieldValuesAndDistinct

countWithGeometryEnvelopeAndFieldValuesAndDistinct(envelope: GeometryEnvelope, fieldValues: FieldValues, distinct: boolean): number
Query for feature index count within the Geometry Envelope

Returns
count
Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
- fieldValues: FieldValues
  
  field values
- distinct: boolean
  
  distinct column values
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1417

countWithGeometryEnvelopeAndFieldValuesAndDistinctAndColumn

countWithGeometryEnvelopeAndFieldValuesAndDistinctAndColumn(envelope: GeometryEnvelope, fieldValues: FieldValues, distinct: boolean, column: string): number
Query for feature index count within the Geometry Envelope

Returns
count
Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
- fieldValues: FieldValues
  
  field values
- distinct: boolean
  
  distinct column values
- column: string
  
  count column name
Returns number
- Defined in lib/features/index/featureIndexManager.ts:1448

deleteIndexForGeometryId

deleteIndexForGeometryId(geomId: number, type?: FeatureIndexType): boolean
Delete the feature index for the geometry id

Returns
true if deleted
Parameters
- geomId: number
  
  geometry id
- type: FeatureIndexType = ...
  
  feature index type
Returns boolean
- Defined in lib/features/index/featureIndexManager.ts:407

deleteIndexForGeometryIdWithTypes

deleteIndexForGeometryIdWithTypes(geomId: number, types: FeatureIndexType[]): boolean
Delete the feature index for the geometry id from the index types

Returns
true if deleted from any type
Parameters
- geomId: number
  
  geometry id
- types: FeatureIndexType[]
  
  feature index types
Returns boolean
- Defined in lib/features/index/featureIndexManager.ts:391

deleteIndexForRow

deleteIndexForRow(row: FeatureRow, type?: FeatureIndexType): boolean
Delete the feature index for the feature row

Returns
true if deleted
Parameters
- row: FeatureRow
  
  feature row
- type: FeatureIndexType = ...
  
  feature index type
Returns boolean
- Defined in lib/features/index/featureIndexManager.ts:381

deleteIndexForRowWithTypes

deleteIndexForRowWithTypes(row: FeatureRow, types: FeatureIndexType[]): boolean
Delete the feature index for the feature row from the index types

Returns
true if deleted from any type
Parameters
- row: FeatureRow
  
  feature row
- types: FeatureIndexType[]
  
  feature index types
Returns boolean
- Defined in lib/features/index/featureIndexManager.ts:365

deleteIndexType

deleteIndexType(type?: FeatureIndexType): boolean
Delete the feature index

Returns
true if deleted
Parameters
- type: FeatureIndexType = ...
  
  feature index type
Returns boolean
- Defined in lib/features/index/featureIndexManager.ts:340

deleteIndexTypes

deleteIndexTypes(types?: FeatureIndexType[]): boolean
Delete the feature index from the index types

Returns
true if deleted from any type
Parameters
- types: FeatureIndexType[] = ...
  
  feature index types
Returns boolean
- Defined in lib/features/index/featureIndexManager.ts:325

getBoundingBox

getBoundingBox(): BoundingBox
Query for the feature index bounds

Returns
bounding box

Returns BoundingBox
- Defined in lib/features/index/featureIndexManager.ts:969

getBoundingBoxWithProjection

getBoundingBoxWithProjection(projection: Projection): BoundingBox
Query for the feature index bounds and return in the provided projection

Returns
bounding box
Parameters
- projection: Projection
  
  desired projection
Returns BoundingBox
- Defined in lib/features/index/featureIndexManager.ts:1006

getFeatureDao

getFeatureDao(): FeatureDao
Get the feature DAO

Returns
feature DAO

Returns FeatureDao
- Defined in lib/features/index/featureIndexManager.ts:103

getFeatureTableIndex

getFeatureTableIndex(): FeatureTableIndex
Get the feature table index, used to index inside the GeoPackage as an extension

Returns
feature table index

Returns FeatureTableIndex
- Defined in lib/features/index/featureIndexManager.ts:112

getIdColumn

getIdColumn(): string
Get the feature table id column name, the default column ordering

Returns
feature table id column name

Returns string
- Defined in lib/features/index/featureIndexManager.ts:573

getIndexLocation

getIndexLocation(): FeatureIndexType
Get the index location

Returns
index location or null if not set

Returns FeatureIndexType
- Defined in lib/features/index/featureIndexManager.ts:136

getIndexLocationQueryOrder

getIndexLocationQueryOrder(): FeatureIndexType[]
Get the ordered set of ordered index query locations

Returns
set of ordered index types

Returns FeatureIndexType[]
- Defined in lib/features/index/featureIndexManager.ts:128

getIndexedType

getIndexedType(): FeatureIndexType
Get the first ordered indexed type

Returns
feature index type

Returns FeatureIndexType
- Defined in lib/features/index/featureIndexManager.ts:554

getIndexedTypes

getIndexedTypes(): FeatureIndexType[]
Get the indexed types that are currently indexed

Returns
indexed types

Returns FeatureIndexType[]
- Defined in lib/features/index/featureIndexManager.ts:490

getLastIndexed

getLastIndexed(): Date
Get the date last indexed

Returns
last indexed date or null

Returns Date
- Defined in lib/features/index/featureIndexManager.ts:504

getLastIndexedForType

getLastIndexedForType(type: FeatureIndexType): Date
Get the date last indexed

Returns
last indexed date or null
Parameters
- type: FeatureIndexType
  
  feature index type
Returns Date
- Defined in lib/features/index/featureIndexManager.ts:520

getLocation

getLocation(): FeatureIndexLocation
Get a feature index location to iterate over indexed types

Returns
feature index location

Returns FeatureIndexLocation
- Defined in lib/features/index/featureIndexManager.ts:546

getRTreeIndexTableDao

getRTreeIndexTableDao(): RTreeIndexTableDao
Get the RTree Index Table DAO

Returns
RTree index table DAO

Returns RTreeIndexTableDao
- Defined in lib/features/index/featureIndexManager.ts:120

index

index(): number
Index the feature table if needed, using the set index location

Returns
count

Returns number
- Defined in lib/features/index/featureIndexManager.ts:215

indexRow

indexRow(row: FeatureRow): boolean
Index the feature row, using the set index location. This method assumes that indexing has been completed and maintained as the last indexed time is updated.

Returns
true if indexed
Parameters
- row: FeatureRow
  
  feature row to index
Returns boolean
- Defined in lib/features/index/featureIndexManager.ts:272

indexRowWithType

indexRowWithType(row: FeatureRow, type?: FeatureIndexType): boolean
Index the feature row. This method assumes that indexing has been completed and maintained as the last indexed time is updated.

Returns
true if indexed
Parameters
- row: FeatureRow
  
  feature row to index
- type: FeatureIndexType = ...
  
  index location type
Returns boolean
- Defined in lib/features/index/featureIndexManager.ts:283

indexRowWithTypes

indexRowWithTypes(row: FeatureRow, types: FeatureIndexType[]): boolean
Index the feature row for the index types. This method assumes that indexing has been completed and maintained as the last indexed time is updated.

Returns
true if indexed from any type
Parameters
- row: FeatureRow
  
  feature row to index
- types: FeatureIndexType[]
  
  feature index types
Returns boolean
- Defined in lib/features/index/featureIndexManager.ts:310

indexType

indexType(type?: FeatureIndexType, force?: boolean): number
Index the feature table

Returns
count
Parameters
- type: FeatureIndexType = ...
  
  index location type
- force: boolean = false
  
  true to force re-indexing
Returns number
- Defined in lib/features/index/featureIndexManager.ts:225

indexTypes

indexTypes(types: FeatureIndexType[], force?: boolean): number
Index the feature tables if needed for the index types

Returns
largest count of indexed features
Parameters
- types: FeatureIndexType[]
  
  feature index types
- force: boolean = false
  
  true to force re-indexing
Returns number
- Defined in lib/features/index/featureIndexManager.ts:256

isContinueOnError

isContinueOnError(): boolean
Is the continue on error flag enabled

Returns
continue on error

Returns boolean
- Defined in lib/features/index/featureIndexManager.ts:145

isIndexed

isIndexed(): boolean
Determine if the feature table is indexed

Returns
true if indexed

Returns boolean
- Defined in lib/features/index/featureIndexManager.ts:451

isIndexedForType

isIndexedForType(type: FeatureIndexType): boolean
Is the feature table indexed in the provided type location

Returns
true if indexed
Parameters
- type: FeatureIndexType
  
  index location type
Returns boolean
- Defined in lib/features/index/featureIndexManager.ts:467

paginate

paginate(results: FeatureIndexResults): FeaturePaginatedResults
Paginate the results

Returns
feature paginated results
Parameters
- results: FeatureIndexResults
  
  feature index results
Returns FeaturePaginatedResults
- Defined in lib/features/index/featureIndexManager.ts:2108

prioritizeQueryLocation

prioritizeQueryLocation(types: FeatureIndexType[]): void
Prioritize the query location order. All types are placed at the front of the query order in the order they are given. Omitting a location leaves it at it's current priority location.
Parameters
- types: FeatureIndexType[]
  
  feature index types
Returns void
- Defined in lib/features/index/featureIndexManager.ts:164

query

query(where?: string, whereArgs?: any[]): FeatureIndexResults
Query for feature index results

Returns
feature index results, close when done
Parameters
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:810

queryAll

queryAll(): FeatureIndexResults
Query for all feature index results

Returns
feature index results, close when done

Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:581

queryAllWithColumns

queryAllWithColumns(columns?: string[]): FeatureIndexResults
Query for all feature index results

Returns
feature index results, close when done
Parameters
- Optional columns: string[]
  
  columns
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:599

queryAllWithDistinct

queryAllWithDistinct(distinct?: boolean): FeatureIndexResults
Query for all feature index results

Returns
feature index results, close when done
Parameters
- Optional distinct: boolean
  
  distinct rows
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:590

queryAllWithDistinctAndColumns

queryAllWithDistinctAndColumns(distinct?: boolean, columns?: string[]): FeatureIndexResults
Query for all feature index results

Returns
feature index results, close when done
Parameters
- Optional distinct: boolean
  
  distinct rows
- Optional columns: string[]
  
  columns
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:609

queryForAllChunk

queryForAllChunk(limit: number, offset: number): FeatureIndexResults
Query for all feature index results ordered by id, starting at the offset and returning no more than the limit

Returns
feature index results, close when done
Parameters
- limit: number
  
  chunk limit
- offset: number
  
  chunk query offset
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:2135

queryForChunk

queryForChunk(distinct: boolean, columns: string[], where: string, whereArgs: any[], orderBy: string, limit: number, offset: number): FeatureIndexResults
Query for feature index results, starting at the offset and returning no more than the limit

Returns
feature index results, close when done
Parameters
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
- where: string
  
  where clause
- whereArgs: any[]
  
  where arguments
- orderBy: string
  
  order by
- limit: number
  
  chunk limit
- offset: number
  
  chunk query offset
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:2198

queryForChunkIdOrder

queryForChunkIdOrder(distinct: boolean, columns: string[], where: string, limit: number, offset: number): FeatureIndexResults
Query for feature index results ordered by id, starting at the offset and returning no more than the limit

Returns
feature index results, close when done
Parameters
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
- where: string
  
  where clause
- limit: number
  
  chunk limit
- offset: number
  
  chunk query offset
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:2175

queryForChunkIdOrderWithBoundingBox

queryForChunkIdOrderWithBoundingBox(distinct: boolean, columns: string[], boundingBox: BoundingBox, where: string, limit: number, offset: number): FeatureIndexResults
Query for feature index results ordered by id within the bounding box, correctly: projected, starting at the offset and returning no more than the limit

Returns
feature index results, close when done
Parameters
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
- boundingBox: BoundingBox
  
  bounding box
- where: string
  
  where clause
- limit: number
  
  chunk limit
- offset: number
  
  chunk query offset
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:2305

queryForChunkIdOrderWithBoundingBoxAndProjection

queryForChunkIdOrderWithBoundingBoxAndProjection(distinct: boolean, columns: string[], boundingBox: BoundingBox, projection: Projection, where: string, limit: number, offset: number): FeatureIndexResults
Query for feature index results ordered by id within the bounding box in the provided projection, starting at the offset and returning no more than the limit

Returns
feature index results, close when done
Parameters
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- where: string
  
  where clause
- limit: number
  
  chunk limit
- offset: number
  
  chunk query offset
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:2548

queryForChunkIdOrderWithEnvelope

queryForChunkIdOrderWithEnvelope(distinct: boolean, columns: string[], envelope: GeometryEnvelope, where: string, limit: number, offset: number): FeatureIndexResults
Query for feature index results ordered by id within the Geometry Envelope, starting at the offset and returning no more than the limit

Returns
feature index results, close when done
Parameters
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
- envelope: GeometryEnvelope
  
  geometry envelope
- where: string
  
  where clause
- limit: number
  
  chunk limit
- offset: number
  
  chunk query offset
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:2397

queryForChunkWithBoundingBox

queryForChunkWithBoundingBox(distinct: boolean, columns: string[], boundingBox: BoundingBox, where?: string, whereArgs?: string[], orderBy?: string, limit?: number, offset?: number): FeatureIndexResults
Query for feature index results within the bounding box, projected correctly, starting at the offset and returning no more than the limit

Returns
feature index results, close when done
Parameters
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
- boundingBox: BoundingBox
  
  bounding box
- Optional where: string
  
  where clause
- Optional whereArgs: string[]
  
  where arguments
- Optional orderBy: string
  
  order by
- Optional limit: number
  
  chunk limit
- Optional offset: number
  
  chunk query offset
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:2338

queryForChunkWithBoundingBoxAndFieldValues

queryForChunkWithBoundingBoxAndFieldValues(distinct: boolean, columns: string[], boundingBox: BoundingBox, fieldValues: FieldValues, orderBy: string, limit: number, offset: number): FeatureIndexResults
Query for feature index results within the bounding box, projected correctly, starting at the offset and returning no more than the limit

Returns
feature index results, close when done
Parameters
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
- boundingBox: BoundingBox
  
  bounding box
- fieldValues: FieldValues
  
  field values
- orderBy: string
  
  order by
- limit: number
  
  chunk limit
- offset: number
  
  chunk query offset
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:2274

queryForChunkWithBoundingBoxAndProjection

queryForChunkWithBoundingBoxAndProjection(distinct: boolean, columns: string[], boundingBox: BoundingBox, projection: Projection, where: string, whereArgs: any[], orderBy: string, limit: number, offset: number): FeatureIndexResults
Query for feature index results within the bounding box in the provided projection, starting at the offset and returning no more than the limit

Returns
feature index results, close when done
Parameters
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- where: string
  
  where clause
- whereArgs: any[]
  
  where arguments
- orderBy: string
  
  order by
- limit: number
  
  chunk limit
- offset: number
  
  chunk query offset
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:2584

queryForChunkWithBoundingBoxAndProjectionAndFieldValues

queryForChunkWithBoundingBoxAndProjectionAndFieldValues(distinct: boolean, columns: string[], boundingBox: BoundingBox, projection: Projection, fieldValues: FieldValues, orderBy: string, limit: number, offset: number): FeatureIndexResults
Query for feature index results within the bounding box in the provided projection, starting at the offset and returning no more than the limit

Returns
feature index results, close when done
Parameters
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- fieldValues: FieldValues
  
  field values
- orderBy: string
  
  order by
- limit: number
  
  chunk limit
- offset: number
  
  chunk query offset
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:2513

queryForChunkWithEnvelope

queryForChunkWithEnvelope(distinct: boolean, columns: string[], envelope: GeometryEnvelope, where: string, whereArgs: any[], orderBy: string, limit: number, offset: number): FeatureIndexResults
Query for feature index results within the Geometry Envelope, starting at the offset and returning no more than the limit

Returns
feature index results, close when done
Parameters
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
- envelope: GeometryEnvelope
  
  geometry envelope
- where: string
  
  where clause
- whereArgs: any[]
  
  where arguments
- orderBy: string
  
  order by
- limit: number
  
  chunk limit
- offset: number
  
  chunk query offset
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:2431

queryForChunkWithEnvelopeAndFieldValues

queryForChunkWithEnvelopeAndFieldValues(distinct: boolean, columns: string[], envelope: GeometryEnvelope, fieldValues: FieldValues, orderBy: string, limit: number, offset: number): FeatureIndexResults
Query for feature index results within the Geometry Envelope, starting at the offset and returning no more than the limit

Returns
feature index results, close when done
Parameters
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
- envelope: GeometryEnvelope
  
  geometry envelope
- fieldValues: FieldValues
  
  field values
- orderBy: string
  
  order by
- limit: number
  
  chunk limit
- offset: number
  
  chunk query offset
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:2372

queryForChunkWithFieldValues

queryForChunkWithFieldValues(distinct: boolean, columns: string[], fieldValues: FieldValues, orderBy: string, limit: number, offset: number): FeatureIndexResults
Query for feature index results, starting at the offset and returning no more than the limit

Returns
feature index results, close when done
Parameters
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
- fieldValues: FieldValues
  
  field values
- orderBy: string
  
  order by
- limit: number
  
  chunk limit
- offset: number
  
  chunk query offset
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:2151

queryForGeoJSONFeatures

queryForGeoJSONFeatures(boundingBox?: BoundingBox, where?: string, whereArgs?: any[]): GeoJSONResultSet
Query for GeoJSON Results

Returns
result set
Parameters
- Optional boundingBox: BoundingBox
- Optional where: string
- Optional whereArgs: any[]
Returns GeoJSONResultSet
- Defined in lib/features/index/featureIndexManager.ts:2628

queryWithBoundingBox

queryWithBoundingBox(boundingBox: BoundingBox, where?: string, whereArgs?: any[]): FeatureIndexResults
Query for feature index results within the bounding box, projected correctly

Returns
feature index results, close when done
Parameters
- boundingBox: BoundingBox
  
  bounding box
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1177

queryWithBoundingBoxAndColumns

queryWithBoundingBoxAndColumns(boundingBox: BoundingBox, columns: string[], where?: string, whereArgs?: any[]): FeatureIndexResults
Query for feature index results within the bounding box, projected correctly

Returns
feature index results, close when done
Parameters
- boundingBox: BoundingBox
  
  bounding box
- columns: string[]
  
  columns
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1208

queryWithBoundingBoxAndDistinct

queryWithBoundingBoxAndDistinct(boundingBox: BoundingBox, distinct: boolean, where?: string, whereArgs?: any[]): FeatureIndexResults
Query for feature index results within the bounding box, projected correctly

Returns
feature index results, close when done
Parameters
- boundingBox: BoundingBox
  
  bounding box
- distinct: boolean
  
  distinct rows
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1190

queryWithBoundingBoxAndDistinctAndColumns

queryWithBoundingBoxAndDistinctAndColumns(boundingBox: BoundingBox, distinct: boolean, columns: string[], where?: string, whereArgs?: any[]): FeatureIndexResults
Query for feature index results within the bounding box, projected correctly

Returns
feature index results, close when done
Parameters
- boundingBox: BoundingBox
  
  bounding box
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1227

queryWithBoundingBoxAndFieldValues

queryWithBoundingBoxAndFieldValues(boundingBox: BoundingBox, fieldValues: FieldValues): FeatureIndexResults
Query for feature index results within the bounding box, projected correctly

Returns
feature index results, close when done
Parameters
- boundingBox: BoundingBox
  
  bounding box
- fieldValues: FieldValues
  
  field values
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1044

queryWithBoundingBoxAndFieldValuesAndColumns

queryWithBoundingBoxAndFieldValuesAndColumns(columns: string[], boundingBox: BoundingBox, fieldValues: FieldValues): FeatureIndexResults
Query for feature index results within the bounding box, projected correctly

Returns
feature index results, close when done
Parameters
- columns: string[]
  
  columns
- boundingBox: BoundingBox
  
  bounding box
- fieldValues: FieldValues
  
  field values
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1072

queryWithBoundingBoxAndFieldValuesAndDistinct

queryWithBoundingBoxAndFieldValuesAndDistinct(distinct: boolean, boundingBox: BoundingBox, fieldValues: FieldValues): FeatureIndexResults
Query for feature index results within the bounding box, projected correctly

Returns
feature index results, close when done
Parameters
- distinct: boolean
  
  distinct rows
- boundingBox: BoundingBox
  
  bounding box
- fieldValues: FieldValues
  
  field values
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1056

queryWithBoundingBoxAndFieldValuesAndDistinctAndColumns

queryWithBoundingBoxAndFieldValuesAndDistinctAndColumns(boundingBox: BoundingBox, fieldValues: FieldValues, distinct: boolean, columns: string[]): FeatureIndexResults
Query for feature index results within the bounding box, projected correctly

Returns
feature index results, close when done
Parameters
- boundingBox: BoundingBox
  
  bounding box
- fieldValues: FieldValues
  
  field values
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1089

queryWithBoundingBoxAndProjection

queryWithBoundingBoxAndProjection(boundingBox: BoundingBox, projection: Projection, where?: string, whereArgs?: any[]): FeatureIndexResults
Query for feature index results within the bounding box in the provided projection

Returns
feature index results, close when done
Parameters
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1881

queryWithBoundingBoxAndProjectionAndColumns

queryWithBoundingBoxAndProjectionAndColumns(boundingBox: BoundingBox, projection: Projection, columns: string[], where?: string, whereArgs?: any[]): FeatureIndexResults
Query for feature index results within the bounding box in the provided projection

Returns
feature index results, close when done
Parameters
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- columns: string[]
  
  columns
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1934

queryWithBoundingBoxAndProjectionAndDistinct

queryWithBoundingBoxAndProjectionAndDistinct(boundingBox: BoundingBox, projection: Projection, distinct: boolean, where?: string, whereArgs?: any[]): FeatureIndexResults
Query for feature index results within the bounding box in the provided projection

Returns
feature index results, close when done
Parameters
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- distinct: boolean
  
  distinct rows
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1907

queryWithBoundingBoxAndProjectionAndDistinctAndColumns

queryWithBoundingBoxAndProjectionAndDistinctAndColumns(boundingBox: BoundingBox, projection: Projection, distinct: boolean, columns: string[], where?: string, whereArgs?: any[]): FeatureIndexResults
Query for feature index results within the bounding box in the provided projection

Returns
feature index results, close when done
Parameters
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1962

queryWithBoundingBoxAndProjectionAndFieldValues

queryWithBoundingBoxAndProjectionAndFieldValues(boundingBox: BoundingBox, projection: Projection, fieldValues: FieldValues): FeatureIndexResults
Query for feature index results within the bounding box in the provided projection

Returns
feature index results, close when done
Parameters
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- fieldValues: FieldValues
  
  field values
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1684

queryWithBoundingBoxAndProjectionAndFieldValuesAndColumns

queryWithBoundingBoxAndProjectionAndFieldValuesAndColumns(boundingBox: BoundingBox, projection: Projection, fieldValues: FieldValues, columns: string[]): FeatureIndexResults
Query for feature index results within the bounding box in the provided projection

Returns
feature index results, close when done
Parameters
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- fieldValues: FieldValues
  
  field values
- columns: string[]
  
  columns
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1731

queryWithBoundingBoxAndProjectionAndFieldValuesAndDistinct

queryWithBoundingBoxAndProjectionAndFieldValuesAndDistinct(boundingBox: BoundingBox, projection: Projection, fieldValues: FieldValues, distinct: boolean): FeatureIndexResults
Query for feature index results within the bounding box in the provided projection

Returns
feature index results, close when done
Parameters
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- fieldValues: FieldValues
  
  field values
- distinct: boolean
  
  distinct rows
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1707

queryWithBoundingBoxAndProjectionAndFieldValuesAndDistinctAndColumns

queryWithBoundingBoxAndProjectionAndFieldValuesAndDistinctAndColumns(boundingBox: BoundingBox, projection: Projection, fieldValues: FieldValues, distinct: boolean, columns: string[]): FeatureIndexResults
Query for feature index results within the bounding box in the provided projection

Returns
feature index results, close when done
Parameters
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
- fieldValues: FieldValues
  
  field values
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1756

queryWithColumns

queryWithColumns(columns?: string[], where?: string, whereArgs?: any[]): FeatureIndexResults
Query for feature index results

Returns
feature index results, close when done
Parameters
- Optional columns: string[]
  
  columns
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:832

queryWithDistinct

queryWithDistinct(distinct?: boolean, where?: string, whereArgs?: any[]): FeatureIndexResults
Query for feature index results

Returns
feature index results, close when done
Parameters
- Optional distinct: boolean
  
  distinct rows
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:821

queryWithDistinctAndColumns

queryWithDistinctAndColumns(distinct?: boolean, columns?: string[], where?: string, whereArgs?: any[]): FeatureIndexResults
Query for feature index results

Returns
feature index results, close when done
Parameters
- Optional distinct: boolean
  
  distinct rows
- Optional columns: string[]
  
  columns
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:844

queryWithEnvelopeAndColumns

queryWithEnvelopeAndColumns(envelope: GeometryEnvelope, columns: string[], where?: string, whereArgs?: any[]): FeatureIndexResults
Query for feature index results within the Geometry Envelope

Returns
feature index results, close when done
Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
- columns: string[]
  
  columns
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1495

queryWithEnvelopeAndDistinct

queryWithEnvelopeAndDistinct(envelope: GeometryEnvelope, distinct: boolean, where?: string, whereArgs?: any[]): FeatureIndexResults
Query for feature index results within the Geometry Envelope

Returns
feature index results, close when done
Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
- distinct: boolean
  
  distinct rows
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1478

queryWithFieldValues

queryWithFieldValues(fieldValues: FieldValues): FeatureIndexResults
Query for feature index results

Returns
feature index results, close when done
Parameters
- fieldValues: FieldValues
  
  field values
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:716

queryWithFieldValuesAndColumns

queryWithFieldValuesAndColumns(fieldValues: FieldValues, columns: string[]): FeatureIndexResults
Query for feature index results

Returns
feature index results, close when done
Parameters
- fieldValues: FieldValues
  
  field values
- columns: string[]
  
  columns
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:736

queryWithFieldValuesAndDistinct

queryWithFieldValuesAndDistinct(fieldValues: FieldValues, distinct: boolean): FeatureIndexResults
Query for feature index results

Returns
feature index results, close when done
Parameters
- fieldValues: FieldValues
  
  field values
- distinct: boolean
  
  distinct rows
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:726

queryWithFieldValuesAndDistinctAndColumns

queryWithFieldValuesAndDistinctAndColumns(fieldValues: FieldValues, distinct: boolean, columns: string[]): FeatureIndexResults
Query for feature index results

Returns
feature index results, close when done
Parameters
- fieldValues: FieldValues
  
  field values
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:747

queryWithGeometryEnvelope

queryWithGeometryEnvelope(envelope: GeometryEnvelope, where?: string, whereArgs?: any[]): FeatureIndexResults
Query for feature index results within the Geometry Envelope

Returns
feature index results, close when done
Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1466

queryWithGeometryEnvelopeAndDistinctAndColumns

queryWithGeometryEnvelopeAndDistinctAndColumns(envelope: GeometryEnvelope, distinct: boolean, columns: string[], where?: string, whereArgs?: string[]): FeatureIndexResults
Query for feature index results within the Geometry Envelope

Returns
feature index results, close when done
Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
- Optional where: string
  
  where clause
- Optional whereArgs: string[]
  
  where arguments
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1513

queryWithGeometryEnvelopeAndFieldValues

queryWithGeometryEnvelopeAndFieldValues(envelope: GeometryEnvelope, fieldValues: FieldValues): FeatureIndexResults
Query for feature index results within the Geometry Envelope

Returns
feature index results, close when done
Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
- fieldValues: FieldValues
  
  field values
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1329

queryWithGeometryEnvelopeAndFieldValuesAndColumns

queryWithGeometryEnvelopeAndFieldValuesAndColumns(envelope: GeometryEnvelope, fieldValues: FieldValues, columns: string[]): FeatureIndexResults
Query for feature index results within the Geometry Envelope

Returns
feature index results, close when done
Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
- fieldValues: FieldValues
  
  field values
- columns: string[]
  
  columns
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1368

queryWithGeometryEnvelopeAndFieldValuesAndDistinct

queryWithGeometryEnvelopeAndFieldValuesAndDistinct(envelope: GeometryEnvelope, fieldValues: FieldValues, distinct: boolean): FeatureIndexResults
Query for feature index results within the Geometry Envelope

Returns
feature index results, close when done
Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
- fieldValues: FieldValues
  
  field values
- distinct: boolean
  
  distinct rows
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1348

queryWithGeometryEnvelopeAndFieldValuesAndDistinctAndColumns

queryWithGeometryEnvelopeAndFieldValuesAndDistinctAndColumns(envelope: GeometryEnvelope, fieldValues: FieldValues, distinct: boolean, columns: string[]): FeatureIndexResults
Query for feature index results within the Geometry Envelope

Returns
feature index results, close when done
Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
- fieldValues: FieldValues
  
  field values
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
Returns FeatureIndexResults
- Defined in lib/features/index/featureIndexManager.ts:1384

retainIndex

retainIndex(type: FeatureIndexType): boolean
Retain the feature index from the index types and delete the others

Returns
true if deleted from any type
Parameters
- type: FeatureIndexType
  
  feature index type to retain
Returns boolean
- Defined in lib/features/index/featureIndexManager.ts:431

retainIndexTypes

retainIndexTypes(types: FeatureIndexType[]): boolean
Retain the feature index from the index types and delete the others

Returns
true if deleted from any type
Parameters
- types: FeatureIndexType[]
  
  feature index types to retain
Returns boolean
- Defined in lib/features/index/featureIndexManager.ts:442

setContinueOnError

setContinueOnError(continueOnError: boolean): void
Set the continue on error flag
Parameters
- continueOnError: boolean
  
  continue on error
Returns void
- Defined in lib/features/index/featureIndexManager.ts:154

setIndexLocation

setIndexLocation(indexLocation: FeatureIndexType): void
Set the index location
Parameters
- indexLocation: FeatureIndexType
  
  feature index type
Returns void
- Defined in lib/features/index/featureIndexManager.ts:198

setIndexLocationOrder

setIndexLocationOrder(types: FeatureIndexType[]): void
Set the index location order, overriding all previously set types
Parameters
- types: FeatureIndexType[]
  
  feature index types
Returns void
- Defined in lib/features/index/featureIndexManager.ts:182

setProgress

setProgress(progress: GeoPackageProgress): void
Set the GeoPackage Progress
Parameters
- progress: GeoPackageProgress
  
  GeoPackage progress
Returns void
- Defined in lib/features/index/featureIndexManager.ts:206

`Static` isPaginated

isPaginated(results: FeatureIndexResults): boolean
Determine if the results are paginated

Returns
true if paginated
Parameters
- results: FeatureIndexResults
  
  query results
Returns boolean
- Defined in lib/features/index/featureIndexManager.ts:2084

`Static` isPaginatedWithFeatureIndexFeatureResults

isPaginatedWithFeatureIndexFeatureResults(results: FeatureIndexFeatureResults): boolean
Determine if the results are paginated

Returns
true if paginated
Parameters
- results: FeatureIndexFeatureResults
  
  query results
Returns boolean
- Defined in lib/features/index/featureIndexManager.ts:2098

`Static` paginateWithFeatureDao

paginateWithFeatureDao(featureDao: FeatureDao, results: FeatureIndexResults): FeaturePaginatedResults
Paginate the results

Returns
feature paginated results
Parameters
- featureDao: FeatureDao
  
  feature dao
- results: FeatureIndexResults
  
  feature index results
Returns FeaturePaginatedResults
- Defined in lib/features/index/featureIndexManager.ts:2119

Class FeatureIndexManager

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

geoPackage: GeoPackage

featureTableNameOrDao: string | FeatureDao

Returns FeatureIndexManager

Methods

close

Returns void

count

Returns

Parameters

where: string

whereArgs: any[]

Returns number

countAll

Returns

Returns number

countAllWithColumn

Returns

Parameters

column: string

Returns number

countAllWithDistinct

Returns

Parameters

distinct: boolean

Returns number

countAllWithDistinctAndColumn

Returns

Parameters

distinct: boolean

column: string

Returns number

countColumn

Returns

Parameters

column: string

Returns number

countWithBoundingBox

Returns

Parameters

boundingBox: BoundingBox

Optional where: string

Optional whereArgs: any[]

Returns number

countWithBoundingBoxAndColumn

Returns

Parameters

boundingBox: BoundingBox

column: string

Optional where: string

Optional whereArgs: any[]

Returns number

countWithBoundingBoxAndDistinct

Returns

Parameters

boundingBox: BoundingBox

distinct: boolean

Optional where: string

Optional whereArgs: any[]

Returns number

countWithBoundingBoxAndDistinctAndColumn

Returns

Parameters

boundingBox: BoundingBox

distinct: boolean

column: string

Optional where: string

Optional whereArgs: any[]

Returns number

countWithBoundingBoxAndFieldValues

Returns

Parameters

boundingBox: BoundingBox

`Optional` where: string

`Optional` whereArgs: any[]

`Optional` where: string

`Optional` whereArgs: any[]

`Optional` where: string

`Optional` whereArgs: any[]

`Optional` where: string

`Optional` whereArgs: any[]

`Optional` where: string

`Optional` whereArgs: any[]

`Optional` where: string

`Optional` whereArgs: any[]

`Optional` where: string

`Optional` whereArgs: any[]

`Optional` where: string

`Optional` whereArgs: any[]