Class KML

Hierarchy

KML
- KML

Constructors

constructor

new KML(options: { extensions?: any }): KML
Parameters
- options: { extensions?: any }
  Options
  - Optionalextensions?: any
    Add properties to file root
Returns KML
Overrides olKML.constructor
- Defined in src/packages/Formats/KML.js:52

Properties

crossOrigin_

crossOrigin_: null | string

`Protected`dataProjection

dataProjection: undefined | Projection

`Protected`defaultFeatureProjection

defaultFeatureProjection: undefined | Projection

extensions

extensions: any

`Protected`featureClass

featureClass: typeof Feature

iconUrlFunction_

iconUrlFunction_: IconUrlFunction

source

source: null | Document | Node | HTMLElement

supportedMediaTypes

supportedMediaTypes: string[]

A list media types supported by the format in descending order of preference.

writeStyles_

writeStyles_: boolean

Methods

_processKml

_processKml(
    kmlNode: HTMLElement,
    features: Feature<Geometry>[],
    process: any,
): void
Fonction de lecture du KML avec fonction de traitement en fonction du type PlaceMark (Label ou Marker). Les traitements sont de 2 types :
- creation de styles étendus ou correctifs sur le KML
- ajout de styles étendus sur les features
Parameters
- kmlNode: HTMLElement
  kml nodes
- features: Feature<Geometry>[]
  features
- process: any
  process
Returns void
Example
```
// ajoute des fonctionnalités dans le KML
_processKml(kmlDoc, {
  labelStyle : createStyleLabel,
  iconStyle  : createStyleIcon
});

// lit des fonctionnalités du KML non impl. par OpenLayers
_processKml(kmlNode, {
  labelStyle : getStyleToFeatureLabel,
  iconStyle  : getStyleToFeatureIcon,
  extendedData : getExtendedData
});
```
- Defined in src/packages/Formats/KML.js:135

_writeRootExtensions

_writeRootExtensions(kmlNode: any, extensions: any): void
...
Parameters
- kmlNode: any
  ...
- extensions: any
  ...
Returns void
- Defined in src/packages/Formats/KML.js:744

`Protected`adaptOptions

adaptOptions(
options: undefined | WriteOptions | ReadOptions,
): undefined | WriteOptions | ReadOptions
Protected
Sets the dataProjection on the options, if no dataProjection is set.
Parameters
- options: undefined | WriteOptions | ReadOptions
  Options.
Returns undefined | WriteOptions | ReadOptions
Updated options.
Inherited from olKML.adaptOptions
- Defined in node_modules/ol/format/Feature.d.ts:252

`Protected`getReadOptions

getReadOptions(source: any, options?: ReadOptions): undefined | ReadOptions
Protected
Adds the data projection to the read options.
Parameters
- source: any
  Source.
- Optionaloptions: ReadOptions
  Options.
Returns undefined | ReadOptions
Options.
Inherited from olKML.getReadOptions
- Defined in node_modules/ol/format/Feature.d.ts:242

`Abstract`getType

getType(): Type
Returns Type
The format type.
Inherited from olKML.getType
- Defined in node_modules/ol/format/Feature.d.ts:257

readCamera

readCamera(
    source: string | Document | Element,
): {
    Altitude?: number;
    AltitudeMode?: string;
    Heading?: number;
    Latitude?: number;
    Longitude?: number;
    Roll?: number;
    Tilt?: number;
}[]
Read the cameras of the KML.
Parameters
- source: string | Document | Element
  Source.
Returns {
    Altitude?: number;
    AltitudeMode?: string;
    Heading?: number;
    Latitude?: number;
    Longitude?: number;
    Roll?: number;
    Tilt?: number;
}[]
Cameras.
- OptionalAltitude?: number
  Altitude of the camera.
- OptionalAltitudeMode?: string
  Floor-related altitude mode.
- OptionalHeading?: number
  Horizontal camera rotation.
- OptionalLatitude?: number
  Latitude of the camera.
- OptionalLongitude?: number
  Longitude of the camera.
- OptionalRoll?: number
  Vertical camera rotation.
- OptionalTilt?: number
  Lateral camera rotation.
Api
Inherited from olKML.readCamera
- Defined in node_modules/ol/format/KML.d.ts:268

readCameraFromDocument

readCameraFromDocument(
    doc: Document,
): {
    Altitude?: number;
    AltitudeMode?: string;
    Heading?: number;
    Latitude?: number;
    Longitude?: number;
    Roll?: number;
    Tilt?: number;
}[]
Parameters
- doc: Document
  Document.
Returns {
    Altitude?: number;
    AltitudeMode?: string;
    Heading?: number;
    Latitude?: number;
    Longitude?: number;
    Roll?: number;
    Tilt?: number;
}[]
Cameras.
- OptionalAltitude?: number
  Altitude of the camera.
