Class GeoJSON

Hierarchy

GeoJSON
- GeoJSON

Constructors

constructor

new GeoJSON(options: { defaultStyle?: any; extensions?: any }): GeoJSON
Parameters
- options: { defaultStyle?: any; extensions?: any }
  Options
  - OptionaldefaultStyle?: any
    
    Styles by default
  - Optionalextensions?: any
    
    Add properties to file root
Returns GeoJSON
Overrides olGeoJSON.constructor
- Defined in src/packages/Formats/GeoJSON.js:28

Properties

`Protected`dataProjection

dataProjection: Projection | undefined

`Protected`defaultFeatureProjection

defaultFeatureProjection: Projection | undefined

`Protected`featureClass

featureClass: typeof Feature

options

options: { defaultStyle?: any; extensions?: any }

source

source: any

supportedMediaTypes

supportedMediaTypes: string[]

A list media types supported by the format in descending order of preference.

Methods

`Protected`adaptOptions

adaptOptions(
options: WriteOptions | ReadOptions | undefined,
): WriteOptions | ReadOptions | undefined
Protected
Sets the dataProjection on the options, if no dataProjection is set.
Parameters
- options: WriteOptions | ReadOptions | undefined
  Options.
Returns WriteOptions | ReadOptions | undefined
Updated options.
Inherited from olGeoJSON.adaptOptions
- Defined in node_modules/ol/format/Feature.d.ts:254

`Protected`getReadOptions

getReadOptions(source: any, options?: ReadOptions): ReadOptions | undefined
Protected
Adds the data projection to the read options.
Parameters
- source: any
  Source.
- Optionaloptions: ReadOptions
  Options.
Returns ReadOptions | undefined
Options.
Inherited from olGeoJSON.getReadOptions
- Defined in node_modules/ol/format/Feature.d.ts:244

`Abstract`getType

getType(): Type
Returns Type
The format type.
Inherited from olGeoJSON.getType
- Defined in node_modules/ol/format/Feature.d.ts:259

readFeature

readFeature(
    source: any,
    options?: ReadOptions,
):
    | Feature<Geometry, { [x: string]: any }>
    | Feature<Geometry, { [x: string]: any }>[]
Read a feature. Only works for a single feature. Use readFeatures to read a feature collection.
Parameters
- source: any
  Source.
- Optionaloptions: ReadOptions
  Read options.
Returns
| Feature<Geometry, { [x: string]: any }>
| Feature<Geometry, { [x: string]: any }>[]
Feature.

Api
Inherited from olGeoJSON.readFeature
- Defined in node_modules/ol/format/JSONFeature.d.ts:25

`Protected` `Abstract`readFeatureFromObject

readFeatureFromObject(
    object: any,
    options?: ReadOptions,
):
    | Feature<Geometry, { [x: string]: any }>
    | Feature<Geometry, { [x: string]: any }>[]
Protected
Parameters
- object: any
  Object.
- Optionaloptions: ReadOptions
  Read options.
Returns
| Feature<Geometry, { [x: string]: any }>
| Feature<Geometry, { [x: string]: any }>[]
Feature.
Inherited from olGeoJSON.readFeatureFromObject
- Defined in node_modules/ol/format/JSONFeature.d.ts:33

readFeatures

readFeatures(
source: any,
options?: any,
): Feature<Geometry, { [x: string]: any }>[]
Read Extend Styles for Features. This function overloads ol.format.GeoJSON.readFeatures ...
Parameters
- source: any
  Source.
- Optionaloptions: any
  Options. see olx.format.ReadOptions
Returns Feature<Geometry, { [x: string]: any }>[]
Features.

See
olGeoJSON#readFeatures
Overrides olGeoJSON.readFeatures
- Defined in src/packages/Formats/GeoJSON.js:57

`Protected` `Abstract`readFeaturesFromObject

readFeaturesFromObject(
object: any,
options?: ReadOptions,
): Feature<Geometry, { [x: string]: any }>[]
Protected
Parameters
- object: any
  Object.
- Optionaloptions: ReadOptions
  Read options.
Returns Feature<Geometry, { [x: string]: any }>[]
Features.
Inherited from olGeoJSON.readFeaturesFromObject
- Defined in node_modules/ol/format/JSONFeature.d.ts:41

`Abstract`readGeometry

readGeometry(source: any, options?: ReadOptions): Geometry | null
Read a single geometry from a source.
Parameters
- source: any
  Source.
- Optionaloptions: ReadOptions
  Read options.
Returns Geometry | null
Geometry.
Inherited from olGeoJSON.readGeometry
- Defined in node_modules/ol/format/Feature.d.ts:286

`Protected`readGeometryFromObject

readGeometryFromObject(object: Geometry, options?: ReadOptions): Geometry | null
Protected
Parameters
- object: Geometry
  Object.
- Optionaloptions: ReadOptions
  Read options.
Returns Geometry | null
Geometry.
Inherited from olGeoJSON.readGeometryFromObject
- Defined in node_modules/ol/format/GeoJSON.d.ts:109

readProjection

readProjection(source: any): Projection
Read the projection.
Parameters
- source: any
  Source.
Returns Projection
Projection.

Api
Inherited from olGeoJSON.readProjection
- Defined in node_modules/ol/format/JSONFeature.d.ts:58

`Protected` `Abstract`readProjectionFromObject

readProjectionFromObject(object: any): Projection
Protected
Parameters
- object: any
  Object.
Returns Projection
Projection.
Inherited from olGeoJSON.readProjectionFromObject
- Defined in node_modules/ol/format/JSONFeature.d.ts:65

