ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update types accepted when reading features

Browse Source
This commit is contained in:
Tim Schaub
2015-04-07 14:20:52 -06:00
parent 4260368b3b
commit 6a564597fb
14 changed files with 34 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/ol/format/featureformat.js
View File

@@ -85,7 +85,7 @@ ol.format.Feature.prototype.getType = goog.abstractMethod;
/** /**
* Read a single feature from a source. * Read a single feature from a source.
* *
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
*/ */
@@ -95,7 +95,7 @@ ol.format.Feature.prototype.readFeature = goog.abstractMethod;
/** /**
* Read all features from a source. * Read all features from a source.
* *
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
*/ */
@@ -105,7 +105,7 @@ ol.format.Feature.prototype.readFeatures = goog.abstractMethod;
/** /**
* Read a single geometry from a source. * Read a single geometry from a source.
* *
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {ol.geom.Geometry} Geometry. * @return {ol.geom.Geometry} Geometry.
*/ */
@@ -115,7 +115,7 @@ ol.format.Feature.prototype.readGeometry = goog.abstractMethod;
/** /**
* Read the projection from a source. * Read the projection from a source.
* *
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
*/ */
ol.format.Feature.prototype.readProjection = goog.abstractMethod; ol.format.Feature.prototype.readProjection = goog.abstractMethod;

8
src/ol/format/geojsonformat.js
View File

