WKB~WKB

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

Формат геометрии для чтения и записи данных в формате Well-Known Binary (WKB). Также поддерживает формат Extended Well-Known Binary (EWKB), используемый, например, в PostGIS.

new WKB(options) format/WKB.js, line 701

Имя	Тип	Описание
`splitCollection`	boolean (по умолчанию false)	Разбивать ли GeometryCollections на несколько объектов при чтении.
`hex`	boolean (по умолчанию true)	Возвращать строку в формате шестнадцатеричного кода вместо ArrayBuffer для вывода. Это также используется в качестве подсказки для внутреннего определения, следует ли загружать содержимое как текст или ArrayBuffer при чтении.
`littleEndian`	boolean (по умолчанию true)	Использовать порядок байтов littleEndian для вывода.
`ewkb`	boolean (по умолчанию true)	Использовать формат EWKB для вывода.
`geometryLayout`	GeometryLayout (по умолчанию null)	Использовать определенный порядок координат для вывода объектов (null: автоматическое определение)
`nodataZ`	number (по умолчанию 0)	Если порядок координат `geometryLayout` не совпадает с геометрией для вывода, это значение используется для заполнения пропущенного значения координаты Z.
`nodataM`	number (по умолчанию 0)	Если порядок координат `geometryLayout` не совпадает с геометрией для вывода, это значение используется для заполнения пропущенного значения координаты M.
`srid`	number \| boolean (по умолчанию true)	SRID для вывода. Укажите целое значение, чтобы принудительно установить значение как SRID. Укажите `true`, чтобы извлечь из `dataProjection`. `false` для подавления вывода. Этот параметр применяется только тогда, когда `ewkb` равен `true`.

Расширяет

FeatureFormat

Методы

readFeature(source, options){Feature} format/WKB.js, line 742

Чтение одной фичи из источника.

Name Type Description

source

string | ArrayBuffer | ArrayBufferView

Источник.

options

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

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

Returns:

Feature.

readFeatures(source, options){Array<Feature>} format/WKB.js, line 757

Чтение всех фич из источника.

Name Type Description

source

string | ArrayBuffer | ArrayBufferView

Источник.

options

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

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

Returns:

Features.

readGeometry(source, options){Geometry} format/WKB.js, line 777

Чтение одной геометрии из источника.

Name Type Description

source

string | ArrayBuffer | ArrayBufferView

Источник.

options

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

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

Returns:

Geometry.

readProjection(source){Projection | undefined} format/WKB.js, line 801

Чтение проекции из источника.

Name	Type	Description
`source`	string \| ArrayBuffer \| ArrayBufferView	Источник.

Returns:

Projection.

writeFeature(feature, options){string | ArrayBuffer} format/WKB.js, line 825

Кодировать объект в этом формате.

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

feature

Объект

Объект.

options

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

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

Возвращает:

Результат.

writeFeatures(features, options){string | ArrayBuffer} format/WKB.js, строка 838

Кодировать массив объектов в этом формате.

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

features

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

Объекты.

options

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

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

Возвращает:

Результат.

writeGeometry(geometry, options){string | ArrayBuffer} format/WKB.js, строка 854

Записать отдельный объект в этом формате.

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

geometry

Геометрия

Геометрия.

options

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

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

Возвращает:

Результат.