PointCloudClassBreaksRenderer

AMD: require(["esri/renderers/PointCloudClassBreaksRenderer"], (PointCloudClassBreaksRenderer) => { /* code goes here */ });
ESM: import PointCloudClassBreaksRenderer from "@arcgis/core/renderers/PointCloudClassBreaksRenderer";
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.

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.
Show inherited properties Hide inherited properties
Name Type Summary Class
Object[]more details

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

more detailsPointCloudClassBreaksRenderer
Objectmore details

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

more detailsPointCloudRenderer
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

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

more detailsPointCloudClassBreaksRenderer
Stringmore details

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

more detailsPointCloudClassBreaksRenderer
Objectmore details

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

more detailsPointCloudClassBreaksRenderer
Objectmore details

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

more detailsPointCloudRenderer
Numbermore details

The number of points to draw per display inch.

more detailsPointCloudRenderer
Stringmore details

The type of renderer.

more detailsPointCloudClassBreaksRenderer

Property Details

colorClassBreakInfos Object[]

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.

colorModulation Object 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:
declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

field String

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.

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 Object
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: "Density"
};
pointSizeAlgorithm Object 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.

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

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.

pointsPerInch Number inherited

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

Default Value:10
type Stringreadonly

The type of renderer.

For PointCloudClassBreaksRenderer the type is always "point-cloud-class-breaks".

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
PointCloudClassBreaksRenderermore details

Creates a deep clone of the renderer.

more detailsPointCloudClassBreaksRenderer
*more details

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

more detailsPointCloudRenderer
Objectmore details

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

more detailsPointCloudRenderer

Method Details

Creates a deep clone of the renderer.

Returns:
Type Description
PointCloudClassBreaksRenderer 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.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 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.
toJSON(){Object}inherited

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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.