KML~KML

import KML from 'ol/format/KML.js';

Формат объектов для чтения и записи данных в формате KML.

readFeature считывает первый объект из источника KML.

MultiGeometries преобразуются в GeometryCollections, если содержат геометрии разных типов, и в MultiPoint/MultiLineString/MultiPolygon, если все геометрии имеют один тип.

new KML(options) format/KML.js, line 438

Имя	Тип	Описание
`extractStyles`	boolean (по умолчанию true)	Извлекать стили из KML.
`showPointNames`	boolean (по умолчанию true)	Показывать названия в качестве подписей для меток, содержащих точки.
`defaultStyle`	Array<Style> \| undefined	Стиль по умолчанию. Стиль по умолчанию совпадает со стилем Google Earth.
`writeStyles`	boolean (по умолчанию true)	Записывать стили в KML.
`crossOrigin`	null \| string (по умолчанию 'anonymous')	Атрибут `crossOrigin` для загруженных изображений. Обратите внимание: для доступа к данным пикселей с помощью средства визуализации Canvas необходимо указать значение `crossOrigin`.
`referrerPolicy`	ReferrerPolicy \| undefined	Свойство `referrerPolicy` для загруженных изображений.
`iconUrlFunction`	IconUrlFunction \| undefined	Функция, которая принимает строку URL и возвращает строку URL. Может использоваться для изменения пути к значку или замены его URL-адресом данных, полученным из буфера массива KMZ.

Наследует

XMLFeature

Методы

readCamera(source){Array<KMLCamera>} format/KML.js, line 921

Считать камеры из KML.

Имя	Тип	Описание
`source`	Document \| Element \| string	Источник.

Возвращает:

Камеры.

readCameraFromNode(node){Array<KMLCamera>} format/KML.js, line 956

Имя	Тип	Описание
`node`	Element	Узел.

Возвращает:

Камеры.

readFeature(source, options){Feature} унаследован format/XMLFeature.js, line 45

Считать один объект.

Имя Тип Описание

source

Document | Element | Object | string

Источник.

options

Параметры чтения.

Имя	Тип	Описание
`dataProjection`	ProjectionLike \| undefined	Проекция считываемых данных. Если она не указана, проекция будет определена на основе данных (если это возможно) или будет назначена `dataProjection` формата (если задана). Если проекцию нельзя определить на основе данных и для формата не задана `dataProjection`, перепроецирование объектов выполняться не будет.
`extent`	Extent \| undefined	Размер экстента тайла в единицах карты для считываемого тайла. Он требуется только при чтении данных, где пиксели тайла используются в качестве единиц геометрии. Если этот параметр задан, необходимо предоставить `dataProjection`, где `TILE_PIXELS` — это `units`, а пиксельный экстент тайла — `extent`.
`featureProjection`	ProjectionLike \| undefined	Проекция геометрий объектов, созданных при чтении формата. Если она не указана, объекты будут возвращены в `dataProjection`.

Возвращает:

Объект.

readFeatures(source, options){Array<Feature>} унаследован format/XMLFeature.js, line 93

Считать все объекты из коллекции объектов.

Имя Тип Описание

source

Document | Element | Object | string

Источник.

options

Параметры.

Имя	Тип	Описание
`dataProjection`	ProjectionLike \| undefined	Проекция считываемых данных. Если она не указана, проекция будет определена на основе данных (если это возможно) или будет назначена `dataProjection` формата (если задана). Если проекцию нельзя определить на основе данных и для формата не задана `dataProjection`, перепроецирование объектов выполняться не будет.
`extent`	Extent \| undefined	Размер экстента тайла в единицах карты для считываемого тайла. Он требуется только при чтении данных, где пиксели тайла используются в качестве единиц геометрии. Если этот параметр задан, необходимо предоставить `dataProjection`, где `TILE_PIXELS` — это `units`, а пиксельный экстент тайла — `extent`.
`featureProjection`	ProjectionLike \| undefined	Проекция геометрий объектов, созданных при чтении формата. Если она не указана, объекты будут возвращены в `dataProjection`.

Возвращает:

Объекты.

readName(source){string | undefined} format/KML.js, line 713

Считать название из KML.

Имя	Тип	Описание
`source`	Document \| Element \| string	Источник.

Возвращает:

Название.

readNetworkLinks(source){Array.<Object>} format/KML.js, line 778

Считать сетевые ссылки из KML.

