Class KML

Hierarchy

KML
- KML

Index

Constructors

Properties

crossOrigin_ dataProjection defaultFeatureProjection extensions featureClass iconUrlFunction_ referrerPolicy_ source supportedMediaTypes writeStyles_

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_: string | null

`Protected`dataProjection

dataProjection: Projection | undefined

`Protected`defaultFeatureProjection

defaultFeatureProjection: Projection | undefined

extensions

extensions: any

`Protected`featureClass

featureClass: typeof Feature

iconUrlFunction_

iconUrlFunction_: IconUrlFunction

referrerPolicy_

referrerPolicy_: ReferrerPolicy | undefined

source

source: Document | Node | HTMLElement | null

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, { [x: string]: any }>[],
    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, { [x: string]: any }>[]
  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: WriteOptions | ReadOptions | undefined,
): WriteOptions | ReadOptions | undefined
Protected
Sets the dataProjection on the options, if no dataProjection is set.
Parameters
- options: WriteOptions | ReadOptions | undefined
  Options.
Returns WriteOptions | ReadOptions | undefined
Updated options.
Inherited from olKML.adaptOptions
- Defined in node_modules/ol/format/Feature.d.ts:254

`Protected`getReadOptions

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

`Abstract`getType

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

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:288

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:322

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:357

readFeature

readFeature(
source: any,
options?: ReadOptions,
): Feature<Geometry, { [x: string]: any }> | null
Read a single feature.
Parameters
- source: any
  Source.
- Optionaloptions: ReadOptions
  Read options.
Returns Feature<Geometry, { [x: string]: any }> | null
Feature.

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

readFeatureFromDocument

readFeatureFromDocument(
doc: Document,
options?: ReadOptions,
): Feature<Geometry, { [x: string]: any }> | null
Parameters
- doc: Document
  Document.
- Optionaloptions: ReadOptions
  Options.
Returns Feature<Geometry, { [x: string]: any }> | null
Feature.
Inherited from olKML.readFeatureFromDocument
- Defined in node_modules/ol/format/XMLFeature.d.ts:34

readFeatureFromNode

readFeatureFromNode(
node: Element,
options?: ReadOptions,
): Feature<Geometry, { [x: string]: any }> | null
Parameters
- node: Element
  Node.
- Optionaloptions: ReadOptions
  Options.
Returns Feature<Geometry, { [x: string]: any }> | null
Feature.
Inherited from olKML.readFeatureFromNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:40

readFeatures

readFeatures(
source: Document | Node,
options: any,
): Feature<Geometry, { [x: string]: any }>[]
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, { [x: string]: any }>[]
Features.

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

`Protected`readFeaturesFromDocument

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

`Protected` `Abstract`readFeaturesFromNode

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

`Abstract`readGeometry

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

`Protected`readGeometryFromDocument

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

`Protected`readGeometryFromNode

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

readName

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

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

readNameFromDocument

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

readNameFromNode

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

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:241

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:246

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:251

`Abstract`readProjection

readProjection(source: any): Projection | undefined
Read the projection from a source.
Parameters
- source: any
  Source.
Returns Projection | undefined
Projection.
Inherited from olKML.readProjection
- Defined in node_modules/ol/format/Feature.d.ts:294

`Protected`readProjectionFromDocument

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

`Protected`readProjectionFromNode

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

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:259

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:264

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:270

readRootExtensions

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

writeFeature

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

`Protected`writeFeatureNode

writeFeatureNode(
feature: Feature<Geometry, { [x: string]: any }>,
options?: WriteOptions,
): Node | null
Protected
Parameters
- feature: Feature<Geometry, { [x: string]: any }>
  Feature.
- Optionaloptions: WriteOptions
  Options.
Returns Node | null
Node.
Inherited from olKML.writeFeatureNode
- Defined in node_modules/ol/format/XMLFeature.d.ts:97

writeFeatures

writeFeatures(
features: Feature<Geometry, { [x: string]: any }>[],
options: any,
): string
Write Extend for Features. This function overloads ol.format.KML.writeFeatures ...
Parameters
- features: Feature<Geometry, { [x: string]: any }>[]
  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, { [x: string]: any }>[],
options?: WriteOptions,
): Node
Encode an array of features in the KML format as an XML node. GeometryCollections, MultiPoints, MultiLineStrings, and MultiPolygons are output as MultiGeometries.
Parameters
- features: Feature<Geometry, { [x: string]: any }>[]
  Features.
- Optionaloptions: WriteOptions
  Options.
Returns Node
Node.

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

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:122

writeGeometryNode

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

Class KML

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optionalextensions?: any

Returns KML

Properties

crossOrigin_

ProtecteddataProjection

ProtecteddefaultFeatureProjection

extensions

ProtectedfeatureClass

iconUrlFunction_

referrerPolicy_

source

supportedMediaTypes

writeStyles_

Methods

_processKml

Parameters

Returns void

Example

_writeRootExtensions

Parameters

Returns void

ProtectedadaptOptions

Parameters

Returns WriteOptions | ReadOptions | undefined

ProtectedgetReadOptions

Parameters

Returns ReadOptions | undefined

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, { [x: string]: any }> | null

Api

readFeatureFromDocument

Parameters

Returns Feature<Geometry, { [x: string]: any }> | null

readFeatureFromNode

Parameters

Returns Feature<Geometry, { [x: string]: any }> | null

`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

`Abstract`readProjection

`Protected`readProjectionFromDocument

`Protected`readProjectionFromNode

`Protected`writeFeatureNode