OpenSpace.Strategy.BBOX

Used to control the fetching of boundary data depending on the map window’s bounding box.

Inherits from

<OpenLayers.Strategy.BBOX>

Summary

OpenSpace.Strategy.BBOX	Used to control the fetching of boundary data depending on the map window’s bounding box.
Properties
bounds	{<OpenLayers.Bounds>} The current data bounds.
ratio	{Float} The ratio of the data bounds to the viewport bounds (in each dimension).
response	{<OpenLayers.Protocol.Response>} The protocol response object returned by the layer protocol.
merge_features	{boolean} Alternative method that merges features to be rendered rather than a total redraw.
Constructor
OpenSpace.Strategy.BBOX	Create a new BBOX strategy.
Functions
activate	Set up strategy with regard to reading new batches of remote data.
deactivate	Tear down strategy with regard to reading new batches of remote data.
update	Callback function called on “moveend” or “refresh” layer events.
invalidBounds
calculateBounds
triggerRead	{<OpenLayers.Protocol.Response>} The protocol response object returned by the layer protocol.
createFilter	Returns {<OpenLayers.Filter>} The filter object.
containsFeature	Check if the given feature is in the collection.
replace	Replace all features.
merge	Given a list of features, determine which ones to add to the layer.

Properties

bounds

{<OpenLayers.Bounds>} The current data bounds.

ratio

{Float} The ratio of the data bounds to the viewport bounds (in each dimension).

response

{<OpenLayers.Protocol.Response>} The protocol response object returned by the layer protocol.

merge_features

{boolean} Alternative method that merges features to be rendered rather than a total redraw.

Constructor

OpenSpace.Strategy.BBOX

Create a new BBOX strategy.

Parameters

options

{Object} Optional object whose properties will be set on the instance.

Functions

activate

activate: function()

Set up strategy with regard to reading new batches of remote data.

Returns

{Boolean} The strategy was successfully activated.

deactivate

deactivate: function()

Tear down strategy with regard to reading new batches of remote data.

Returns

{Boolean} The strategy was successfully deactivated.

update

update: function( options )

Callback function called on “moveend” or “refresh” layer events.

Parameters

options

{Object} An object with a property named “force”, this property references a boolean value indicating if new data must be incondtionally read.

invalidBounds

invalidBounds: function( mapBounds )

Parameters

mapBounds

{<OpenLayers.Bounds>} the current map extent, will be retrieved from the map object if not provided

Returns

{Boolean}

calculateBounds

calculateBounds: function( mapBounds )

Parameters

mapBounds

{<OpenLayers.Bounds>} the current map extent, will be retrieved from the map object if not provided

triggerRead

triggerRead: function()

Returns

{<OpenLayers.Protocol.Response>} The protocol response object returned by the layer protocol.

createFilter

createFilter: function()

Returns {<OpenLayers.Filter>} The filter object.

containsFeature

containsFeature: function( feature,
featureCollection )

Check if the given feature is in the collection.

Returns {boolean} True if feature is in the collection.

replace

replace: function( resp )

Replace all features.

Parameters

resp	{<OpenLayers.Protocol.Response>} The response object passed by the protocol.

merge

merge: function( resp )

Given a list of features, determine which ones to add to the layer.

Parameters

resp	{<OpenLayers.Protocol.Response>} The response object passed by the protocol.