Geoportal Extension for OpenLayers API Reference

Class: KML

Extended Styles KML format to export (internal use only !)

INFO
only ol.Control is a user-extendable class.
Everything else requires integration with the original openlayers source and a new ol.js
to be built with your new classes incorporated.

SPEC
cf. https://developers.google.com/kml/forum/advanced

ISSUES
cf. https://github.com/openlayers/openlayers/issues/4829
cf. https://github.com/openlayers/openlayers/issues/4460
cf. https://github.com/openlayers/openlayers/pull/5590
cf. https://github.com/openlayers/openlayers/issues/5229
cf. https://github.com/openlayers/openlayers/issues/3371

new KML(options)

OpenLayers/Formats/KML.js, line 32
Name Type Description
options Object

Options

Extends

  • ol.format.KML

Members

constructor

Constructor (alias)

En lecture, on surcharge la méthode readFeatures.
✔️ In : kml string + features du format original
✔️ Out : features étendus avec des styles, et des metadatas (name ou extendData)

on modifie les features du format original avec les fonctionnalités non gérées.

En écriture, on surcharge la méthode writeFearures.
✔️ In : kml du format original + features étendus
✔️ Out : kml étendu avec des styles, et des metadatas (name ou extendData)

on modifie le kml généré par le format original avec les fonctionnalités que nous avons ajoutées aux features.

Le principe
On parse le kml, et on lit (get) ou on ajoute (set) des fonctionnalités.

Les getters vont lire le kml (ex. LabelExtendStyle), et ajouter le style ainsi que le nom du label dans le feature original.
getLabelIconStyle (appel des 2 fonctions suivantes)
getLabelExtendStyle (New)
getHotSpotIconStyle (Bug sur la lecture du hotspot)
getExtendData (New)

Les setters vont écrire dans le dom du kml original les fonctionnalités ajoutées dans les features.
setLabelExtendStyle (New)
setHotSpotIconStyle (Bug sur l'écriture du hotspot)
setNameData (Bug suppression de cette balise du format par défaut).

Methods

readFeatures(source, options){Array.<ol.Feature>}

OpenLayers/Formats/KML.js, line 586

Read Extend Styles for Features.
This function overloads ol.format.KML.readFeatures ...

Name Type Description
source Document | Node | ArrayBuffer | Object | String

Source.

options olx.format.ReadOptions optional

options.

See:
  • ol.format.KML.prototype.readFeatures

writeFeatures(features, options){String}

OpenLayers/Formats/KML.js, line 372

Write Extend Styles for Features.
This function overloads ol.format.KML.writeFeatures ...

Name Type Description
features Array.<Object>

Features.

options Object

Options.

See:
  • ol.format.KML.prototype.writeFeatures