Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "geocortex/infrastructure/TaskUtils"

Index

Functions

canIdentifyLayer

  • canIdentifyLayer(layer: Layer): boolean
  • Evaluates whether a provided Layer can be identified.

    Parameters

    • layer: Layer

      A Layer that is to be tested for its ability to be identified.

    Returns boolean

canQueryLayer

  • canQueryLayer(layer: Layer): boolean
  • Evaluates whether a provided Layer can be queried.

    Parameters

    • layer: Layer

      A Layer that is to be tested for its ability to be queried.

    Returns boolean

canQueryMapService

  • canQueryMapService(mapService: MapService): boolean
  • Evaluates whether a provided MapService can be queried.

    Parameters

    Returns boolean

getIdentifyTask

  • getIdentifyTask(mapService: MapService): IdentifyTask
  • Gets an esri.tasks.IdentifyTask for a {@link geocortex.essentials.MapService}.

    Parameters

    • mapService: MapService

      The {@link geocortex.essentials.MapService}.

    Returns IdentifyTask

    The constructed esri.tasks.IdentifyTask for the resource.

getIdentifyTaskUrl

  • getIdentifyTaskUrl(mapService: MapService): string
  • Get the service URL, or return null if we don't support identify operations for that service.

    Parameters

    Returns string

getQueryTask

  • Gets an esri.tasks.QueryTask that can be run against for this layer.

    Parameters

    • layer: Layer | Layer

      The Geocortex/Esri Layer that is to be queried.

    • Optional mapService: MapService

      Required if using an esri.layers.Layer as the layer parameter.

    Returns QueryTask

    The constructed esri.tasks.QueryTask for the resource.

getQueryTaskUrl

  • Gets the url that an esri.tasks.QueryTask can be run against for this layer. Suggested to use getQueryTask instead.

    deprecated

    2.6 Use getQueryTask or getIntersectTask instead.

    Parameters

    • layer: Layer | Layer

      The Geocortex/Esri Layer that is to be queried.

    • Optional mapService: MapService

      Required when passing an Esri Layer.

    Returns string

    The url for the query endpoint.

getSearchTextWhereClause

  • getSearchTextWhereClause(layer: Layer, fields: FieldInfo[], searchText: string, trace?: Trace): string
  • Creates a where clause that will search every provided fields with the search text provided.

    Parameters

    • layer: Layer

      The layer to create the where clause for

    • fields: FieldInfo[]

      The fields that will be part of the where clause

    • searchText: string

      The search text to use in those fields

    • Optional trace: Trace

      The trace object for logging purposes (optional)

    Returns string

getTokenizedUrl

  • getTokenizedUrl(url: string, mapService: MapService): string
  • Takes a (presumably properly formatted) url string and associated MapService returns with an added token if needed.

    Parameters

    • url: string

      String for the URL that is going to be used in the Task.

    • mapService: MapService

      The MapService associated with the passed URL.

    Returns string