ParquetGeometryEncodingWkb | References | ArcGIS Maps SDK for JavaScript

import ParquetGeometryEncodingWkb from "@arcgis/core/layers/support/ParquetGeometryEncodingWkb.js";

Inheritance:: ParquetGeometryEncodingWkb→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.33

Well-Known Binary (WKB) is a binary format used to encode geometries before storing them in parquet files.

See also

Constructors

Constructor

Since: ArcGIS Maps SDK for JavaScript 5.0

Parameters

Parameter	Type	Description	Required
properties	`ParquetGeometryEncodingWkbProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`field`	`string`
`orientation`	`"counter-clockwise" \| null \| undefined`
`type` readonly	`"wkb"`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

field

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The name of the geometry column. When a parquet file contains multiple geometry fields, set this property to specify which geometry column should be used by the ParquetLayer. This field is used to set the ParquetLayer.geometryType of the layer.

orientation

Property

Type: "counter-clockwise" | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Winding order of exterior ring of polygons. If present must be "counter-clockwise"; interior rings are wound in opposite order. If absent, no assertions are made regarding the winding order.

type

readonly Property

Type: "wkb"

Since: ArcGIS Maps SDK for JavaScript 5.0

The type of encoding used for the geometries in the parquet file. This will always be "wkb" for this class.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	`any`	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.