InputQuantizationParameters | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Custom quantization parameters for input geometry that compresses geometry for transfer to the server. Overrides the default lossless WGS84 quantization.

See also

GraphQueryStreaming

Example

//sample implementation of an input quantization parameter
//query entities within a bounding box
const query = "MATCH (n) WHERE esri.graph.ST_Intersects($param_filter_geom, n.geometry) RETURN n"

KnowledgeGraphModule.executeQueryStreaming(
  knowledgeGraph,
  {
    openCypherQuery: query,
    bindParameters: {
      param_filter_geom: new Polygon({
        rings: [
          [
            [-89, -89],
            [89, -89],
            [89, 89],
            [-89, 89],
            [-89, -89],
          ],
        ],
      }),
    },
    inputQuantizationParameters: {
      xyResolution: 0.003,
      xFalseOrigin: 25,
      yFalseOrigin: 25,
      zResolution: 1,
      zFalseOrigin: 1,
      mResolution: 1,
      mFalseOrigin: 1,
    },
   }
  }
);

Constructors

InputQuantizationParameters Constructor new InputQuantizationParameters(properties)

Parameter

properties Object

optional

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

Property Overview

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

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
Number	Origin of M-Values.	InputQuantizationParameters
Number	Number of significant digits for M-Values.	InputQuantizationParameters
Number	False origin of x values of the quantization grid.	InputQuantizationParameters
Number	Number of significant digits for the x and y coordinates.	InputQuantizationParameters
Number	False origin for y-values of the quantization grid.	InputQuantizationParameters
Number	The false origin of the Z-values.	InputQuantizationParameters
Number	Number of significant digits of the Z-Values.	InputQuantizationParameters

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

mFalseOrigin Property mFalseOrigin Number

Origin of M-Values.

mResolution Property mResolution Number

Number of significant digits for M-Values.

xFalseOrigin Property xFalseOrigin Number

False origin of x values of the quantization grid.

xyResolution Property xyResolution Number

Number of significant digits for the x and y coordinates.

yFalseOrigin Property yFalseOrigin Number

False origin for y-values of the quantization grid.

zFalseOrigin Property zFalseOrigin Number

The false origin of the Z-values.

zResolution Property zResolution Number

Number of significant digits of the Z-Values.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");