new ol.format.KML(opt_options)
| Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Options.
|
||||||||||||||||
Extends
Methods
-
Read the first feature from a KML source. MultiGeometries are converted into GeometryCollections if they are a mix of geometry types, and into MultiPoint/ MultiLineString/MultiPolygon if they are all of the same type.
Name Type Description sourceDocument | Node | Object | string Source.
optionsRead options.
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.Returns:
Feature.
-
Read all features from a KML source. MultiGeometries are converted into GeometryCollections if they are a mix of geometry types, and into MultiPoint/ MultiLineString/MultiPolygon if they are all of the same type.
Name Type Description sourceDocument | Node | Object | string Source.
optionsRead options.
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.Returns:
Features.
-
readName(source){string|undefined}
src/ol/format/kml.js, line 1889 -
Read the name of the KML.
Name Type Description sourceDocument | Node | string Souce.
Returns:
Name.
-
readNetworkLinks(source){Array.<Object>}
src/ol/format/kml.js, line 1957 -
Read the network links of the KML.
Name Type Description sourceDocument | Node | string Source.
Returns:
Network links.
-
Read the projection from a KML source.
Name Type Description sourceDocument | Node | Object | string Source.
Returns:
Projection.
-
readRegion(source){Array.<Object>}
src/ol/format/kml.js, line 2022 -
Read the regions of the KML.
Name Type Description sourceDocument | Node | string Source.
Returns:
Regions.
-
readRegionFromNode(node){Array.<Object>}
src/ol/format/kml.js, line 2058 -
Name Type Description nodeNode Node.
Returns:
Region.
-
writeFeatures(features, opt_options){string}
src/ol/format/kml.js, line 3057 -
Encode an array of features in the KML format. GeometryCollections, MultiPoints, MultiLineStrings, and MultiPolygons are output as MultiGeometries.
Name Type Description featuresArray.<ol.Feature> Features.
optionsOptions.
Name Type 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 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 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.
Returns:
Result.
-
writeFeaturesNode(features, opt_options){Node}
src/ol/format/kml.js, line 3070 -
Encode an array of features in the KML format as an XML node. GeometryCollections, MultiPoints, MultiLineStrings, and MultiPolygons are output as MultiGeometries.
Name Type Description featuresArray.<ol.Feature> Features.
optionsOptions.
Name Type 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 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 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.
Returns:
Node.
OpenLayers