Property Overview

Property Details

colorModulationObject inherited

Since: ArcGIS API for JavaScript 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

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

fieldString

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

fieldTransformTypeString

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

legendOptionsObject

Since: ArcGIS API for JavaScript 4.6

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

Property:

title String optional 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)"
};

pointSizeAlgorithmObject inherited

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.

useRealWorldSymbolSizes Boolean 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.

pointsPerInchNumber inherited

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

Default Value:10

stopsObject[]

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

Properties:

value Number The value for this stop.

label String optional The label for this stop.

color Color The color value for this stop.

typeStringreadonly

The type of Renderer. For PointCloudStretchRenderer this value is always point-cloud-stretch.

Method Overview

Method Details

clone(){PointCloudStretchRenderer}

Since: ArcGIS API for JavaScript 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
var renderer = view.map.layers.getItemAt(0).renderer.clone();

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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.

toJSON(){Object}inherited

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

Returns:

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