Namespace: format

Type Definitions

olx.format.GeoJSONOptions{Object} experimental

Properties:

Name	Type	Argument	Description
defaultDataProjection	ol.proj.ProjectionLike		Default data projection.
geometryName	string | undefined	<optional>	Geometry name to use when creating features.

olx.format.GMLOptions{Object} experimental

Properties:

Name	Type	Argument	Description
featureNS	string		Feature namespace.
featureType	string		Feature type to parse.
srsName	string		srsName to use when writing geometries.
surface	boolean | undefined	<optional>	Write gml:Surface instead of gml:Polygon elements. This also affects the elements in multi-part geometries. Default is false.
curve	boolean | undefined	<optional>	Write gml:Curve instead of gml:LineString elements. This also affects the elements in multi-part geometries. Default is false.
multiCurve	boolean | undefined	<optional>	Write gml:MultiCurve instead of gml:MultiLineString. Since the latter is deprecated in GML 3, the default is true.
multiSurface	boolean | undefined	<optional>	Write gml:multiSurface instead of gml:MultiPolygon. Since the latter is deprecated in GML 3, the default is true.
schemaLocation	string | undefined	<optional>	Optional schemaLocation to use when writing out the GML, this will override the default provided.

olx.format.GPXOptions{Object} experimental

Properties:

Name	Type	Description
readExtensions	function	Callback function to process extensions nodes. To prevent memory leaks, this callback function must not store any references to the node. Note that the extensions node is not allowed in GPX 1.0. Moreover, only extensions nodes from wpt, rte and trk can be processed, as those are directly mapped to a feature.

olx.format.IGCOptions{Object} experimental

Properties:

Name	Type	Argument	Description
altitudeMode	ol.format.IGCZ | undefined	<optional>	Altitude mode. Possible values are barometric, gps, and none. Default is none.

olx.format.KMLOptions{Object} experimental

Properties:

Name	Type	Argument	Description
extractStyles	boolean | undefined	<optional>	Extract styles from the KML. Default is true.
defaultStyle	Array.<ol.style.Style> | undefined	<optional>	Default style. The default default style is the same as Google Earth.

olx.format.PolylineOptions{Object} experimental

Properties:

Name	Type	Description
factor	number	The factor by which the coordinates values will be scaled. Default is 1e5.

olx.format.ReadOptions{Object} experimental

Properties:

Name	Type	Argument	Description
dataProjection	ol.proj.ProjectionLike | undefined	<optional>	Projection of the data we are reading. If not provided, the projection will be derived from the data (where possible) or the defaultDataProjection of the format is assigned (where set). If the projection can not be derived from the data and if no defaultDataProjection is set for a format, the features will not be reprojected.
featureProjection	ol.proj.ProjectionLike | undefined	<optional>	Projection of the feature geometries created by the format reader. If not provided, features will be returned in the dataProjection.

olx.format.TopoJSONOptions{Object} experimental

Properties:

Name	Type	Description
defaultDataProjection	ol.proj.ProjectionLike	Default data projection.

olx.format.WFSOptions{Object} experimental

Properties:

Name	Type	Argument	Description
featureNS	string		The namespace URI used for features.
featureType	string		The feature type to parse. Only used for read operations.
schemaLocation	string | undefined	<optional>	Optional schemaLocation to use for serialization, this will override the default.

olx.format.WFSWriteGetFeatureOptions{Object} experimental

Properties:

Name	Type	Argument	Description
featureNS	string		The namespace URI used for features.
featurePrefix	string		The prefix for the feature namespace.
featureTypes	Array.<string>		The feature type names.
srsName	string | undefined	<optional>	SRS name. No srsName attribute will be set on geometries when this is not provided.
handle	string | undefined	<optional>	Handle.
outputFormat	string | undefined	<optional>	Output format.
maxFeatures	number | undefined	<optional>	Maximum number of features to fetch.
geometryName	string | undefined	<optional>	Geometry name to use in a BBOX filter.
bbox	ol.Extent | undefined	<optional>	Extent to use for the BBOX filter.

olx.format.WFSWriteTransactionOptions{Object}

Properties:

Name	Type	Argument	Description
featureNS	string		The namespace URI used for features.
featurePrefix	string		The prefix for the feature namespace.
featureType	string		The feature type name.
srsName	string | undefined	<optional>	SRS name. No srsName attribute will be set on geometries when this is not provided.
handle	string | undefined	<optional>	Handle.
nativeElements	Array.<Object>		Native elements. Currently not supported.
gmlOptions	olx.format.GMLOptions | undefined	<optional>	GML options for the WFS transaction writer.

olx.format.WKTOptions{Object} experimental

Properties:

Name	Type	Argument	Description
splitCollection	boolean | undefined	<optional>	Whether to split GeometryCollections into multiple features on reading. Default is false.

olx.format.WriteOptions{Object} experimental

Properties:

Name	Type	Argument	Description
dataProjection	ol.proj.ProjectionLike | undefined	<optional>	Projection of the data we are writing. If not provided, the defaultDataProjection of the format is assigned (where set). If no defaultDataProjection is set for a format, the features will be returned in the featureProjection.
featureProjection	ol.proj.ProjectionLike		Projection of the feature geometries that will be serialized by the format writer.