Spec-Zone.ru › OpenLayers

ol/format/EsriJSON~EsriJSON


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

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

new EsriJSON(options)

format/EsriJSON.js, строка 78
Имя Тип Описание
geometryName string | undefined

Имя геометрии, используемое при создании функций.

Расширяет

  • JSONFeature

Методы

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

format/JSONFeature.js, line 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, line 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, line 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, 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){Объект}

format/EsriJSON.js, строка 202

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

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

Объект.

options

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

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

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

featureProjection Проекция | undefined

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

rightHanded boolean | undefined

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

decimals число | undefined

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

Возвращает:
Объект.

writeFeatures(features, options){строка} унаследованный

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

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

Имя Тип Описание
features Массив<Объект>

Объекты.

options

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

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

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

featureProjection Проекция | undefined

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

rightHanded boolean | undefined

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

decimals число | undefined

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

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

writeFeaturesObject(features, options){EsriJSONFeatureSet}

format/EsriJSON.js, строка 240

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

Имя Тип Описание
features Массив<Объект>

Объекты.

options

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

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

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

featureProjection Проекция | undefined

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

rightHanded boolean | undefined

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

decimals число | undefined

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

Результат:
Объект EsriJSON.

writeGeometry(geometry, options){строка} inherited

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

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

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

Геометрия.

options

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

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

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

featureProjection Проекция | undefined

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

rightHanded boolean | undefined

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

decimals число | undefined

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

Результат:
Закодированная геометрия.

writeGeometryObject(geometry, options){EsriJSONGeometry}

format/EsriJSON.js, строка 189

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

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

Геометрия.

options

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

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

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

featureProjection Проекция | undefined

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

rightHanded boolean | undefined

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

decimals число | undefined

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

Результат:
Объект.

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

Spec-Zone.ru

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