Имя	Тип	Описание
`source`	Document \| Element \| string	Источник.

Возвращает:

Сетевые ссылки.

readProjection(source){Projection} унаследован format/XMLFeature.js, line 194

Считать проекцию из источника.

Имя	Тип	Описание
`source`	Document \| Element \| Object \| string	Источник.

Возвращает:

Проекция.

readRegion(source){Array.<Object>} format/KML.js, line 848

Считать регионы из KML.

Имя	Тип	Описание
`source`	Document \| Element \| string	Источник.

Возвращает:

Регионы.

readRegionFromNode(node){Array.<Object>} format/KML.js, line 883

Имя	Тип	Описание
`node`	Element	Узел.

Возвращает:

Регион.

writeFeatures(features, options){string} унаследован format/XMLFeature.js, line 258

Закодировать массив объектов в виде строки.

Имя Тип Описание

features

Array<Feature>

Объекты.

options

Параметры записи.

Имя	Тип	Описание
`dataProjection`	ProjectionLike \| undefined	Проекция записываемых данных. Если она не указана, назначается `dataProjection` формата (если задана). Если для формата не задана `dataProjection`, объекты будут возвращены в `featureProjection`.
`featureProjection`	ProjectionLike \| undefined	Проекция геометрий объектов, которые будут сериализованы средством записи формата. Если она не указана, предполагается, что геометрии заданы в `dataProjection`, если она установлена; иначе говоря, они не преобразуются.
`rightHanded`	boolean \| undefined	При записи геометрий соблюдать правило правой руки для ориентации линейных колец. Это означает, что внешние кольца полигонов будут обходиться против часовой стрелки, а внутренние — по часовой стрелке. По умолчанию координаты сериализуются в том виде, в каком они были заданы при создании. Если задано `true`, будет применено правило правой руки. Если задано `false`, будет применено правило левой руки (по часовой стрелке для внешних колец и против часовой стрелки для внутренних). Обратите внимание: не все форматы поддерживают эту функцию. Формат GeoJSON использует это свойство при записи геометрий.
`decimals`	number \| undefined	Максимальное количество знаков после запятой для координат. Координаты хранятся внутри в виде чисел с плавающей запятой, однако арифметика с плавающей запятой может приводить к появлению координат с большим количеством знаков после запятой, которые обычно не нужны в выходных данных. Укажите здесь число, чтобы округлять координаты. Также это можно использовать, чтобы гарантировать запись считанных координат с тем же количеством десятичных знаков. По умолчанию округление не выполняется.

Возвращает:

Результат.

writeFeaturesNode(features, options){Node} format/KML.js, line 989

Закодировать массив объектов в формате KML как узел XML. GeometryCollections, MultiPoints, MultiLineStrings и MultiPolygons выводятся как MultiGeometries.

Имя Тип Описание

features

Array<Feature>

Объекты.

options

Параметры.

Имя	Тип	Описание
`dataProjection`	ProjectionLike \| undefined	Проекция записываемых данных. Если она не указана, назначается `dataProjection` формата (если задана). Если для формата не задана `dataProjection`, объекты будут возвращены в `featureProjection`.
`featureProjection`	ProjectionLike \| undefined	Проекция геометрий объектов, которые будут сериализованы средством записи формата. Если она не указана, предполагается, что геометрии заданы в `dataProjection`, если она установлена; иначе говоря, они не преобразуются.
`rightHanded`	boolean \| undefined	При записи геометрий соблюдать правило правой руки для ориентации линейных колец. Это означает, что внешние кольца полигонов будут обходиться против часовой стрелки, а внутренние — по часовой стрелке. По умолчанию координаты сериализуются в том виде, в каком они были заданы при создании. Если задано `true`, будет применено правило правой руки. Если задано `false`, будет применено правило левой руки (по часовой стрелке для внешних колец и против часовой стрелки для внутренних). Обратите внимание: не все форматы поддерживают эту функцию. Формат GeoJSON использует это свойство при записи геометрий.
`decimals`	number \| undefined	Максимальное количество знаков после запятой для координат. Координаты хранятся внутри в виде чисел с плавающей запятой, однако арифметика с плавающей запятой может приводить к появлению координат с большим количеством знаков после запятой, которые обычно не нужны в выходных данных. Укажите здесь число, чтобы округлять координаты. Также это можно использовать, чтобы гарантировать запись считанных координат с тем же количеством десятичных знаков. По умолчанию округление не выполняется.

Возвращает:

Узел.