Symbol3DVerticalOffset | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Shifts a symbol along the vertical world axis by a given height. The height is set in screen space units like points or pixels.

See also

Constructors

Symbol3DVerticalOffset Constructor new Symbol3DVerticalOffset(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

Type	Summary	Class
String	The name of the class.	Accessor
Number	The maximum vertical symbol offset in world units.	Symbol3DVerticalOffset
Number	The minimum vertical symbol offset in world units.	Symbol3DVerticalOffset
Number	Vertical symbol offset in screen size.	Symbol3DVerticalOffset

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

maxWorldLength Property maxWorldLength Number

The maximum vertical symbol offset in world units. It acts as an upper bound to avoid vertical offset becoming too big.

In the following animation the green symbols have maxWorldLength = 50 and orange symbols don't have maxWorldLength set:

maxWorldLength

minWorldLength Property minWorldLength Number

The minimum vertical symbol offset in world units. It acts as a lower bound to avoid vertical offset becoming too small.

In the following animation the green symbol on the left has minWorldLength = 20 and for the orange symbol on the right minWorldLength has not been set:

minWorldLength-on

Default Value:0

screenLength Property screenLength Numberautocast Autocasts from Number|String

Vertical symbol offset in screen size. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).

Default Value:0

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Symbol3DVerticalOffset	Creates a deep clone of the vertical offset.	Symbol3DVerticalOffset
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

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.

clone Method clone(){Symbol3DVerticalOffset}

Creates a deep clone of the vertical offset.

Returns

Type	Description
Symbol3DVerticalOffset	A deep clone of the object that invoked this method.

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