- OptionalAltitudeMode?: string
  Floor-related altitude mode.
- OptionalHeading?: number
  Horizontal camera rotation.
- OptionalLatitude?: number
  Latitude of the camera.
- OptionalLongitude?: number
  Longitude of the camera.
- OptionalRoll?: number
  Vertical camera rotation.
- OptionalTilt?: number
  Lateral camera rotation.
Inherited from olKML.readCameraFromDocument
- Defined in node_modules/ol/format/KML.d.ts:302

readCameraFromNode

readCameraFromNode(
    node: Element,
): {
    Altitude?: number;
    AltitudeMode?: string;
    Heading?: number;
    Latitude?: number;
    Longitude?: number;
    Roll?: number;
    Tilt?: number;
}[]
Parameters
- node: Element
  Node.
Returns {
    Altitude?: number;
    AltitudeMode?: string;
    Heading?: number;
    Latitude?: number;
    Longitude?: number;
    Roll?: number;
    Tilt?: number;
}[]
Cameras.
- OptionalAltitude?: number
  Altitude of the camera.
- OptionalAltitudeMode?: string
  Floor-related altitude mode.
- OptionalHeading?: number
  Horizontal camera rotation.
- OptionalLatitude?: number
  Latitude of the camera.
- OptionalLongitude?: number
  Longitude of the camera.
- OptionalRoll?: number
  Vertical camera rotation.
- OptionalTilt?: number
  Lateral camera rotation.
Api
Inherited from olKML.readCameraFromNode
- Defined in node_modules/ol/format/KML.d.ts:337

readFeature

readFeature(source: any, options?: ReadOptions): Feature<Geometry>
Read a single feature.
Parameters
- source: any
  Source.
- Optionaloptions: ReadOptions
  Read options.
Returns Feature<Geometry>
Feature.

Api
Inherited from olKML.readFeature
- Defined in node_modules/ol/format/XMLFeature.d.ts:26

readFeatureFromDocument

readFeatureFromDocument(doc: Document, options?: ReadOptions): Feature<Geometry>
Parameters
- doc: Document
  Document.
- Optionaloptions: ReadOptions
  Options.
Returns Feature<Geometry>
Feature.
Inherited from olKML.readFeatureFromDocument
- Defined in node_modules/ol/format/XMLFeature.d.ts:32

readFeatureFromNode

readFeatureFromNode(node: Element, options?: ReadOptions): Feature<Geometry>
Parameters
- node: Element
  Node.
- Optionaloptions: ReadOptions
  Options.
Returns Feature<Geometry>
Feature.
Inherited from olKML.readFeatureFromNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:38

readFeatures

readFeatures(source: Document | Node, options: any): Feature<Geometry>[]
Read Extend for Features. This function overloads ol.format.KML.readFeatures ...
Parameters
- source: Document | Node
  Source.
- options: any
  options. see olx.format.ReadOptions
Returns Feature<Geometry>[]
Features.

See
olKML#readFeatures
Overrides olKML.readFeatures
- Defined in src/packages/Formats/KML.js:771

`Protected`readFeaturesFromDocument

readFeaturesFromDocument(
doc: Document,
options?: ReadOptions,
): Feature<Geometry>[]
Protected
Parameters
- doc: Document
  Document.
- Optionaloptions: ReadOptions
  Options.
Returns Feature<Geometry>[]
Features.
Inherited from olKML.readFeaturesFromDocument
- Defined in node_modules/ol/format/XMLFeature.d.ts:45

`Protected` `Abstract`readFeaturesFromNode

readFeaturesFromNode(node: Element, options?: ReadOptions): Feature<Geometry>[]
Protected
Parameters
- node: Element
  Node.
- Optionaloptions: ReadOptions
  Options.
Returns Feature<Geometry>[]
Features.
Inherited from olKML.readFeaturesFromNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:53

`Abstract`readGeometry

readGeometry(source: any, options?: ReadOptions): Geometry
Read a single geometry from a source.
Parameters
- source: any
  Source.
- Optionaloptions: ReadOptions
  Read options.
Returns Geometry
Geometry.
Inherited from olKML.readGeometry
- Defined in node_modules/ol/format/Feature.d.ts:284

`Protected`readGeometryFromDocument

readGeometryFromDocument(doc: Document, options?: ReadOptions): Geometry
Protected
Parameters
- doc: Document
  Document.
- Optionaloptions: ReadOptions
  Options.
Returns Geometry
Geometry.
Inherited from olKML.readGeometryFromDocument
- Defined in node_modules/ol/format/XMLFeature.d.ts:60

`Protected`readGeometryFromNode

