QuantizationParameters | References | ArcGIS Maps SDK for JavaScript

import QuantizationParameters from "@arcgis/core/rest/support/QuantizationParameters.js";

Inheritance:: QuantizationParameters→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.0

QuantizationParameters define how geometries are to be quantized (converted to integers) in the response from a Query operation. Used to project the geometry onto a virtual grid, likely representing pixels on the screen. Geometry coordinates are converted to integers by building a grid with a resolution matching the tolerance. Each coordinate is then snapped to one pixel on the grid.

See also

Query.quantizationParameters

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`QuantizationParametersProperties`

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
`extent`	`Extent \| null \| undefined`
`mode` readonly	`"view" \| "edit"`
`originPosition`	`"upper-left" \| "lower-left"`
`tolerance`	`number`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

extent

autocast Property

Type: Extent | null | undefined

An extent defining the quantization grid bounds. Its SpatialReference matches the input geometry spatial reference if one is specified for the query. Otherwise, the extent will be in the layer's spatial reference.

mode

readonly Property

Type: "view" | "edit"

Geometry coordinates are optimized for viewing and displaying of data.

Default value: "view"

originPosition

Property

Type: "upper-left" | "lower-left"

The integer's coordinates will be returned relative to the origin position defined by this property value.

Default value: "upper-left"

tolerance

Property

Type: number

The size of one pixel in the units of the outSpatialReference. This number is used to convert coordinates to integers by building a grid with a resolution matching the tolerance. Each coordinate is then snapped to one pixel on the grid. Consecutive coordinates snapped to the same pixel are removed for reducing the overall response size. The units of tolerance will match the units of outSpatialReference. If outSpatialReference is not specified, then tolerance is assumed to be in the units of the spatial reference of the layer. If tolerance is not specified, the maxAllowableOffset is used. If tolerance and maxAllowableOffset are not specified, a grid of 10,000 * 10,000 grid is used by default.

Default value: 1

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`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.

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.