Property Overview

Property Details

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

heightNumber

The height (or number of rows) of the PixelBlock in pixels.

maskNumber[]

An array of numbers representing pixels to show and pixels to hide from the view. The length of this array is height * width. It's arranged row by row in this format: [p_00, p_10, p_20, ... p_10, p_11, .....] where p_xy is the pixel value at the column x and row y.

The mask is per pixel, not per band. Items in the mask array with a value of 0 indicates pixels to not display in the view at that index. Items with a value of 1 indicate to display the pixels at there corresponding indices.

pixelsNumber[][]

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, ...] where p_xy is the pixel value at the column x and row y.

Example:

var 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
var band1 = pixels[0];

pixelTypeString

The pixel type.

Possible Values: s8 | s16 | s32 | u8 | u16 | u32 | f32 | f64

statisticsObject[]

An array of objects containing numeric statistical properties. Each object has the following specification if defined:

Properties:

maxValue Number optional The maximum pixel value in the pixels array.

minValue Number optional The minimum pixel value in the pixels array.

noDataValue Number optional Value representing areas of no data.

widthNumber

The width (or number of columns) of the PixelBlock in pixels.

Method Overview

Method Details

addData(planeData)inner

Adds another plane to the PixelBlock.

Parameters:

planeData Object The data to add to the PixelBlock. Specification: pixels Number[][] A two dimensional array representing the pixels to add. statistics Object[] An array of objects containing numeric statistical properties. See statistics for details on the specifications of each object.

getAsRGBA(){Number[]}inner

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.

Returns:

Type	Description
Number[]	An unsigned 8-bit pixel array.

getAsRGBAFloat(){Number[]}inner

Similar to getAsRGBA, but returns floating point data. The result can be used to create a webgl texture (OES_texture_float).

Returns:

Type	Description
Number[]	A floating point array.

getPlaneCount(){Number}inner

Returns the plane band count of the PixelBlock.

Returns:

Type	Description
Number	The plane band count.