PointCloudStretchRenderer | API Reference | ArcGIS Maps SDK for JavaScript 4.31

PointCloudStretchRenderer defines the color of each point in a PointCloudLayer based on the value of a numeric attribute. It allows you to easily map continuous color ramps to minimum and maximum data values of one of the layer's numeric attribute fields.

See also

Sample - PointCloudLayer with renderer

Constructors

PointCloudStretchRenderer Constructor new PointCloudStretchRenderer(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
Object	Reduces the brightness of the point's color, based on the value of another field, usually `intensity`.	PointCloudRenderer
String	The name of the class.	Accessor
String	The name of the number field whose values are used to drive the continuous color visualization.	PointCloudStretchRenderer
String	A transform that is applied to the field value before evaluating the renderer.	PointCloudStretchRenderer
Object	An object providing options for displaying the renderer in the Legend.	PointCloudStretchRenderer
Object	Specifies how the size of the points in the point cloud is computed for rendering.	PointCloudRenderer
Number	The number of points to draw per display inch.	PointCloudRenderer
ColorStop []	An array of color value pairs.	PointCloudStretchRenderer
String	The type of Renderer.	PointCloudStretchRenderer

Property Details

colorModulation Inherited Property colorModulation Object Inherited from PointCloudRenderer Since: ArcGIS Maps SDK for JavaScript 4.4 PointCloudRenderer since 4.2, colorModulation added at 4.4.

Reduces the brightness of the point's color, based on the value of another field, usually intensity. High values leave the color unchanged, while low values darken the color of the point. This helps to display the scanned surface in a more realistic way.

Properties

field String

Field to use for the color modulation. Commonly modulation is used with the intensity field.

minValue Number

optional

Default Value:0

Field value at which the point color becomes darkest.

maxValue Number

optional

Default Value:255

Field value at which the point color will be left unchanged.

See also

Sample: PointCloudLayer - intensity color modulation

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

field Property field String

The name of the number field whose values are used to drive the continuous color visualization.

fieldTransformType Property fieldTransformType String

A transform that is applied to the field value before evaluating the renderer.

Possible Values:"none" |"low-four-bit" |"high-four-bit" |"absolute-value" |"modulo-ten"

Default Value:null

legendOptions Property legendOptions Objectautocast Since: ArcGIS Maps SDK for JavaScript 4.6 PointCloudStretchRenderer since 4.2, legendOptions added at 4.6.

An object providing options for displaying the renderer in the Legend.

Property: title String|null|undefined

Describes the variable driving the visualization. This is displayed as the title of the corresponding renderer in the Legend and takes precedence over a field alias.

Example

renderer.legendOptions = {
  title: "Elevation (high/low)"
};

pointSizeAlgorithm Inherited Property pointSizeAlgorithm Object Inherited from PointCloudRenderer

Specifies how the size of the points in the point cloud is computed for rendering.

The splat algorithm automatically computes a size based on the density, which varies with the Level of Detail that is currently displayed.

The fixed size algorithm displays all points with the same size, either in screen space or real world units.

When pointSizeAlgorithm is not set, the default is splat.

Properties: type String

fixed-size or splat. Choosing fixed-size implies setting size and useRealWorldSymbolSizes. If splat is chosen then scaleFactor should be set.

Possible Values:"fixed-size"|"splat"

useRealWorldSymbolSizes Boolean|null|undefined

optional
Specifies whether size is in real world units or screen-space units. Applies to fixed-size only.

size Number

optional
Point size in meters (useRealWorldSymbolSizes = true) or points. Applies to fixed-size only.

scaleFactor Number

optional
Default Value:1

Specifies the scale factor that is applied to the size estimated by the density. Applies to splat only.

pointsPerInch Inherited Property pointsPerInch Number Inherited from PointCloudRenderer

The number of points to draw per display inch. This property determines the level of detail in the visualization.

Default Value:10

stops Property stops ColorStop[]autocast Autocasts from Object []

An array of color value pairs. Points with values between the specified stops are colorized with linearly interpolated colors.

See also

ColorVariable

type Property type Stringreadonly

The type of Renderer.

For PointCloudStretchRenderer the type is always "point-cloud-stretch".

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
PointCloudStretchRenderer	Creates a deep clone of the renderer.	PointCloudStretchRenderer
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	PointCloudRenderer
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	PointCloudRenderer

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

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(){PointCloudStretchRenderer} Since: ArcGIS Maps SDK for JavaScript 4.4 PointCloudStretchRenderer since 4.2, clone added at 4.4.

Creates a deep clone of the renderer.

Returns

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

Example

// Creates a deep clone of the first layer's renderer
let renderer = view.map.layers.at(0).renderer.clone();

fromJSON Inherited Method fromJSON(json){*}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
*	Returns a new instance of this class.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

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 Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

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 Inherited Method toJSON(){Object} Inherited from PointCloudRenderer

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.