TopoJSON~TopoJSON

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

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

new TopoJSON(options) format/TopoJSON.js, line 57

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

Имя	Тип	Описание
`dataProjection`	ProjectionLike (по умолчанию 'EPSG:4326')	Проекция данных по умолчанию.
`layerName`	string \| undefined	Установите имя топологии TopoJSON `objects` для свойств функций с указанным именем. Это означает, что при установке в `'layer'`, топология, подобная { "type": "Topology", "objects": { "example": { "type": "GeometryCollection", "geometries": [] } } } приведет к функциям, у которых есть свойство `'layer'`, установленное в значение `'example'`. При отсутствии задания, свойство функциям не будет добавлено.
`layers`	Array.<string> \| undefined	Имена `objects` дочерних элементов топологии TopoJSON, из которых нужно читать функции. Если не указано, функции будут читаться из всех дочерних элементов.

dataProjection

ProjectionLike (по умолчанию 'EPSG:4326')

Проекция данных по умолчанию.

layerName

string | undefined

Установите имя топологии TopoJSON objects для свойств функций с указанным именем. Это означает, что при установке в 'layer', топология, подобная

{
  "type": "Topology",
  "objects": {
    "example": {
      "type": "GeometryCollection",
      "geometries": []
    }
  }
}

приведет к функциям, у которых есть свойство 'layer', установленное в значение 'example'. При отсутствии задания, свойство функциям не будет добавлено.

layers

Array.<string> | undefined

Имена objects дочерних элементов топологии TopoJSON, из которых нужно читать функции. Если не указано, функции будут читаться из всех дочерних элементов.

Расширяет

JSONFeature

Методы

readFeature(source, options){FeatureType | Array.<FeatureType>} inherited format/JSONFeature.js, строка 40

Чтение объекта. Работает только с одним объектом. Для чтения коллекции объектов используйте readFeatures.

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

source

ArrayBuffer | 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.<FeatureType>} inherited format/JSONFeature.js, строка 57

Чтение всех объектов. Работает как с одним объектом, так и с коллекцией объектов.

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

source

ArrayBuffer | Document | Element | Object | string

Источник.

options

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

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

Возвращаемое значение:

Объекты.

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

Чтение геометрии.

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

source

ArrayBuffer | Document | Element | Object | string

Источник.

options

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

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

Возвращаемое значение:

Геометрия.

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

Чтение проекции.

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

Возвращаемое значение:

Проекция.

writeFeature(feature, options){string} inherited format/JSONFeature.js, строка 144

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

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

feature

Признак

Признак.

options

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

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

Результат:

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

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

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

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

features

Массив<Признак>

Признаки.

options

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

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

Результат:

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

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

Закодировать геометрию в виде строки.

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

geometry

Геометрия

Геометрия.

options

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

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

Результат:

Закодированная геометрия.