require(["esri/layers/support/PixelBlock"], (PixelBlock) => { /* code goes here */ });
import PixelBlock from "@arcgis/core/layers/support/PixelBlock.js";
esri/layers/support/PixelBlock
An object representing the pixel arrays in the view. It stores and decodes source data fetched from an image service associated with an ImageryLayer. This provides the user access to each pixel on the client via the pixels property. The PixelBlock object is designed to handle generic pixel arrays from any raster data source.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
The height (or number of rows) of the PixelBlock in pixels. | PixelBlock | ||
An array of nodata mask. | PixelBlock | ||
Indicates whether mask should be used as alpha values. | PixelBlock | ||
A two dimensional array representing the pixels from the Image Service displayed on the client. | PixelBlock | ||
The pixel type. | PixelBlock | ||
An array of objects containing numeric statistical properties. | PixelBlock | ||
Number of valid pixels | PixelBlock | ||
The width (or number of columns) of the PixelBlock in pixels. | PixelBlock |
Property Details
-
height
height Number
-
The height (or number of rows) of the PixelBlock in pixels.
-
mask
mask Uint8Array
-
An array of nodata mask. All pixels are valid when mask is null.
-
maskIsAlpha
maskIsAlpha Boolean
-
Indicates whether mask should be used as alpha values. If no (default), a pixel is valid when corresponding mask value is truthy
-
pixels
pixels Array<(Array<number>|Int8Array|Uint8Array|Uint8ClampedArray|Int16Array|Uint16Array|Int32Array|Uint32Array|Float32Array|Float64Array)>
-
A two dimensional array representing the pixels from the Image Service displayed on the client. The length of the first dimension is the same as the number of bands in the layer. The length of the second dimension is height * width. The length of each band is the same. The pixels in each band are arranged row by row in this format:
[p_00, p_10, p_20, ... p_10, p_11, ...]
wherep_xy
is the pixel value at the columnx
and rowy
.Examplelet pixels = imgLyr.pixelData.pixelBlock.pixels; // Prints the number of bands in the layer console.log(pixels.length); // An array containing all the pixels in the first band let band1 = pixels[0];
-
pixelType
pixelType String
-
The pixel type.
Possible Values:"unknown" |"s8" |"s16" |"s32" |"u1" |"u2" |"u4" |"u8" |"u16" |"u32" |"f32" |"f64" |"c64" |"c128"
-
An array of objects containing numeric statistical properties. Each object has the following specification if defined.
-
validPixelCount
validPixelCount Number
-
Number of valid pixels
-
width
width Number
-
The width (or number of columns) of the PixelBlock in pixels.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds another plane to the PixelBlock. | PixelBlock | ||
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Returns pixels and masks using a single array in bip format (e.g. | PixelBlock | ||
Similar to getAsRGBA, but returns floating point data. | PixelBlock | ||
Returns the plane band count of the PixelBlock. | PixelBlock | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Adds another plane to the PixelBlock.
ParametersSpecification
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
getAsRGBA
getAsRGBA(){Uint8ClampedArray}
-
Returns pixels and masks using a single array in bip format (e.g. [p_00_r, p_00_g, p_00_b, p_00_a, p_10_r, p_10_g, p_10_b, p_10_a, .....]). Use this method to get an unsigned 8 bit pixel array. The result can be used to create a webgl texture.
ReturnsType Description Uint8ClampedArray An unsigned 8-bit pixel array.
-
getAsRGBAFloat
getAsRGBAFloat(){Float32Array}
-
Similar to getAsRGBA, but returns floating point data. The result can be used to create a webgl texture (OES_texture_float).
ReturnsType Description Float32Array A floating point array.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");