Class QueryAPI

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

Export

Hierarchy

Constructors

constructor

Properties

$iApi

Accessors

$element $vApp

Methods

arcGisServerQueryIds geoJsonQuery makeClickBuffer queryGeometryHelper

Constructors

constructor

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>

$vApp

  • get $vApp(): ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>

  • The instance of Vue R4MP application controlled by this InstanceAPI. This is just a shorthand for this.$iApi.$vApp.

    Returns ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>

    Memberof

    APIScope

Methods

arcGisServerQueryIds

  • Gets an array of OIDs from an arcgis server feature source that satisfy a query

    Parameters

    Returns Promise<number[]>

    resolves with array of object ids.

geoJsonQuery

  • Gets an array of graphics from a locally stored feature layer (file, geojson) that satisfy a query

    Parameters

    Returns Promise<Graphic[]>

    resolves with array of graphic result objects.

makeClickBuffer

  • Create an extent centered around a point, that is appropriate for the current map scale.

    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

    Function

    makeClickBuffer

Private queryGeometryHelper

  • Private

    Helper function to modify input geometries for queries. Will attempt to avoid various pitfalls, usually around projections

    Parameters

    • geometry: BaseGeometry

      the geometry to be used in a query as a filter

    • isFileLayer: boolean

      true if layer is not tied to an arcgis server

    • Optional mapScale: number

      optional scale value of the map to help detect problem situations

    • Optional sourceSR: SpatialReference

      optional spatial reference of the layer being queried to help detect problem situations

    Returns Geometry

    returns the input geometry in the most appropriate form based on the inputs

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc