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

Mark optional property with square brackets

Browse Source
This commit is contained in:
Frederic Junod
2018-04-04 16:55:32 +02:00
parent 842cdcfcf7
commit 070f08e778
3 changed files with 31 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/ol/format/GMLBase.js
View File

@@ -31,7 +31,7 @@ export const GMLNS = 'http://www.opengis.net/gml';
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {Object.<string, string>|string|undefined} featureNS Feature * @property {Object.<string, string>|string} [featureNS] Feature
* namespace. If not defined will be derived from GML. If multiple * namespace. If not defined will be derived from GML. If multiple
* feature types have been configured which come from different feature * feature types have been configured which come from different feature
* namespaces, this will be an object with the keys being the prefixes used * namespaces, this will be an object with the keys being the prefixes used
@@ -39,7 +39,7 @@ export const GMLNS = 'http://www.opengis.net/gml';
* feature namespaces themselves. So for instance there might be a featureType * feature namespaces themselves. So for instance there might be a featureType
* item `topp:states` in the `featureType` array and then there will be a key * item `topp:states` in the `featureType` array and then there will be a key
* `topp` in the featureNS object with value `http://www.openplans.org/topp`. * `topp` in the featureNS object with value `http://www.openplans.org/topp`.
* @property {Array.<string>|string|undefined} featureType Feature type(s) to parse. * @property {Array.<string>|string} [featureType] Feature type(s) to parse.
* If multiple feature types need to be configured * If multiple feature types need to be configured
* which come from different feature namespaces, `featureNS` will be an object * which come from different feature namespaces, `featureNS` will be an object
* with the keys being the prefixes used in the entries of featureType array. * with the keys being the prefixes used in the entries of featureType array.
@@ -48,15 +48,15 @@ export const GMLNS = 'http://www.opengis.net/gml';
* there will be a key named `topp` in the featureNS object with value * there will be a key named `topp` in the featureNS object with value
* `http://www.openplans.org/topp`. * `http://www.openplans.org/topp`.
* @property {string} srsName srsName to use when writing geometries. * @property {string} srsName srsName to use when writing geometries.
* @property {boolean|undefined} surface Write gml:Surface instead of gml:Polygon * @property {boolean} [surface=false] Write gml:Surface instead of gml:Polygon
* elements. This also affects the elements in multi-part geometries. Default is `false`. * elements. This also affects the elements in multi-part geometries.
* @property {boolean|undefined} curve Write gml:Curve instead of gml:LineString * @property {boolean} [curve=false] Write gml:Curve instead of gml:LineString
* elements. This also affects the elements in multi-part geometries. Default is `false`. * elements. This also affects the elements in multi-part geometries.
* @property {boolean|undefined} multiCurve Write gml:MultiCurve instead of gml:MultiLineString. * @property {boolean} [multiCurve=true] Write gml:MultiCurve instead of gml:MultiLineString.
* Since the latter is deprecated in GML 3, the default is `true`. * Since the latter is deprecated in GML 3.
* @property {boolean|undefined} multiSurface Write gml:multiSurface instead of * @property {boolean} [multiSurface=true] Write gml:multiSurface instead of
* gml:MultiPolygon. Since the latter is deprecated in GML 3, the default is `true`. * gml:MultiPolygon. Since the latter is deprecated in GML 3.
* @property {string|undefined} schemaLocation Optional schemaLocation to use when * @property {string} [schemaLocation] Optional schemaLocation to use when
* writing out the GML, this will override the default provided. * writing out the GML, this will override the default provided.
*/ */

44
src/ol/format/WFS.js
View File

