OthersCategory | References | ArcGIS Maps SDK for JavaScript

import OthersCategory from "@arcgis/core/renderers/support/OthersCategory.js";

Inheritance:: OthersCategory→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.0

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`OthersCategoryProperties`

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
`color`	`Color`
`declaredClass` readonly inherited	`string`	Accessor
`label`	`string \| null \| undefined`
`threshold`	`number`

color

autocast Property

Type: Color

Defines the color used to represent all categories whose pie slices are smaller than the percentage defined by threshold. This is typically used to represent a generic "others" category where slices would otherwise be too small to read.

Default value: [0, 0, 0, 0] - black, transparent

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

label

Property

Type: string | null | undefined

Describes the color grouping categories smaller than the threshold in the Legend.

Example

renderer.othersCategory.label = "All other categories";

threshold

Property

Type: number

Represents the minimum size of individual slices as a percentage (between 0 and 1) of the entire pie for a slice to belong to its own category. All slices that make up a smaller percentage than the threshold will automatically be aggregated to an "others" category represented by the color. For example, if the threshold is 0.05, then all slices that make up less than 5% of the total pie will be represented with the color.

Default value: 0

Example

// all slices smaller than 10% of the pie
// will aggregate to the "others" category
renderer.othersCategory.threshold = 0.1;

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`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

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class 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.