@@ -376,7 +376,7 @@ ol.format.GeoJSON.prototype.getExtensions = function() {
* use `readFeatures` to read FeatureCollection source. * use `readFeatures` to read FeatureCollection source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
* @api stable * @api stable
@@ -389,7 +389,7 @@ ol.format.GeoJSON.prototype.readFeature;
* FeatureCollection sources. * FeatureCollection sources.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @api stable * @api stable
@@ -453,7 +453,7 @@ ol.format.GeoJSON.prototype.readFeaturesFromObject = function(
* Read a geometry from a GeoJSON source. * Read a geometry from a GeoJSON source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {ol.geom.Geometry} Geometry. * @return {ol.geom.Geometry} Geometry.
* @api stable * @api stable
@@ -475,7 +475,7 @@ ol.format.GeoJSON.prototype.readGeometryFromObject = function(
* Read the projection from a GeoJSON source. * Read the projection from a GeoJSON source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @api stable * @api stable
*/ */

2
src/ol/format/gml/gmlbaseformat.js
View File

@@ -590,7 +590,7 @@ ol.format.GMLBase.prototype.readGeometryFromNode =
* Read all features from a GML FeatureCollection. * Read all features from a GML FeatureCollection.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Options. * @param {olx.format.ReadOptions=} opt_options Options.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @api stable * @api stable

6
src/ol/format/gpxformat.js
View File

@@ -438,7 +438,7 @@ ol.format.GPX.prototype.handleReadExtensions_ = function(features) {
* Read the first feature from a GPX source. * Read the first feature from a GPX source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
* @api stable * @api stable
@@ -472,7 +472,7 @@ ol.format.GPX.prototype.readFeatureFromNode = function(node, opt_options) {
* Read all features from a GPX source. * Read all features from a GPX source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @api stable * @api stable
@@ -508,7 +508,7 @@ ol.format.GPX.prototype.readFeaturesFromNode = function(node, opt_options) {
* Read the projection from a GPX source. * Read the projection from a GPX source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @api stable * @api stable
*/ */

6
src/ol/format/igcformat.js
View File

@@ -101,7 +101,7 @@ ol.format.IGC.prototype.getExtensions = function() {
* Read the feature from the IGC source. * Read the feature from the IGC source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
* @api * @api
@@ -189,7 +189,7 @@ ol.format.IGC.prototype.readFeatureFromText = function(text, opt_options) {
* feature, this will return the feature in an array. * feature, this will return the feature in an array.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @api * @api
@@ -214,7 +214,7 @@ ol.format.IGC.prototype.readFeaturesFromText = function(text, opt_options) {
* Read the projection from the IGC source. * Read the projection from the IGC source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @api * @api
*/ */

6
src/ol/format/kmlformat.js
View File

@@ -1736,7 +1736,7 @@ ol.format.KML.prototype.readSharedStyleMap_ = function(node, objectStack) {
* Read the first feature from a KML source. * Read the first feature from a KML source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
* @api stable * @api stable
@@ -1769,7 +1769,7 @@ ol.format.KML.prototype.readFeatureFromNode = function(node, opt_options) {
* Read all features from a KML source. * Read all features from a KML source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @api stable * @api stable
@@ -1957,7 +1957,7 @@ ol.format.KML.prototype.readNetworkLinksFromNode = function(node) {
* Read the projection from a KML source. * Read the projection from a KML source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @api stable * @api stable
*/ */

4
src/ol/format/osmxmlformat.js
View File

@@ -203,7 +203,7 @@ ol.format.OSMXML.NODE_PARSERS_ = ol.xml.makeParsersNS(
* Read all features from an OSM source. * Read all features from an OSM source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @api stable * @api stable
@@ -235,7 +235,7 @@ ol.format.OSMXML.prototype.readFeaturesFromNode = function(node, opt_options) {
* Read the projection from an OSM source. * Read the projection from an OSM source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @api stable * @api stable
*/ */

8
src/ol/format/polylineformat.js
View File

@@ -268,7 +268,7 @@ ol.format.Polyline.encodeUnsignedInteger = function(num) {
* in two dimensions and in latitude, longitude order. * in two dimensions and in latitude, longitude order.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
* @api stable * @api stable
@@ -290,7 +290,7 @@ ol.format.Polyline.prototype.readFeatureFromText = function(text, opt_options) {
* feature, this will return the feature in an array. * feature, this will return the feature in an array.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @api stable * @api stable
@@ -312,7 +312,7 @@ ol.format.Polyline.prototype.readFeaturesFromText =
* Read the geometry from the source. * Read the geometry from the source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {ol.geom.Geometry} Geometry. * @return {ol.geom.Geometry} Geometry.
* @api stable * @api stable
@@ -344,7 +344,7 @@ ol.format.Polyline.prototype.readGeometryFromText =
* Read the projection from a Polyline source. * Read the projection from a Polyline source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @api stable * @api stable
*/ */

4
src/ol/format/topojsonformat.js
View File

@@ -275,7 +275,7 @@ ol.format.TopoJSON.readFeatureFromGeometry_ = function(object, arcs,
* Read all features from a TopoJSON source. * Read all features from a TopoJSON source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @api stable * @api stable
*/ */
@@ -386,7 +386,7 @@ ol.format.TopoJSON.transformVertex_ = function(vertex, scale, translate) {
* Read the projection from a TopoJSON source. * Read the projection from a TopoJSON source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} object Source. * @param {Document|Node|Object|string} object Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @api stable * @api stable
*/ */

8
src/ol/format/wfsformat.js
View File

@@ -106,7 +106,7 @@ ol.format.WFS.SCHEMA_LOCATION = 'http://www.opengis.net/wfs ' +
* Read all features from a WFS FeatureCollection. * Read all features from a WFS FeatureCollection.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @api stable * @api stable
@@ -139,7 +139,7 @@ ol.format.WFS.prototype.readFeaturesFromNode = function(node, opt_options) {
/** /**
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @return {ol.format.WFS.TransactionResponse|undefined} Transaction response. * @return {ol.format.WFS.TransactionResponse|undefined} Transaction response.
* @api stable * @api stable
*/ */
@@ -160,7 +160,7 @@ ol.format.WFS.prototype.readTransactionResponse = function(source) {
/** /**
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @return {ol.format.WFS.FeatureCollectionMetadata|undefined} * @return {ol.format.WFS.FeatureCollectionMetadata|undefined}
* FeatureCollection metadata. * FeatureCollection metadata.
* @api stable * @api stable
@@ -730,7 +730,7 @@ ol.format.WFS.prototype.writeTransaction = function(inserts, updates, deletes,
* Read the projection from a WFS source. * Read the projection from a WFS source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @return {?ol.proj.Projection} Projection. * @return {?ol.proj.Projection} Projection.
* @api stable * @api stable
*/ */

6
src/ol/format/wktformat.js
View File

@@ -209,7 +209,7 @@ ol.format.WKT.prototype.parse_ = function(wkt) {
* Read a feature from a WKT source. * Read a feature from a WKT source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
* @api stable * @api stable
@@ -235,7 +235,7 @@ ol.format.WKT.prototype.readFeatureFromText = function(text, opt_options) {
* Read all features from a WKT source. * Read all features from a WKT source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @api stable * @api stable
@@ -270,7 +270,7 @@ ol.format.WKT.prototype.readFeaturesFromText = function(text, opt_options) {
* Read a single geometry from a WKT source. * Read a single geometry from a WKT source.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Read options. * @param {olx.format.ReadOptions=} opt_options Read options.
* @return {ol.geom.Geometry} Geometry. * @return {ol.geom.Geometry} Geometry.
* @api stable * @api stable

2
src/ol/format/wmsgetfeatureinfoformat.js
View File

@@ -124,7 +124,7 @@ ol.format.WMSGetFeatureInfo.prototype.readFeatures_ =
* Read all features from a WMSGetFeatureInfo response. * Read all features from a WMSGetFeatureInfo response.
* *
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {Document|Node|Object|string} source Source.
* @param {olx.format.ReadOptions=} opt_options Options. * @param {olx.format.ReadOptions=} opt_options Options.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @api stable * @api stable

16
test/spec/ol/binary.test.js
View File

@@ -1,16 +0,0 @@
goog.provide('ol.test.buffer');
describe('ol.binary.Buffer', function() {
describe('constructor', function() {
it('can be constructed without arguments', function() {
var instance = new ol.binary.Buffer();
expect(instance).to.be.an(ol.binary.Buffer);
});
});
});
goog.require('ol.binary.Buffer');

16
test/spec/ol/format/binaryfeatureformat.test.js
View File

@@ -1,16 +0,0 @@
goog.provide('ol.test.format.BinaryFeature');
describe('ol.format.BinaryFeature', function() {
describe('constructor', function() {
it('can be constructed without arguments', function() {
var instance = new ol.format.BinaryFeature();
expect(instance).to.be.an(ol.format.BinaryFeature);
});
});
});
goog.require('ol.format.BinaryFeature');