OrganicLayoutSettings | References | ArcGIS Maps SDK for JavaScript

import OrganicLayoutSettings from "@arcgis/core/linkChart/OrganicLayoutSettings.js";

Inheritance:: OrganicLayoutSettings→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.32

Settings for organic layout calculations.

See also

Web Map Specification | Link chart organic layout settings

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`OrganicLayoutSettingsProperties`

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
`absoluteIdealEdgeLength`	`number`
`autoRepulsionRadius`	`boolean`
`computationBudgetTime`	`number \| null \| undefined`
`declaredClass` readonly inherited	`string`	Accessor
`idealEdgeLengthType`	`IdealEdgeLengthType`
`multiplicativeIdealEdgeLength`	`number`
`repulsionRadiusMultiplier`	`number \| null \| undefined`

absoluteIdealEdgeLength

Property

Type: number

The value, in degrees, to use for the ideal edge length during layout calculations when the idealEdgeLengthType is absolute-value. Only used for geographic layouts.

Default value: 1

autoRepulsionRadius

Property

Type: boolean

Determines whether the repulsion radius should be calculated automatically (true), or computed according to repulsionRadiusMultiplier (false).

Default value: true

computationBudgetTime

Property

Type: number | null | undefined

The maximum amount of time in seconds to spend on the layout calculation.

Default value: 2

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

idealEdgeLengthType

Property

Type: IdealEdgeLengthType

Determines which property to use to compute the ideal edge length. Only used for geographic layouts. When the value is absolute-value, the absoluteIdealEdgeLength property is used. When the value is multiplier, the multiplicativeIdealEdgeLength property is used.

Default value: "multiplier"

multiplicativeIdealEdgeLength

Property

Type: number

Value used to multiply the default edge length to determine the ideal edge length during layout calculations, when the idealEdgeLengthType is multiplier. Only used for geographic layouts.

Default value: 1

repulsionRadiusMultiplier

Property

Type: number | null | undefined

Value to be used for the repulsion radius multiplier in organic layout calculations. The repulsion radius is calculated by multiplying the repulsionRadiusMultiplier by the actual ideal edge length.

Default value: 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.