Spec-Zone.ru › OpenLayers

ol/format/GeoJSON~GeoJSON


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

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

new GeoJSON(options)

format/GeoJSON.js, строка 61
Имя Тип Описание
dataProjection ProjectionLike (по умолчанию 'EPSG:4326')

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

featureProjection ProjectionLike | undefined

Проекция для объектов, читаемых или записываемых в формате. Параметры, переданные методам read или write, будут иметь приоритет.

geometryName string | undefined

Имя геометрии для использования при создании объектов.

extractGeometryName boolean (по умолчанию false)

Некоторые поставщики GeoJSON включают поле geometry_name в GeoJSON-объекте. Если установлено значение true, читатель GeoJSON будет искать это поле для установки имени геометрии. Если оба этих поля установлены в значение true и предоставлено значение geometryName, значение geometryName будет иметь приоритет.

featureClass FeatureToFeatureClass<FeatureType> | undefined

Класс объектов, используемый при чтении объектов. По умолчанию Feature. Если производительность является главным фактором, а объекты не будут изменены или возвращены через формат, рассмотрите использование RenderFeature.

Расширяет

  • JSONFeature

Методы

readFeature(source, options){FeatureType | Array.<FeatureType>} inherited

format/JSONFeature.js, line 40

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

Имя Тип Описание
source ArrayBuffer | Document | Element | Object | string

Источник.

options

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

Имя Тип Описание
dataProjection ProjectionLike | undefined

Проекция данных. Если не указана, она будет определена из данных (если возможно) или задана по умолчанию (если задана). Если проекция не может быть определена из данных и не задана по умолчанию, объекты не будут перепроектированы.

extent Extent | undefined

Охватываемый прямоугольник в единицах карты. Требуется только при чтении данных с геометрией в единицах пикселей тайла. В таком случае необходим объект с TILE_PIXELS в качестве units и прямоугольником пикселей тайла как extent.

featureProjection ProjectionLike | undefined

Проекция геометрии объектов, полученных из формата. Если не указана, объекты будут возвращены в dataProjection.

Возвращаемое значение:
Объект.

readFeatures(source, options){Array.<FeatureType>} inherited

format/JSONFeature.js, line 57

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

Имя Тип Описание
source ArrayBuffer | Document | Element | Object | string

Источник.

options

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

Имя Тип Описание
dataProjection ProjectionLike | undefined

Проекция данных. Если не указана, она будет определена из данных (если возможно) или задана по умолчанию (если задана). Если проекция не может быть определена из данных и не задана по умолчанию, объекты не будут перепроектированы.

extent Extent | undefined

Охватываемый прямоугольник в единицах карты. Требуется только при чтении данных с геометрией в единицах пикселей тайла. В таком случае необходим объект с dataProjection в качестве units и прямоугольником пикселей тайла как extent.

featureProjection ProjectionLike | undefined

Проекция геометрии объектов, полученных из формата. Если не указана, объекты будут возвращены в dataProjection.

Возвращаемое значение:
Массив объектов.

readGeometry(source, options){Geometry} inherited

format/JSONFeature.js, line 95

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

Имя Тип Описание
source ArrayBuffer | Document | Element | Object | string

Источник.

options

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

Имя Тип Описание
dataProjection ProjectionLike | undefined

Проекция данных. Если не указана, она будет определена из данных (если возможно) или задана по умолчанию (если задана). Если проекция не может быть определена из данных и не задана по умолчанию, объекты не будут перепроектированы.

extent Extent | undefined

Охватываемый прямоугольник в единицах карты. Требуется только при чтении данных с геометрией в единицах пикселей тайла. В таком случае необходим объект с dataProjection в качестве units и прямоугольником пикселей тайла как extent.

featureProjection ProjectionLike | undefined

Проекция геометрии объектов, полученных из формата. Если не указана, объекты будут возвращены в dataProjection.

Возвращаемое значение:
Геометрия.

readProjection(source){Projection} inherited

