Spec-Zone.ru › OpenLayers

ol/format/JSONFeature~JSONFeature


Абстрактный базовый класс; обычно используется только для создания подклассов и не создается экземплярами в приложениях. Базовый класс для форматов JSON-объектов.

Подклассы

  • EsriJSON
  • GeoJSON
  • TopoJSON

Расширяет

  • FeatureFormat

Методы

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

format/JSONFeature.js, line 40

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

Name Type Description
source ArrayBuffer | Document | Element | Object | string

Источник.

options

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

Name Type Description
dataProjection ProjectionLike | undefined

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

extent Extent | undefined

Экстент тайла в единицах карты считываемого тайла. Это необходимо только при чтении данных с пикселями тайла в качестве единиц геометрии. При настройке необходимо указать dataProjection с TILE_PIXELS как units и пиксельным экстентом тайла как extent.

featureProjection ProjectionLike | undefined

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

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

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

format/JSONFeature.js, line 57

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

Name Type Description
source ArrayBuffer | Document | Element | Object | string

Источник.

options

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

Name Type Description
dataProjection ProjectionLike | undefined

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

extent Extent | undefined

Экстент тайла в единицах карты считываемого тайла. Это необходимо только при чтении данных с пикселями тайла в качестве единиц геометрии. При настройке необходимо указать dataProjection с TILE_PIXELS как units и пиксельным экстентом тайла как extent.

featureProjection ProjectionLike | undefined

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

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

readGeometry(source, options){Geometry}

format/JSONFeature.js, line 95

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

Name Type Description
source ArrayBuffer | Document | Element | Object | string

Источник.

options

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

Name Type Description
dataProjection ProjectionLike | undefined

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

extent Extent | undefined

Экстент тайла в единицах карты считываемого тайла. Это необходимо только при чтении данных с пикселями тайла в качестве единиц геометрии. При настройке необходимо указать dataProjection с TILE_PIXELS как units и пиксельным экстентом тайла как extent.

featureProjection ProjectionLike | undefined

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

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

readProjection(source){Projection}

format/JSONFeature.js, line 121

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

Name Type Description
source ArrayBuffer | Document | Element | Object | string

Источник.

Возвращает:
Проекция.

writeFeature(feature, options){string}

format/JSONFeature.js, line 144

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

Имя Тип Описание
feature Признак

Признак.

options

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

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

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

featureProjection Проекция | undefined

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

rightHanded boolean | undefined

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

decimals number | undefined

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

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

writeFeatures(features, options){string}

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

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

Имя Тип Описание
features Array<Признак>

Признаки.

options

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

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

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

featureProjection Проекция | undefined

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

rightHanded boolean | undefined

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

decimals number | undefined

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

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

writeGeometry(geometry, options){string}

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

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

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

Геометрия.

options

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

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

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

featureProjection Проекция | undefined

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

rightHanded boolean | undefined

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

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_JSONFeature-JSONFeature.html

Spec-Zone.ru

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