Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TopFeaturesQuery

Hierarchy

Index

Properties

cacheHint

cacheHint: boolean

Indicates if the service should cache the query results.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

distance

distance: number

Specifies a search distance from a given geometry in a spatial query.

Read more...

geometry

geometry: Geometry

The geometry to apply to the spatial filter.

Read more...

geometryPrecision

geometryPrecision: number

Specifies the number of decimal places for geometries returned by the query operation.

Read more...

initialized

initialized: boolean

maxAllowableOffset

maxAllowableOffset: number

The maximum distance in units of outSpatialReference used for generalizing geometries returned by the query operation.

Read more...

num

num: number

The number of features to retrieve.

Read more...

objectIds

objectIds: number[]

An array of ObjectIDs to be used to query for features in a layer.

Read more...

orderByFields

orderByFields: string[]

One or more field names used to order the query results.

Read more...

outFields

outFields: string[]

Attribute fields to include in the FeatureSet.

Read more...

outSpatialReference

outSpatialReference: SpatialReference

The spatial reference for the returned geometry.

Read more...

returnGeometry

returnGeometry: boolean

If true, each feature in the returned FeatureSet includes the geometry.

Read more...

returnM

returnM: boolean

If true, and returnGeometry is true, then m-values are included in the geometry.

Read more...

returnZ

returnZ: boolean

If true, and returnGeometry is true, then z-values are included in the geometry.

Read more...

spatialRelationship

spatialRelationship: "intersects" | "contains" | "crosses" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation"

For spatial queries, this parameter defines the spatial relationship to query features in the layer or layer view against the input geometry.

Read more...

start

start: number

The zero-based index indicating where to begin retrieving features.

Read more...

timeExtent

timeExtent: TimeExtent

A time extent for a temporal query against time-aware layers.

Read more...

topFilter

topFilter: TopFilter

The topFilter parameter is used to set the groupByFields, orderByFields, and topCount criteria used in generating the result.

Read more...

units

units: "meters" | "kilometers" | "feet" | "miles" | "nautical-miles" | "us-nautical-miles"

The unit for calculating the buffer distance when distance is specified in spatial queries.

Read more...

where

where: string

A where clause for the query.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns TopFeaturesQuery

clone

  • Creates a deep clone of TopFeaturesQuery object.

    Read more...

    Returns TopFeaturesQuery

destroy

  • destroy(): void
  • Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns TopFeaturesQuery

  • Parameters

    Returns TopFeaturesQuery

toJSON

  • toJSON(): any
  • Converts an instance of this class to its ArcGIS portal JSON representation.

    Read more...

    Returns any

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc