Symbol3DVerticalOffset | References | ArcGIS Maps SDK for JavaScript

import Symbol3DVerticalOffset from "@arcgis/core/symbols/support/Symbol3DVerticalOffset.js";

Inheritance:: Symbol3DVerticalOffset→Accessor

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`Symbol3DVerticalOffsetProperties`

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
`maxWorldLength`	`number \| null \| undefined`
`minWorldLength`	`number`
`screenLength`	`number`

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.

maxWorldLength

Property

Type: number | null | undefined

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

Type: 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

autocast Property

Type: number

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

Methods

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

Creates a deep clone of the vertical offset.

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