InputQuantizationParameters

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

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

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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
Number

Origin of M-Values.

more details
InputQuantizationParameters
Number

Number of significant digits for M-Values.

more details
InputQuantizationParameters
Number

False origin of x values of the quantization grid.

more details
InputQuantizationParameters
Number

Number of significant digits for the x and y coordinates.

more details
InputQuantizationParameters
Number

False origin for y-values of the quantization grid.

more details
InputQuantizationParameters
Number

The false origin of the Z-values.

more details
InputQuantizationParameters
Number

Number of significant digits of the Z-Values.

more details
InputQuantizationParameters

Property Details

declaredClass Stringreadonly inherited

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

mFalseOrigin Number

Origin of M-Values.

mResolution Number

Number of significant digits for M-Values.

xFalseOrigin Number

False origin of x values of the quantization grid.

xyResolution Number

Number of significant digits for the x and y coordinates.

yFalseOrigin Number

False origin for y-values of the quantization grid.

zFalseOrigin Number

The false origin of the Z-values.

zResolution Number

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.

more details
Accessor
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited

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

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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(groupKey){Boolean}inherited

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(groupKey)inherited

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.