GPX~GPX

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

Формат функций для чтения и записи данных в формате GPX.

Обратите внимание, что readFeature читает только первую функцию источника.

При чтении маршруты (<rte>) преобразуются в геометрии LineString, а треки (<trk>) — в MultiLineString. Любые свойства контрольных точек маршрутов и треков игнорируются.

При записи геометрии LineString выводятся в виде маршрутов (<rte>), а MultiLineString — в виде треков (<trk>).

new GPX(options) format/GPX.js, строка 206

Имя	Тип	Описание
`readExtensions`	функция \| undefined	Функция обратного вызова для обработки `extensions` узлов. Чтобы предотвратить утечки памяти, эта функция обратного вызова не должна хранить никаких ссылок на узел. Обратите внимание, что узел `extensions` не разрешен в GPX 1.0. Кроме того, обрабатываются только узлы `extensions` из `wpt`, `rte` и `trk`, так как они напрямую отображаются на функцию.

Расширяет

XMLFeature

Методы

readFeature(source, options){Feature} inherited format/XMLFeature.js, строка 45

Прочитать одну функцию.

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

source

Document | Element | Object | string

Источник.

options

Опции чтения.

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

Возвращает:

Функция.

readFeatures(source, options){Array<Feature>} inherited format/XMLFeature.js, строка 93

Прочитать все функции из набора функций.

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

source

Document | Element | Object | string

Источник.

options

Параметры.

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

Возвращает:

Функции.

readMetadata(source){GPXMetadata | null} format/GPX.js, строка 257

Читает тег метаданных файла GPX, читая среди прочего:

название и описание этого GPX
его автора
авторские права, связанные с этим файлом GPX

Возвращает null, если тег метаданных отсутствует (или предоставлен некорректный источник).

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

Возвращает:

Метаданные

readProjection(source){Projection} inherited format/XMLFeature.js, строка 194

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

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

Возвращает:

Проекция.

writeFeatures(features, options){string} inherited format/XMLFeature.js, строка 258

Кодирование массива объектов в строку.

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

features

Массив<Объект>

Объекты.

options

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

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

Возвращает:

Результат.

writeFeaturesNode(features, options){Node} format/GPX.js, строка 362

Кодирование массива объектов в формате GPX в качестве узла XML. Геометрии LineString выводятся как маршруты (<rte>), а MultiLineString как треки (<trk>).

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

features

Массив<Объект>

Объекты.

options

Параметры.

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

Возвращает:

Узел.