format/JSONFeature.js, line 121

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

Имя Тип Описание
source ArrayBuffer | Document | Element | Object | string

Источник.

Возвращаемое значение:
Проекция.

writeFeature(feature, options){string} inherited

format/JSONFeature.js, line 144

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

Имя Тип Описание
feature Объект

Объект.

options

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

Имя Тип Описание
dataProjection Проекция | undefined

Проекция данных, которые мы записываем. Если не указано, используется проекция формата (если задана). Если для формата не задана проекция, объекты будут возвращены в проекции по умолчанию.

featureProjection Проекция | undefined

Проекция геометрий объектов, которые будут сериализованы записывающим объектом формата. Если не указано, геометрии предполагаются в проекции по умолчанию (если задана); другими словами, они не преобразуются.

rightHanded boolean | undefined

При записи геометрий следуйте правилу правой руки для ориентации линейных колец. Это означает, что у многоугольников будут внешние кольца против часовой стрелки и внутренние кольца по часовой стрелке. По умолчанию координаты сериализуются так, как они предоставлены при создании. Если значение true, будет применено правило правой руки. Если значение false, будет применено правило левой руки (по часовой стрелке для внешних и против часовой стрелки для внутренних колец). Обратите внимание, что не все форматы поддерживают это. Формат GeoJSON использует это свойство при записи геометрий.

decimals число | undefined

Максимальное количество десятичных знаков для координат. Координаты хранятся во внутреннем представлении как числа с плавающей точкой, но арифметика с плавающей точкой может создавать координаты с большим количеством десятичных знаков, что обычно нежелательно на выходе. Установите число здесь, чтобы округлить координаты. Это также можно использовать для обеспечения того, чтобы координаты, которые были прочитаны, можно было записать обратно с тем же количеством десятичных знаков. По умолчанию округление не применяется.

Возвращает:
Закодированный объект.

writeFeatureObject(feature, options){GeoJSONFeature}

format/GeoJSON.js, строка 237

Кодировать объект как GeoJSON Feature.

Имя Тип Описание
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

Максимальное количество десятичных знаков для координат. Координаты хранятся во внутреннем представлении как числа с плавающей точкой, но арифметика с плавающей точкой может создавать координаты с большим количеством десятичных знаков, что обычно нежелательно на выходе. Установите число здесь, чтобы округлить координаты. Это также можно использовать для обеспечения того, чтобы координаты, которые были прочитаны, можно было записать обратно с тем же количеством десятичных знаков. По умолчанию округление не применяется.

Возвращает:
Закодированные объекты.

writeFeaturesObject(features, options){GeoJSONFeatureCollection}

format/GeoJSON.js, строка 280

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

Имя Тип Описание
features Массив<Элемент>

Элементы.

options

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

Имя Тип Описание
dataProjection Проекция | undefined

Проекция данных, которые мы записываем. Если не указано, используется проекция формата (если задана). Если для формата не задана проекция, элементы будут возвращены в проекции по умолчанию.

featureProjection Проекция | undefined

Проекция геометрий элементов, которые будут сериализованы записывателем формата. Если не указано, геометрии предполагаются в проекции по умолчанию (если она задана); другими словами, они не преобразуются.

rightHanded boolean | undefined

При записи геометрий используется правило правой руки для ориентации замкнутых линий. Это означает, что у многоугольников будут внешние контуры по часовой стрелке и внутренние контуры против часовой стрелки. По умолчанию координаты сериализуются так, как они предоставлены при создании. Если задано значение `true`, применяется правило правой руки. Если задано значение `false`, применяется правило левой руки (по часовой стрелке для внешнего контура и против часовой стрелки для внутренних контуров). Обратите внимание, что не все форматы поддерживают это. Формат GeoJSON использует это свойство при записи геометрий.

decimals number | undefined

