Class QueryAPI

A base class for anything requiring access to the InstanceApi and instance of Vue app controlled by it.

Export

APIScope

Hierarchy (View Summary)

APIScope
- QueryAPI

Index

Constructors

Properties

Accessors

Methods

arcGisServerQueryIds geoJsonQuery makeClickBuffer

Constructors

constructor

new QueryAPI(iApi: InstanceAPI): QueryAPI
Parameters
- iApi: InstanceAPI
Returns QueryAPI
Overrides APIScope.constructor
- Defined in src/geo/utils/query.ts:15

Properties

`Readonly`$iApi

$iApi: InstanceAPI

The instance of RampMap API scoped to a single Vue R4MP application.

Memberof

APIScope

Accessors

$element

get $element(): App<Element>
Returns App<Element>
Inherited from APIScope.$element
- Defined in src/api/common.ts:32

$vApp

get $vApp(): ComponentPublicInstance
The instance of Vue R4MP application controlled by this InstanceAPI. This is just a shorthand for this.$iApi.$vApp.

Returns ComponentPublicInstance
Memberof
APIScope
Inherited from APIScope.$vApp
- Defined in src/api/common.ts:28

Methods

arcGisServerQueryIds

arcGisServerQueryIds(options: QueryFeaturesArcServerParams): Promise<number[]>
Gets an array of OIDs from an arcgis server feature source that satisfy a query
Parameters
- options: QueryFeaturesArcServerParams
  contains properties that define the query and specificy request particulars.
Returns Promise<number[]>
resolves with array of object ids.
- Defined in src/geo/utils/query.ts:25

geoJsonQuery

geoJsonQuery(options: QueryFeaturesFileParams): Promise<Graphic[]>
Gets an array of graphics from a locally stored feature layer (file, geojson) that satisfy a query
Parameters
- options: QueryFeaturesFileParams
  contains properties that define the query and specificy request particulars.
Returns Promise<Graphic[]>
resolves with array of graphic result objects.
- Defined in src/geo/utils/query.ts:68

makeClickBuffer

makeClickBuffer(point: Point, tolerance?: number): Extent
Function
Create an extent centered around a point, that is appropriate for the current map scale.

makeClickBuffer
Parameters
- point: Point
  point on the map for extent center
- tolerance: number = 5
  optional. distance in pixels from mouse point that qualifies as a hit. default is 5
Returns Extent
an extent of desired size and location
- Defined in src/geo/utils/query.ts:161