Type Definitions
-
olx.format.EsriJSONOptions{Object}
-
Properties:
Name Type Argument Description geometryNamestring | undefined <optional>
Geometry name to use when creating features.
-
olx.format.GeoJSONOptions{Object}
-
Properties:
Name Type Argument Description defaultDataProjectionol.ProjectionLike Default data projection. Default is
EPSG:4326.featureProjectionol.ProjectionLike Projection for features read or written by the format. Options passed to read or write methods will take precedence.
geometryNamestring | undefined <optional>
Geometry name to use when creating features.
extractGeometryNameboolean | undefined <optional>
Certain GeoJSON providers include the geometry_name field in the feature geoJSON. If set to
truethe geoJSON reader will look for that field to set the geometry name. If both this field is set totrueand ageometryNameis provided, thegeometryNamewill take precedence. Default isfalse. -
olx.format.GMLOptions{Object}
-
Properties:
Name Type Argument Description featureNSObject.<string, string> | string | undefined <optional>
Feature namespace. If not defined will be derived from GML. If multiple feature types have been configured which come from different feature namespaces, this will be an object with the keys being the prefixes used in the entries of featureType array. The values of the object will be the feature namespaces themselves. So for instance there might be a featureType item
topp:statesin thefeatureTypearray and then there will be a keytoppin the featureNS object with valuehttp://www.openplans.org/topp.featureTypeArray.<string> | string | undefined <optional>
Feature type(s) to parse. If multiple feature types need to be configured which come from different feature namespaces,
featureNSwill be an object with the keys being the prefixes used in the entries of featureType array. The values of the object will be the feature namespaces themselves. So for instance there might be a featureType itemtopp:statesand then there will be a key namedtoppin the featureNS object with valuehttp://www.openplans.org/topp.srsNamestring srsName to use when writing geometries. Required.
surfaceboolean | undefined <optional>
Write gml:Surface instead of gml:Polygon elements. This also affects the elements in multi-part geometries. Default is
false.curveboolean | undefined <optional>
Write gml:Curve instead of gml:LineString elements. This also affects the elements in multi-part geometries. Default is
false.multiCurveboolean | undefined <optional>
Write gml:MultiCurve instead of gml:MultiLineString. Since the latter is deprecated in GML 3, the default is
true.multiSurfaceboolean | undefined <optional>
Write gml:multiSurface instead of gml:MultiPolygon. Since the latter is deprecated in GML 3, the default is
true.schemaLocationstring | undefined <optional>
Optional schemaLocation to use when writing out the GML, this will override the default provided.
-
olx.format.GPXOptions{Object}
-
Properties:
Name Type Argument Description readExtensionsfunction | undefined <optional>
Callback function to process
extensionsnodes. To prevent memory leaks, this callback function must not store any references to the node. Note that theextensionsnode is not allowed in GPX 1.0. Moreover, onlyextensionsnodes fromwpt,rteandtrkcan be processed, as those are directly mapped to a feature. -
olx.format.IGCOptions{Object}
-
Properties:
Name Type Argument Description altitudeModeol.format.IGCZ | undefined <optional>
Altitude mode. Possible values are
barometric,gps, andnone. Default isnone. -
olx.format.KMLOptions{Object}
-
Properties:
Name Type Argument Description extractStylesboolean | undefined <optional>
Extract styles from the KML. Default is
true.showPointNamesboolean | undefined <optional>
Show names as labels for placemarks which contain points. Default is
true.defaultStyleArray.<ol.style.Style> | undefined <optional>
Default style. The default default style is the same as Google Earth.
writeStylesboolean | undefined <optional>
Write styles into KML. Default is
true. -
olx.format.MVTOptions{Object}
-
Properties:
Name Type Argument Description featureClassundefined | function | function <optional>
Class for features returned by
ol.format.MVT#readFeatures. Set tool.Featureto get full editing and geometry support at the cost of decreased rendering performance. The default isol.render.Feature, which is optimized for rendering and hit detection.geometryNamestring | undefined <optional>
Geometry name to use when creating features. Default is 'geometry'.
layerNamestring | undefined <optional>
Name of the feature attribute that holds the layer name. Default is 'layer'.
layersArray.<string> | undefined <optional>
Layers to read features from. If not provided, features will be read from all layers.
-
olx.format.PolylineOptions{Object}
-
Properties:
Name Type Argument Description factornumber | undefined <optional>
The factor by which the coordinates values will be scaled. Default is
1e5.geometryLayoutol.geom.GeometryLayout | undefined <optional>
Layout of the feature geometries created by the format reader. Default is
ol.geom.GeometryLayout.XY. -
olx.format.ReadOptions{Object}
-
Properties:
Name Type Description dataProjectionol.ProjectionLike Projection of the data we are reading. If not provided, the projection will be derived from the data (where possible) or the
defaultDataProjectionof the format is assigned (where set). If the projection can not be derived from the data and if nodefaultDataProjectionis set for a format, the features will not be reprojected.extentol.Extent Tile extent of the tile being read. This is only used and required for
ol.format.MVT. Required.featureProjectionol.ProjectionLike Projection of the feature geometries created by the format reader. If not provided, features will be returned in the
dataProjection. -
olx.format.TopoJSONOptions{Object}
-
Properties:
Name Type Argument Description defaultDataProjectionol.ProjectionLike Default data projection. Default is
EPSG:4326.layerNamestring | undefined <optional>
Set the name of the TopoJSON topology
objects's children as feature property with the specified name. This means that when set to'layer', a topology like{ "type": "Topology", "objects": { "example": { "type": "GeometryCollection", "geometries": [] } } }will result in features that have a property
'layer'set to'example'. When not set, no property will be added to features.layersArray.<string> | undefined <optional>
Names of the TopoJSON topology's
objects's children to read features from. If not provided, features will be read from all children. -
olx.format.WFSOptions{Object}
-
Properties:
Name Type Argument Description featureNSObject.<string, string> | string | undefined <optional>
The namespace URI used for features.
featureTypeArray.<string> | string | undefined <optional>
The feature type to parse. Only used for read operations.
gmlFormatol.format.GMLBase | undefined <optional>
The GML format to use to parse the response. Default is
ol.format.GML3.schemaLocationstring | undefined <optional>
Optional schemaLocation to use for serialization, this will override the default.
-
olx.format.WFSWriteGetFeatureOptions{Object}
-
Properties:
Name Type Argument Description featureNSstring The namespace URI used for features. Required.
featurePrefixstring The prefix for the feature namespace. Required.
featureTypesArray.<string> The feature type names. Required.
srsNamestring | undefined <optional>
SRS name. No srsName attribute will be set on geometries when this is not provided.
handlestring | undefined <optional>
Handle.
outputFormatstring | undefined <optional>
Output format.
maxFeaturesnumber | undefined <optional>
Maximum number of features to fetch.
geometryNamestring | undefined <optional>
Geometry name to use in a BBOX filter.
propertyNamesArray.<string> | undefined <optional>
Optional list of property names to serialize.
startIndexnumber | undefined <optional>
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.
countnumber | undefined <optional>
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 Web Feature Services have repurposed
maxfeaturesinstead.bboxol.Extent | undefined <optional>
Extent to use for the BBOX filter.
filterol.format.filter.Filter | undefined <optional>
Filter condition. See
ol.format.filterfor more information.resultTypestring | undefined <optional>
Indicates what response should be returned, E.g.
hitsonly includes thenumberOfFeaturesattribute in the response and no features. -
olx.format.WFSWriteTransactionOptions{Object}
-
Properties:
Name Type Argument Description featureNSstring The namespace URI used for features. Required.
featurePrefixstring The prefix for the feature namespace. Required.
featureTypestring The feature type name. Required.
srsNamestring | undefined <optional>
SRS name. No srsName attribute will be set on geometries when this is not provided.
handlestring | undefined <optional>
Handle.
hasZboolean | undefined <optional>
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.
nativeElementsArray.<Object> Native elements. Currently not supported. Required.
gmlOptionsolx.format.GMLOptions | undefined <optional>
GML options for the WFS transaction writer.
versionstring | undefined <optional>
WFS version to use for the transaction. Can be either
1.0.0or1.1.0. Default is1.1.0. -
olx.format.WKTOptions{Object}
-
Properties:
Name Type Argument Description splitCollectionboolean | undefined <optional>
Whether to split GeometryCollections into multiple features on reading. Default is
false. -
olx.format.WMSGetFeatureInfoOptions{Object}
-
Properties:
Name Type Argument Description layersArray.<string> | undefined <optional>
If set, only features of the given layers will be returned by the format when read.
-
olx.format.WriteOptions{Object}
-
Properties:
Name Type Argument Description dataProjectionol.ProjectionLike Projection of the data we are writing. If not provided, the
defaultDataProjectionof the format is assigned (where set). If nodefaultDataProjectionis set for a format, the features will be returned in thefeatureProjection.featureProjectionol.ProjectionLike Projection of the feature geometries that will be serialized by the format writer. If not provided, geometries are assumed to be in the
dataProjectionif that is set; in other words, they are not transformed.rightHandedboolean | undefined <optional>
When writing geometries, follow the right-hand rule for linear ring orientation. This means that polygons will have counter-clockwise exterior rings and clockwise interior rings. By default, coordinates are serialized as they are provided at construction. If
true, the right-hand rule will be applied. Iffalse, the left-hand rule will be applied (clockwise for exterior and counter-clockwise for interior rings). Note that not all formats support this. The GeoJSON format does use this property when writing geometries.decimalsnumber | undefined <optional>
Maximum number of decimal places for coordinates. Coordinates are stored internally as floats, but floating-point arithmetic can create coordinates with a large number of decimal places, not generally wanted on output. Set a number here to round coordinates. Can also be used to ensure that coordinates read in can be written back out with the same number of decimals. Default is no rounding.
OpenLayers