InputQuantizationParameters

AMD: require(["esri/rest/knowledgeGraph/InputQuantizationParameters"], (InputQuantizationParameters) => { /* code goes here */ });
ESM: import InputQuantizationParameters from "@arcgis/core/rest/knowledgeGraph/InputQuantizationParameters.js";
Class: esri/rest/knowledgeGraph/InputQuantizationParameters
Inheritance: InputQuantizationParametersAccessor
Since: ArcGIS Maps SDK for JavaScript 4.25

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

See also
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
Name Type Summary Class

The name of the class.

Accessor

Origin of M-Values.

InputQuantizationParameters

Number of significant digits for M-Values.

InputQuantizationParameters

False origin of x values of the quantization grid.

InputQuantizationParameters

Number of significant digits for the x and y coordinates.

InputQuantizationParameters

False origin for y-values of the quantization grid.

InputQuantizationParameters

The false origin of the Z-values.

InputQuantizationParameters

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 |null |undefined

Origin of M-Values.

mResolution

Property
mResolution Number |null |undefined

Number of significant digits for M-Values.

xFalseOrigin

Property
xFalseOrigin Number |null |undefined

False origin of x values of the quantization grid.

xyResolution

Property
xyResolution Number |null |undefined

Number of significant digits for the x and y coordinates.

yFalseOrigin

Property
yFalseOrigin Number |null |undefined

False origin for y-values of the quantization grid.

zFalseOrigin

Property
zFalseOrigin Number |null |undefined

The false origin of the Z-values.

zResolution

Property
zResolution Number |null |undefined

Number of significant digits of the Z-Values.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor

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");

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close