require(["esri/rest/knowledgeGraph/OutputQuantizationParameters"], (OutputQuantizationParameters) => { /* code goes here */ });
import OutputQuantizationParameters from "@arcgis/core/rest/knowledgeGraph/OutputQuantizationParameters.js";
esri/rest/knowledgeGraph/OutputQuantizationParameters
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
//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
-
Parameterproperties Objectoptional
See the properties for a full list of the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
An extent defining the quantization grid bounds. | OutputQuantizationParameters | ||
Geometry coordinates are optimized for viewing and displaying of data. | OutputQuantizationParameters | ||
The size of one pixel in the units of the SpatialReference. | OutputQuantizationParameters |
Property Details
-
extent
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.
-
quantizeMode
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. Theedit
value specifies that full-resolution geometries should be returned, which can support lossless editing.Possible Values:"view" |"edit"
-
tolerance
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
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
-
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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Inherited from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");