readRootExtensions

readRootExtensions(key: any): any
...
Parameters
- key: any
  ...
Returns any
json
- Defined in src/packages/Formats/GeoJSON.js:133

writeFeature

writeFeature(
feature: Feature<Geometry, { [x: string]: any }>,
options?: WriteOptions,
): string
Encode a feature as string.
Parameters
- feature: Feature<Geometry, { [x: string]: any }>
  Feature.
- Optionaloptions: WriteOptions
  Write options.
Returns string
Encoded feature.

Api
Inherited from olGeoJSON.writeFeature
- Defined in node_modules/ol/format/JSONFeature.d.ts:75

writeFeatureObject

writeFeatureObject(
feature: Feature<Geometry, { [x: string]: any }>,
options?: WriteOptions,
): Feature
Encode a feature as a GeoJSON Feature object.
Parameters
- feature: Feature<Geometry, { [x: string]: any }>
  Feature.
- Optionaloptions: WriteOptions
  Write options.
Returns Feature
Object.

Api
Inherited from olGeoJSON.writeFeatureObject
- Defined in node_modules/ol/format/GeoJSON.d.ts:119

writeFeatures

writeFeatures(
features: Feature<Geometry, { [x: string]: any }>[],
options?: any,
): string
Write Extend Styles for Features. This function overloads ol.format.GeoJSON.writeFeatures ...
Parameters
- features: Feature<Geometry, { [x: string]: any }>[]
  Features.
- Optionaloptions: any
  Options.
Returns string
Result.

See
olGeoJSON#writeFeatures
Overrides olGeoJSON.writeFeatures
- Defined in src/packages/Formats/GeoJSON.js:109

writeFeaturesObject

writeFeaturesObject(
features: Feature<Geometry, { [x: string]: any }>[],
options?: WriteOptions,
): FeatureCollection
Encode an array of features as a GeoJSON object.
Parameters
- features: Feature<Geometry, { [x: string]: any }>[]
  Features.
- Optionaloptions: WriteOptions
  Write options.
Returns FeatureCollection
GeoJSON Object.

Api
Inherited from olGeoJSON.writeFeaturesObject
- Defined in node_modules/ol/format/GeoJSON.d.ts:129

writeGeometry

writeGeometry(geometry: Geometry, options?: WriteOptions): string
Encode a geometry as string.
Parameters
- geometry: Geometry
  Geometry.
- Optionaloptions: WriteOptions
  Write options.
Returns string
Encoded geometry.

Api
Inherited from olGeoJSON.writeGeometry
- Defined in node_modules/ol/format/JSONFeature.d.ts:109

writeGeometryObject

writeGeometryObject(
geometry: Geometry,
options?: WriteOptions,
): Geometry | GeometryCollection<Geometry>
Encode a geometry as a GeoJSON object.
Parameters
- geometry: Geometry
  Geometry.
- Optionaloptions: WriteOptions
  Write options.
Returns Geometry | GeometryCollection<Geometry>
Object.

Api
Inherited from olGeoJSON.writeGeometryObject
- Defined in node_modules/ol/format/GeoJSON.d.ts:139

Class GeoJSON

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionaldefaultStyle?: any

Optionalextensions?: any

Returns GeoJSON

Properties

ProtecteddataProjection

ProtecteddefaultFeatureProjection

ProtectedfeatureClass

options

source

supportedMediaTypes

Methods

ProtectedadaptOptions

Parameters

Returns WriteOptions | ReadOptions | undefined

ProtectedgetReadOptions

Parameters

Returns ReadOptions | undefined

AbstractgetType

Returns Type

readFeature

Parameters

Returns | Feature<Geometry, { [x: string]: any }> | Feature<Geometry, { [x: string]: any }>[]

Api

Protected AbstractreadFeatureFromObject

Parameters

Returns | Feature<Geometry, { [x: string]: any }> | Feature<Geometry, { [x: string]: any }>[]

readFeatures

Parameters

Returns Feature<Geometry, { [x: string]: any }>[]

See

Protected AbstractreadFeaturesFromObject

Parameters

Returns Feature<Geometry, { [x: string]: any }>[]

AbstractreadGeometry

Parameters

Returns Geometry | null

ProtectedreadGeometryFromObject

Parameters

Returns Geometry | null

readProjection

Parameters

Returns Projection

Api

Protected AbstractreadProjectionFromObject

Parameters

Returns Projection

readRootExtensions

Parameters

Returns any

writeFeature

Parameters

Returns string

Api

writeFeatureObject

Parameters

Returns Feature

Api

writeFeatures

Parameters

Returns string

See

writeFeaturesObject

Parameters

Returns FeatureCollection

Api

writeGeometry

Parameters

Returns string

Api

writeGeometryObject

Parameters

`Optional`defaultStyle?: any

`Optional`extensions?: any

`Protected`dataProjection

`Protected`defaultFeatureProjection

`Protected`featureClass

`Protected`adaptOptions

`Protected`getReadOptions

`Abstract`getType

Returns
| Feature<Geometry, { [x: string]: any }>
| Feature<Geometry, { [x: string]: any }>[]

`Protected` `Abstract`readFeatureFromObject

Returns
| Feature<Geometry, { [x: string]: any }>
| Feature<Geometry, { [x: string]: any }>[]

`Protected` `Abstract`readFeaturesFromObject

`Abstract`readGeometry

`Protected`readGeometryFromObject

`Protected` `Abstract`readProjectionFromObject