Class: QueryHelper

Cadcorp.GeognoSIS.QueryHelper

new QueryHelper(config)

Handles queries on individual GeognoSIS overlays.
Parameters:
Name Type Description
config Object Configuration for this object. The config supplied directly extends the control

Members

events

Properties:
Name Type Description
events Cadcorp.Util.Events Events object for the class.

overlay

Properties:
Name Type Description
overlay Cadcorp.GeognoSIS.Overlay Overlay to perform queries on.

Methods

construct(config)

Constructor for Cadcorp based classes.
Parameters:
Name Type Description
config Object configuration object.

destroy()

Destroys the control.

findItems(expressionBuilder, maxFeaturesToGet, startPosition, getTotalNumberOfItems, collateResults, queryBoundsopt)

Perform a query on a layer. This function performs an AJAX request and returns immediately.
Fires the QueryComplete event when the query has been performed.
Parameters:
Name Type Attributes Description
expressionBuilder Cadcorp.GeognoSIS.ExpressionBuilderBase The SIS expression builder ti create the expression with.
maxFeaturesToGet number The maximum number of features to return from the query.
startPosition number The start position to get items from.
getTotalNumberOfItems boolean Should the query get the total number of items found for the expression.
collateResults boolean Should the results be collated or returned individualy.
queryBounds OpenLayers.Bounds <optional>
 Limit the query to these bounds, the bounds must be in the same projection as the map
Fires:

(protected) getItem_successHandler(e)

Handles the successful retrieval of item properties.
Parameters:
Name Type Description
e Object item results.

(protected) queryCompleted(e)

Event Handler for when the query is completed.
Parameters:
Name Type Description
e Object event args.

Events

FeaturesCounted

Features Counted event
Type:
  • Object
Properties:
Name Type Description
count number The count of features found.
sender Cadcorp.GeognoSIS.QueryHelper The sender of the event

ItemPopulated

Item populated
Type:
  • Object
Properties:
Name Type Description
item Cadcorp.GeognoSIS.Item The populated item.
sender Cadcorp.GeognoSIS.QueryHelper The sender of the event

QueryComplete

Query Complete Event
Type:
  • Object
Properties:
Name Type Description
foundItems Array.<Object> array of found items.
sender Cadcorp.GeognoSIS.QueryHelper The sender of the event
moreAvailable boolean Indicates if there are more results available

QueryError

Query Error Event
Type:
  • Object
Properties:
Name Type Description
object Cadcorp.GeognoSIS.QueryHelper The sender of the event