Максимальное количество десятичных знаков для координат. Координаты хранятся внутри как числа с плавающей запятой, но арифметика с плавающей запятой может создавать координаты с большим количеством десятичных знаков, что обычно нежелательно на выходе. Установите число здесь, чтобы округлить координаты. Также может быть использовано для обеспечения того, что введенные координаты могут быть записаны обратно с тем же количеством десятичных знаков. Значение по умолчанию — округление не применяется.

Возвращаемое значение:
Объект GeoJSON.

writeGeometry(geometry, options){string} inherited

format/JSONFeature.js, строка 190

Кодирование геометрии как строки.

Имя Тип Описание
geometry Геометрия

Геометрия.

options

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

Имя Тип Описание
dataProjection Проекция | undefined

Проекция данных, которые мы записываем. Если не указано, используется проекция формата (если задана). Если для формата не задана проекция, элементы будут возвращены в проекции по умолчанию.

featureProjection Проекция | undefined

Проекция геометрий элементов, которые будут сериализованы записывателем формата. Если не указано, геометрии предполагаются в проекции по умолчанию (если она задана); другими словами, они не преобразуются.

rightHanded boolean | undefined

При записи геометрий используется правило правой руки для ориентации замкнутых линий. Это означает, что у многоугольников будут внешние контуры по часовой стрелке и внутренние контуры против часовой стрелки. По умолчанию координаты сериализуются так, как они предоставлены при создании. Если задано значение `true`, применяется правило правой руки. Если задано значение `false`, применяется правило левой руки (по часовой стрелке для внешнего контура и против часовой стрелки для внутренних контуров). Обратите внимание, что не все форматы поддерживают это.

decimals number | undefined

Максимальное количество десятичных знаков для координат. Координаты хранятся внутри как числа с плавающей запятой, но арифметика с плавающей запятой может создавать координаты с большим количеством десятичных знаков, что обычно нежелательно на выходе. Установите число здесь, чтобы округлить координаты. Также может быть использовано для обеспечения того, что введенные координаты могут быть записаны обратно с тем же количеством десятичных знаков. Значение по умолчанию — округление не применяется.

Возвращаемое значение:
Закодированная геометрия.

writeGeometryObject(geometry, options){GeoJSONGeometry | GeoJSONGeometryCollection}

format/GeoJSON.js, строка 301

Кодирование геометрии как объекта GeoJSON.

Имя Тип Описание
geometry Геометрия

Геометрия.

options

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

Имя Тип Описание
dataProjection Проекция | undefined

Проекция данных, которые мы записываем. Если не указано, используется проекция формата (если задана). Если для формата не задана проекция, элементы будут возвращены в проекции по умолчанию.

featureProjection Проекция | undefined

Проекция геометрий элементов, которые будут сериализованы записывателем формата. Если не указано, геометрии предполагаются в проекции по умолчанию (если она задана); другими словами, они не преобразуются.

rightHanded boolean | undefined

При записи геометрий используется правило правой руки для ориентации замкнутых линий. Это означает, что у многоугольников будут внешние контуры по часовой стрелке и внутренние контуры против часовой стрелки. По умолчанию координаты сериализуются так, как они предоставлены при создании. Если задано значение `true`, применяется правило правой руки. Если задано значение `false`, применяется правило левой руки (по часовой стрелке для внешнего контура и против часовой стрелки для внутренних контуров). Обратите внимание, что не все форматы поддерживают это.

decimals number | undefined

Максимальное количество десятичных знаков для координат. Координаты хранятся внутри как числа с плавающей запятой, но арифметика с плавающей запятой может создавать координаты с большим количеством десятичных знаков, что обычно нежелательно на выходе. Установите число здесь, чтобы округлить координаты. Также может быть использовано для обеспечения того, что введенные координаты могут быть записаны обратно с тем же количеством десятичных знаков. Значение по умолчанию — округление не применяется.

Возвращаемое значение:
Объект.

© 2005-present, OpenLayers Contributors All rights reserved.Licensed under the BSD 2-Clause License.
https://openlayers.org/en/latest/apidoc/module-ol_format_GeoJSON-GeoJSON.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API