OutputQuantizationParameters

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

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
Example
//sample implementation of an output 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],
          ],
        ],
      }),
    },
    outputQuantizationParameters: {
      extent: {
        xmax: 30,
        xmin: 20,
        ymax: 30,
        ymin: 20,
      },
      tolerance: 0.001,
      quantizeMode: "view",
    }
   }
  }
);

Constructors

new OutputQuantizationParameters(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
Object

An extent defining the quantization grid bounds.

more details
OutputQuantizationParameters
String

Geometry coordinates are optimized for viewing and displaying of data.

more details
OutputQuantizationParameters
Number

The size of one pixel in the units of the SpatialReference.

more details
OutputQuantizationParameters

Property Details

declaredClass Stringreadonly inherited

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

extent Object

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.

Properties
xmax Number

Maximum horizontal grid bounds.

xmin Number

Minimum horizontal grid bounds.

ymax Number

Maximum vertical grid bounds.

ymin Number

Minimum vertical grid bounds.

quantizeMode String

Geometry coordinates are optimized for viewing and displaying of data. The view value specifies that geometry coordinates should be optimized for viewing and displaying of data. The edit value specifies that full-resolution geometries should be returned, which can support lossless editing.

Possible Values:"view"|"edit"

tolerance Number

The size of one pixel in the units of the SpatialReference. 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 spatial reference. 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, a 10,000 * 10,000 grid is used by default.

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.