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.
Constructors
new PointCloudClassBreaksRenderer(properties)
properties Object See the properties for a list of all the properties that may be passed into the constructor. |
Property Overview
Name | Type | Summary | |
---|---|---|---|
Object[] | Each element in the array is an object that provides information about a class break associated with the renderer. more details | more details | |
Object | Reduces the brightness of the point's color, based on the value of another field, usually | more details | |
String | The name of the class. more details | more details | |
String | The name of the field that is used to drive the color visualization for the renderer. more details | more details | |
String | A transform that is applied to the field value before evaluating the renderer. more details | more details | |
Object | Specifies how the size of the points in the point cloud is computed for rendering. more details | more details | |
Number | The number of points to draw per display inch. more details | more details | |
String | The type of renderer. more details | more details |
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:
colorModulationObject
Since: ArcGIS API for JavaScript 4.4Reduces 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.- See also:
Properties:field StringField to use for the color modulation. Commonly modulation is used with the
intensity
field.minValue NumberField value at which the point color becomes darkest.
Default value: 0.
maxValue NumberField value at which the point color will be left unchanged.
Default value: 255.
declaredClassStringreadonly
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: nullpointSizeAlgorithmObject
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:optionaltype String"fixed-size"
or"splat"
. Choosing"fixed-size"
implies settingsize
anduseRealWorldSymbolSizes
. If"splat"
is chosen thenscaleFactor
should be set.optionaluseRealWorldSymbolSizes BooleanSpecifies whether
size
is in real world units or screen-space units. Applies to"fixed-size"
only.optionalsize NumberPoint size in meters (
useRealWorldSymbolSizes = true
) or points. Applies to"fixed-size"
only.optionalscaleFactor NumberSpecifies the scale factor that is applied to the size estimated by the density. Applies to
"splat"
only. Default value: 1.optionalminSize NumberMinimum screen space size in points. Applies to
"splat"
only. Default value: 4.pointsPerInchNumber
The number of points to draw per display inch. This property determines the level of detail in the visualization.
Default Value: 10typeStringreadonly
The type of renderer. For PointCloudClassBreaksRenderer this value is always
pointCloudClassBreaksRenderer
.
Method Overview
Name | Return Type | Summary | |
---|---|---|---|
PointCloudClassBreaksRenderer | Creates a deep clone of the renderer. more details | more details | |
* | 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 details | |
Object | Converts an instance of this class to its ArcGIS Portal JSON representation. more details | more details |
Method Details
clone(){PointCloudClassBreaksRenderer}
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 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 ObjectA 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. 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.