OrganicLayoutSettings

AMD: require(["esri/linkChart/OrganicLayoutSettings"], (OrganicLayoutSettings) => { /* code goes here */ });
ESM: import OrganicLayoutSettings from "@arcgis/core/linkChart/OrganicLayoutSettings.js";
Class: esri/linkChart/OrganicLayoutSettings
Inheritance: OrganicLayoutSettingsAccessor
Since: ArcGIS Maps SDK for JavaScript 4.32

Settings for organic layout calculations.

See also

Constructors

OrganicLayoutSettings

Constructor
new OrganicLayoutSettings(properties)
Parameter
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.
Show inherited properties Hide inherited properties
Name Type Summary Class

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

OrganicLayoutSettings

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

OrganicLayoutSettings

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

OrganicLayoutSettings

The name of the class.

Accessor

Determines which property to use to compute the ideal edge length.

OrganicLayoutSettings

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

OrganicLayoutSettings

Value to be used for the repulsion radius multiplier in organic layout calculations.

OrganicLayoutSettings

Property Details

absoluteIdealEdgeLength

Property
absoluteIdealEdgeLength 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
autoRepulsionRadius Boolean

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

Default Value:true

computationBudgetTime

Property
computationBudgetTime Number |null |undefined

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

Default Value:2

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

idealEdgeLengthType

Property
idealEdgeLengthType String

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.

Possible Values:"absolute-value" |"multiplier"

Default Value:"multiplier"

multiplicativeIdealEdgeLength

Property
multiplicativeIdealEdgeLength 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
repulsionRadiusMultiplier 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

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

OrganicLayoutSettings

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Converts an instance of this class to its ArcGIS portal JSON representation.

OrganicLayoutSettings

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
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();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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.

fromJSON

Method
fromJSON(json){* |null |undefined}static

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.

Parameter
json Object

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
Type Description
* | null | undefined Returns a new instance of this class.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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");
}

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A 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");

toJSON

Method
toJSON(){Object}

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

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close