@@ -19,14 +19,10 @@ import {createElementNS, isDocument, isNode, makeArrayPusher, makeChildAppender,
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {Object.<string, string>|string|undefined} featureNS The namespace * @property {Object.<string, string>|string} [featureNS] The namespace URI used for features.
* URI used for features. * @property {Array.<string>|string} [featureType] The feature type to parse. Only used for read operations.
* @property {Array.<string>|string|undefined} featureType The feature type to parse. * @property {module:ol/format/GMLBase~GMLBase} [gmlFormat] The GML format to use to parse the response. Default is `ol.format.GML3`.
* Only used for read operations. * @property {string} [schemaLocation] Optional schemaLocation to use for serialization, this will override the default.
* @property {ol.format.GMLBase|undefined} gmlFormat The GML format to use to parse
* the response. Default is `ol.format.GML3`.
* @property {string|undefined} schemaLocation Optional schemaLocation to use for
* serialization, this will override the default.
*/ */
@@ -35,22 +31,22 @@ import {createElementNS, isDocument, isNode, makeArrayPusher, makeChildAppender,
* @property {string} featureNS The namespace URI used for features. * @property {string} featureNS The namespace URI used for features.
* @property {string} featurePrefix The prefix for the feature namespace. * @property {string} featurePrefix The prefix for the feature namespace.
* @property {Array.<string>} featureTypes The feature type names. * @property {Array.<string>} featureTypes The feature type names.
* @property {string|undefined} srsName SRS name. No srsName attribute will be set on * @property {string} [srsName] SRS name. No srsName attribute will be set on
* geometries when this is not provided. * geometries when this is not provided.
* @property {string|undefined} handle Handle. * @property {string} [handle] Handle.
* @property {string|undefined} outputFormat Output format. * @property {string} [outputFormat] Output format.
* @property {number|undefined} maxFeatures Maximum number of features to fetch. * @property {number} [maxFeatures] Maximum number of features to fetch.
* @property {string|undefined} geometryName Geometry name to use in a BBOX filter. * @property {string} [geometryName] Geometry name to use in a BBOX filter.
* @property {Array.<string>|undefined} propertyNames Optional list of property names to serialize. * @property {Array.<string>} [propertyNames] Optional list of property names to serialize.
* @property {number|undefined} startIndex Start index to use for WFS paging. This is a * @property {number} [startIndex] Start index to use for WFS paging. This is a
* WFS 2.0 feature backported to WFS 1.1.0 by some Web Feature Services. * WFS 2.0 feature backported to WFS 1.1.0 by some Web Feature Services.
* @property {number|undefined} count Number of features to retrieve when paging. This is a * @property {number} [count] Number of features to retrieve when paging. This is a
* WFS 2.0 feature backported to WFS 1.1.0 by some Web Feature Services. Please note that some * WFS 2.0 feature backported to WFS 1.1.0 by some Web Feature Services. Please note that some
* Web Feature Services have repurposed `maxfeatures` instead. * Web Feature Services have repurposed `maxfeatures` instead.
* @property {module:ol/extent~Extent} [bbox] Extent to use for the BBOX filter. * @property {module:ol/extent~Extent} [bbox] Extent to use for the BBOX filter.
* @property {ol.format.filter.Filter|undefined} filter Filter condition. See * @property {ol.format.filter.Filter} [filter] Filter condition. See
* {@link ol.format.filter} for more information. * {@link ol.format.filter} for more information.
* @property {string|undefined} resultType Indicates what response should be returned, * @property {string} [resultType] Indicates what response should be returned,
* E.g. `hits` only includes the `numberOfFeatures` attribute in the response and no features. * E.g. `hits` only includes the `numberOfFeatures` attribute in the response and no features.
*/ */
@@ -60,16 +56,14 @@ import {createElementNS, isDocument, isNode, makeArrayPusher, makeChildAppender,
* @property {string} featureNS The namespace URI used for features. * @property {string} featureNS The namespace URI used for features.
* @property {string} featurePrefix The prefix for the feature namespace. * @property {string} featurePrefix The prefix for the feature namespace.
* @property {string} featureType The feature type name. * @property {string} featureType The feature type name.
* @property {string|undefined} srsName SRS name. No srsName attribute will be set on * @property {string} [srsName] SRS name. No srsName attribute will be set on
* geometries when this is not provided. * geometries when this is not provided.
* @property {string|undefined} handle Handle. * @property {string} [handle] Handle.
* @property {boolean|undefined} hasZ Must be set to true if the transaction is for * @property {boolean} [hasZ] Must be set to true if the transaction is for
* a 3D layer. This will allow the Z coordinate to be included in the transaction. * a 3D layer. This will allow the Z coordinate to be included in the transaction.
* @property {Array.<Object>} nativeElements Native elements. Currently not supported. * @property {Array.<Object>} nativeElements Native elements. Currently not supported.
* @property {module:ol/format/GMLBase~Options|undefined} gmlOptions GML options for * @property {module:ol/format/GMLBase~Options} [gmlOptions] GML options for the WFS transaction writer.
* the WFS transaction writer. * @property {string} [version='1.1.0'] WFS version to use for the transaction. Can be either `1.0.0` or `1.1.0`.
* @property {string|undefined} version WFS version to use for the transaction. Can be
* either `1.0.0` or `1.1.0`. Default is `1.1.0`.
*/ */

3
src/ol/format/WMSGetFeatureInfo.js
View File

@@ -11,8 +11,7 @@ import {makeArrayPusher, makeStructureNS, pushParseAndPop} from '../xml.js';
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {Array.<string>|undefined} layers If set, only features of the * @property {Array.<string>} [layers] If set, only features of the given layers will be returned by the format when read.
* given layers will be returned by the format when read.
*/ */