Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryResult

QueryResult defines a return value for query methods.

Hierarchy

  • QueryResult

Implemented by

Index

Properties

Methods

Properties

activeVisualizer

activeVisualizer: Visualizer

Property activeVisualizer is the currently active Visualizer of the result.

featureFilter

featureFilter: function

Type declaration

    • (feature: Feature): boolean

    • Parameters

      • feature: Feature

      Returns boolean

featureType

featureType: FeatureTypeDetails

Property featureType FeatureTypeDetails of the result.

filterChanged

filterChanged: Event<void>

id

id: Guid

The identifier of the result as a Guid.

loadedFeatures

loadedFeatures: Feature[]

The features of the result that are currently loaded as an array of Feature.

Optional queryOptions

queryOptions: QueryOptions

An optional set of parameters as QueryOptions to pass into the query.

visualizers

visualizers: Visualizer[]

Property visualizers is an array of Visualizer usable by the result.

Methods

getFeatures

  • getFeatures(pageNumber: number, pageSize: number): Promise<Feature[]>
  • getFeatures(pageNumber: number, pageSize: number): Promise<Feature[]>
  • getFeatures(pageNumber: number, pageSize: number): Promise<Feature[]>

  • Parameters

    • pageNumber: number
    • pageSize: number

    Returns Promise<Feature[]>

  • Method for getting the specified features of the result.

    Parameters

    • pageNumber: number

      is the page number to retrieve.

    • pageSize: number

      is the number of features on a page.

    Returns Promise<Feature[]>

    a Q.Promise of an array of Feature

  • Parameters

    • pageNumber: number
    • pageSize: number

    Returns Promise<Feature[]>

getTotalResultCount

  • getTotalResultCount(): number
  • getTotalResultCount(): number
  • getTotalResultCount(): number

  • Returns number

  • Method for getting the overall count of features in the result.

    Returns number

    number of features in the result

  • Returns number