Polyline~Polyline

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

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

При чтении функций предполагается, что координаты находятся в двух измерениях и в порядке [широта, долгота].

Поскольку источники полилиний содержат одну функцию, readFeatures вернёт функцию в массиве.

new Polyline(options) format/Polyline.js, строка 34

Имя	Тип	Описание
`factor`	число (по умолчанию 1e5)	Множитель, с которым будут масштабироваться значения координат.
`geometryLayout`	GeometryLayout (по умолчанию 'XY')	Макет геометрий функций, созданных читателем формата.

Расширяет

TextFeature

Методы

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

Прочитать объект из источника.

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

source

Document | Element | Object | string

Источник.

options

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

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

Возвращает:

Объект.

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

Прочитать объекты из источника.

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

source

Document | Element | Object | string

Источник.

options

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

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

Возвращает:

Объекты.

readGeometry(source, options){Geometry} inherited format/TextFeature.js, строка 91

Прочитать геометрию из источника.

...

readProjection(source){Projection | undefined} inherited ...

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

...

writeFeature(feature, options){string} inherited ...

END_OF_DOCUMENT_MARKER

Кодировать атрибут в виде строки.

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

feature

Признак

Признак.

options

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

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

Возвращает:

Закодированный признак.

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

Кодировать массив признаков в строку.

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

features

Array<Признак>

Признаки.

options

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

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

Возвращает:

Закодированные признаки.

writeGeometry(geometry, options){string} inherited format/TextFeature.js, строка 187

Записать одну геометрию.

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

geometry

Геометрия

Геометрия.

options

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

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

Возвращает:

Геометрия.