readGeometryFromNode(node: Element, options?: ReadOptions): Geometry
Protected
Parameters
- node: Element
  Node.
- Optionaloptions: ReadOptions
  Options.
Returns Geometry
Geometry.
Inherited from olKML.readGeometryFromNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:67

readName

readName(source: string | Document | Element): undefined | string
Read the name of the KML.
Parameters
- source: string | Document | Element
  Source.
Returns undefined | string
Name.

Api
Inherited from olKML.readName
- Defined in node_modules/ol/format/KML.d.ts:203

readNameFromDocument

readNameFromDocument(doc: Document): undefined | string
Parameters
- doc: Document
  Document.
Returns undefined | string
Name.
Inherited from olKML.readNameFromDocument
- Defined in node_modules/ol/format/KML.d.ts:208

readNameFromNode

readNameFromNode(node: Element): undefined | string
Parameters
- node: Element
  Node.
Returns undefined | string
Name.
Inherited from olKML.readNameFromNode
- Defined in node_modules/ol/format/KML.d.ts:213

readNetworkLinks

readNetworkLinks(source: string | Document | Element): any[]
Read the network links of the KML.
Parameters
- source: string | Document | Element
  Source.
Returns any[]
Network links.

Api
Inherited from olKML.readNetworkLinks
- Defined in node_modules/ol/format/KML.d.ts:221

readNetworkLinksFromDocument

readNetworkLinksFromDocument(doc: Document): any[]
Parameters
- doc: Document
  Document.
Returns any[]
Network links.
Inherited from olKML.readNetworkLinksFromDocument
- Defined in node_modules/ol/format/KML.d.ts:226

readNetworkLinksFromNode

readNetworkLinksFromNode(node: Element): any[]
Parameters
- node: Element
  Node.
Returns any[]
Network links.
Inherited from olKML.readNetworkLinksFromNode
- Defined in node_modules/ol/format/KML.d.ts:231

readProjection

readProjection(source: any): Projection
Read the projection from the source.
Parameters
- source: any
  Source.
Returns Projection
Projection.

Api
Inherited from olKML.readProjection
- Defined in node_modules/ol/format/XMLFeature.d.ts:76

`Protected`readProjectionFromDocument

readProjectionFromDocument(doc: Document): Projection
Protected
Parameters
- doc: Document
  Document.
Returns Projection
Projection.
Inherited from olKML.readProjectionFromDocument
- Defined in node_modules/ol/format/XMLFeature.d.ts:82

`Protected`readProjectionFromNode

readProjectionFromNode(node: Element): Projection
Protected
Parameters
- node: Element
  Node.
Returns Projection
Projection.
Inherited from olKML.readProjectionFromNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:88

readRegion

readRegion(source: string | Document | Element): any[]
Read the regions of the KML.
Parameters
- source: string | Document | Element
  Source.
Returns any[]
Regions.

Api
Inherited from olKML.readRegion
- Defined in node_modules/ol/format/KML.d.ts:239

readRegionFromDocument

readRegionFromDocument(doc: Document): any[]
Parameters
- doc: Document
  Document.
Returns any[]
Region.
Inherited from olKML.readRegionFromDocument
- Defined in node_modules/ol/format/KML.d.ts:244

readRegionFromNode

readRegionFromNode(node: Element): any[]
Parameters
- node: Element
  Node.
Returns any[]
Region.

Api
Inherited from olKML.readRegionFromNode
- Defined in node_modules/ol/format/KML.d.ts:250

readRootExtensions

readRootExtensions(key: any): any
...
Parameters
- key: any
  ...
Returns any
json
- Defined in src/packages/Formats/KML.js:1275

writeFeature

writeFeature(feature: Feature<Geometry>, options?: WriteOptions): string
Encode a feature as string.
Parameters
- feature: Feature<Geometry>
  Feature.
- Optionaloptions: WriteOptions
  Write options.
Returns string
Encoded feature.
Inherited from olKML.writeFeature
- Defined in node_modules/ol/format/XMLFeature.d.ts:97

`Protected`writeFeatureNode

writeFeatureNode(feature: Feature<Geometry>, options?: WriteOptions): Node
Protected
Parameters
- feature: Feature<Geometry>
  Feature.
- Optionaloptions: WriteOptions
  Options.
Returns Node
Node.
Inherited from olKML.writeFeatureNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:104

writeFeatures

writeFeatures(features: Feature<Geometry>[], options: any): string
Write Extend for Features. This function overloads ol.format.KML.writeFeatures ...
Parameters
- features: Feature<Geometry>[]
  Features.
- options: any
  Options.
Returns string
kml string formatted

See
olKML#writeFeatures
Overrides olKML.writeFeatures
- Defined in src/packages/Formats/KML.js:346

writeFeaturesNode

