OrderByInfo | References | ArcGIS Maps SDK for JavaScript

import OrderByInfo from "@arcgis/core/layers/support/OrderByInfo.js";

Inheritance:: OrderByInfo→Accessor

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`OrderByInfoProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`field`	`string \| null \| undefined`
`order`	`"ascending" \| "descending"`
`valueExpression`	`string \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

field

Property

Type: string | null | undefined

The number or date field whose values will be used to sort features.

order

Property

Type: "ascending" | "descending"

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.

Default value: "ascending"

valueExpression

Property

Type: string | null | undefined

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.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): OrderByInfo`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

clone

Method

Signature: clone (): OrderByInfo

Creates a deep clone of this object.

Returns: OrderByInfo
A deep clone of the OrderByInfo instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.