MapFish Protocol class. This class is a decorator class to OpenLayers.Protocol.HTTP
| mapfish. | MapFish Protocol class. |
| Properties | |
| wildcarded. | {Boolean} If true percent signs are added around values read from LIKE filters, for example if the protocol read method is passed a LIKE filter whose property is “foo” and whose value is “bar” the string “foo__ilike=%bar%” will be sent in the query string; defaults to false. |
| Constructor | |
| mapfish. | |
| Functions | |
| create | Create features. |
| read | Construct a request for reading new features. |
| update | Construct a request updating modified features. |
| delete | Construct a request deleting a removed feature. |
| create | Shortcut to create MapFish Protocol decorated with TriggerEventDecorator and MergeFilterDecorator |
"create": function( features, options )
Create features.
| features | {Array({OpenLayers.Feature.Vector})} or {OpenLayers.Feature.Vector} |
| options | {Object} Optional object for configuring the request. This object is modified and should not be reused. |
{OpenLayers.Protocol.Response} An OpenLayers.Protocol.Response object, whose “priv” property references the HTTP request, this object is also passed to the callback function when the request completes, its “features” property is then populated with the the features received from the server.
"read": function( options )
Construct a request for reading new features.
| options | {Object} Optional object for configuring the request. This object is modified and should not be reused. |
{OpenLayers.Protocol.Response} An OpenLayers.Protocol.Response object, whose “priv” property references the HTTP request, this object is also passed to the callback function when the request completes, its “features” property is then populated with the the features received from the server.
"update": function( features, options )
Construct a request updating modified features.
| features | {Array({OpenLayers.Feature.Vector})} or {OpenLayers.Feature.Vector} |
| options | {Object} Optional object for configuring the request. This object is modified and should not be reused. |
{OpenLayers.Protocol.Response} An OpenLayers.Protocol.Response object, whose “priv” property references the HTTP request, this object is also passed to the callback function when the request completes, its “features” property is then populated with the the features received from the server.
"delete": function( feature, options )
Construct a request deleting a removed feature.
| feature | {OpenLayers.Feature.Vector} |
| options | {Object} Optional object for configuring the request. This object is modified and should not be reused. |
{OpenLayers.Protocol.Response} An OpenLayers.Protocol.Response object, whose “priv” property references the HTTP request, this object is also passed to the callback function when the request completes.
mapfish.Protocol.MapFish.create = function( config )
Shortcut to create MapFish Protocol decorated with TriggerEventDecorator and MergeFilterDecorator
var protocol = mapfish.Protocol.MapFish.create({
url: url,
});| config | {Object} The config of the decorated MapFish protocol |
{mapfish.Protocol.MapFish} The resulting protocol.
Create features.
"create": function( features, options )
Construct a request for reading new features.
"read": function( options )
Construct a request updating modified features.
"update": function( features, options )
Construct a request deleting a removed feature.
"delete": function( feature, options )