writeFeaturesNode(features: Feature<Geometry>[], options?: WriteOptions): Node
Parameters
- features: Feature<Geometry>[]
  Features.
- Optionaloptions: WriteOptions
  Options.
Returns Node
Node.
Inherited from olKML.writeFeaturesNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:120

writeGeometry

writeGeometry(geometry: Geometry, options?: WriteOptions): string
Encode a geometry as string.
Parameters
- geometry: Geometry
  Geometry.
- Optionaloptions: WriteOptions
  Write options.
Returns string
Encoded geometry.
Inherited from olKML.writeGeometry
- Defined in node_modules/ol/format/XMLFeature.d.ts:129

writeGeometryNode

writeGeometryNode(geometry: Geometry, options?: WriteOptions): Node
Parameters
- geometry: Geometry
  Geometry.
- Optionaloptions: WriteOptions
  Options.
Returns Node
Node.
Inherited from olKML.writeGeometryNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:135

Class KML

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optionalextensions?: any

Returns KML

Properties

crossOrigin_

ProtecteddataProjection

ProtecteddefaultFeatureProjection

extensions

ProtectedfeatureClass

iconUrlFunction_

source

supportedMediaTypes

writeStyles_

Methods

_processKml

Parameters

Returns void

Example

_writeRootExtensions

Parameters

Returns void

ProtectedadaptOptions

Parameters

Returns undefined | WriteOptions | ReadOptions

ProtectedgetReadOptions

Parameters

Returns undefined | ReadOptions

AbstractgetType

Returns Type

readCamera

Parameters

Returns { Altitude?: number; AltitudeMode?: string; Heading?: number; Latitude?: number; Longitude?: number; Roll?: number; Tilt?: number;}[]

OptionalAltitude?: number

OptionalAltitudeMode?: string

OptionalHeading?: number

OptionalLatitude?: number

OptionalLongitude?: number

OptionalRoll?: number

OptionalTilt?: number

Api

readCameraFromDocument

Parameters

Returns { Altitude?: number; AltitudeMode?: string; Heading?: number; Latitude?: number; Longitude?: number; Roll?: number; Tilt?: number;}[]

OptionalAltitude?: number

OptionalAltitudeMode?: string

OptionalHeading?: number

OptionalLatitude?: number

OptionalLongitude?: number

OptionalRoll?: number

OptionalTilt?: number

readCameraFromNode

Parameters

Returns { Altitude?: number; AltitudeMode?: string; Heading?: number; Latitude?: number; Longitude?: number; Roll?: number; Tilt?: number;}[]

OptionalAltitude?: number

OptionalAltitudeMode?: string

OptionalHeading?: number

OptionalLatitude?: number

OptionalLongitude?: number

OptionalRoll?: number

OptionalTilt?: number

Api

readFeature

Parameters

Returns Feature<Geometry>

Api

readFeatureFromDocument

Parameters

Returns Feature<Geometry>

readFeatureFromNode

Parameters

Returns Feature<Geometry>

readFeatures

`Optional`extensions?: any

`Protected`dataProjection

`Protected`defaultFeatureProjection

`Protected`featureClass

`Protected`adaptOptions

`Protected`getReadOptions

`Abstract`getType

Returns {
Altitude?: number;
AltitudeMode?: string;
Heading?: number;
Latitude?: number;
Longitude?: number;
Roll?: number;
Tilt?: number;
}[]

`Optional`Altitude?: number

`Optional`AltitudeMode?: string

`Optional`Heading?: number

`Optional`Latitude?: number

`Optional`Longitude?: number

`Optional`Roll?: number

`Optional`Tilt?: number

Returns {
Altitude?: number;
AltitudeMode?: string;
Heading?: number;
Latitude?: number;
Longitude?: number;
Roll?: number;
Tilt?: number;
}[]

`Optional`Altitude?: number

`Optional`AltitudeMode?: string

`Optional`Heading?: number

`Optional`Latitude?: number

`Optional`Longitude?: number

`Optional`Roll?: number

`Optional`Tilt?: number

Returns {
Altitude?: number;
AltitudeMode?: string;
Heading?: number;
Latitude?: number;
Longitude?: number;
Roll?: number;
Tilt?: number;
}[]

`Optional`Altitude?: number

`Optional`AltitudeMode?: string

`Optional`Heading?: number

`Optional`Latitude?: number

`Optional`Longitude?: number

`Optional`Roll?: number

`Optional`Tilt?: number

`Protected`readFeaturesFromDocument

`Protected` `Abstract`readFeaturesFromNode

`Abstract`readGeometry

`Protected`readGeometryFromDocument

`Protected`readGeometryFromNode

`Protected`readProjectionFromDocument

`Protected`readProjectionFromNode

`Protected`writeFeatureNode