PointCloudClassBreaksRenderer

require(["esri/renderers/PointCloudClassBreaksRenderer"], function(PointCloudClassBreaksRenderer) { /* code goes here */ });
Class: esri/renderers/PointCloudClassBreaksRenderer
Inheritance: PointCloudClassBreaksRenderer PointCloudRenderer Accessor
Since: ArcGIS API for JavaScript 4.2

This class defines the color of each point in a PointCloudLayer based on the value of a numeric attribute. Colors are assigned based on classes or ranges of data. Each point is assigned a symbol based on the class break in which the value of the attribute falls.

Autocasting support

As of version 4.5 of the ArcGIS API for JavaScript, autocasting is universally supported for all renderers, symbols, and symbol layers in the API. So there is no need to include this module in the require() and define() module loaders of your application unless you intend to use the static method(s) of this module.

See also:

Constructors

new PointCloudClassBreaksRenderer(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 Working with Properties topic.
NameTypeSummaryClass
Object[]

Each element in the array is an object that provides information about a class break associated with the renderer.

more details
more detailsPointCloudClassBreaksRenderer
Object

Reduces the brightness of the point's color, based on the value of another field, usually intensity.

more details
more detailsPointCloudRenderer
String

The name of the class.

more details
more detailsAccessor
String

The name of the field that is used to drive the color visualization for the renderer.

more details
more detailsPointCloudClassBreaksRenderer
String

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

more details
more detailsPointCloudClassBreaksRenderer
Object

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

more details
more detailsPointCloudRenderer
Number

The number of points to draw per display inch.

more details
more detailsPointCloudRenderer
String

The type of renderer.

more details
more detailsPointCloudClassBreaksRenderer

Property Details

colorClassBreakInfosObject[]

Each element in the array is an object that provides information about a class break associated with the renderer. Each object has the following specification:

Properties:
minValue Number

The minimum value of the break.

maxValue Number

The maximum value of the break.

color Color

The color used to colorize the points where values are between the minValue and maxValue of the break.

label String
optional

The label used to describe point in the break.

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

Field value at which the point color becomes darkest.

Default value: 0.

maxValue Number
optional

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

Default value: 255.

See also:

declaredClassStringreadonly inherited

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

fieldString

The name of the field that is used to drive the color visualization for the renderer. The value of this field determines which class break each point is assigned.

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

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 screenspace 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

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

Default value: 1.

minSize Number
optional

Minimum screen space size in points. Applies to "splat" only.

Deprecated since version 4.5

pointsPerInchNumber inherited

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

Default Value: 10

typeString

The type of renderer. For PointCloudClassBreaksRenderer this value is always point-cloud-class-breaks.

Method Overview

NameReturn TypeSummaryClass
PointCloudClassBreaksRenderer

Creates a deep clone of the renderer.

more details
more detailsPointCloudClassBreaksRenderer
*

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

more details
more detailsPointCloudRenderer
Object

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

more details
more detailsPointCloudRenderer

Method Details

Creates a deep clone of the renderer.

Returns:
TypeDescription
PointCloudClassBreaksRendererA 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:
TypeDescription
*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:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.