ESM: import OrderByInfo from "@arcgis/core/layers/support/OrderByInfo.js";
CDN: const OrderByInfo = await $arcgis.import("@arcgis/core/layers/support/OrderByInfo.js");
Class: @arcgis/core/layers/support/OrderByInfo
Since: ArcGIS Maps SDK for JavaScript 4.21
Class that allows you to define the drawing order of features in a MapView. Draw order can be defined by a number or date field value or an Arcade expression.
Example
// Draws features in the view so that features with larger population
// values are rendered on top of larger features.
const orderBy = new OrderByInfo({
field: "POPULATION",
order: "descending"
});
layer.orderBy = [orderBy];
Constructors
new OrderByInfo(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsInherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className
.
The number or date field whose values will be used to sort features.
The sort order. If ascending
, then features with smaller data values (they usually have smaller symbols in size visualizations) will be drawn on top of features with larger data values. If descending
, then features with larger data values (usually larger symbols in size visualizations) will be drawn on top of features with smaller data values. If date values are used, then ascending
means features with older values will be drawn on top of features with more recent dates. A descending
order for dates indicates features with more recent values will be drawn on top of features with older values.
Possible Values:"ascending" |"descending"
Default Value:"ascending"
An Arcade expression following the specification defined by the Arcade Feature Z Profile. Expressions may reference field values using the $feature
profile variable and must return a number or a date representing the z-value used to sort features.
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.
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
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.
Creates a deep clone of this object.
Returns
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json
parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.
Returns
Type Description * | null | undefined Returns a new instance of this class.Inherited
Method hasHandles(groupKey){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue
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
Method removeHandles(groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA 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");
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4