Uint8ClampedArray

package js.lib

implements ArrayBufferView

Available on js

The Uint8ClampedArray typed array represents an array of 8-bit unsigned integers clamped to 0-255; if you specified a value that is out of the range of [0,255], 0 or 255 will be set instead; if you specify a non-integer, the nearest integer will be set. The contents are initialized to 0. Once established, you can reference elements in the array using the object's methods, or using standard array index syntax (that is, using bracket notation).

Documentation Uint8ClampedArray by Mozilla Contributors, licensed under CC-BY-SA 2.5.

Static variables

staticfinalread onlyBYTES_PER_ELEMENT:Int

Returns a number value of the element size. 1 in the case of an Uint8ClampedArray.

Static methods

staticfrom(source:{}, ?mapFn:(value:Int, index:Int) ‑> Int, ?thisArg:Any):Uint8ClampedArray

staticfrom(source:{}, ?mapFn:(value:Int) ‑> Int, ?thisArg:Any):Uint8ClampedArray

Creates a new Uint8ClampedArray from an array-like or iterable object. See also Array.from().

staticof(elements:Rest<Dynamic>):Uint8ClampedArray

Creates a new Uint8ClampedArray with a variable number of arguments. See also Array.of().

Constructor

new(buffer:ArrayBuffer, ?byteOffset:Int, ?length:Int)

new(length:Int)

new(object:{})

Throws:

null	DOMError

Variables

finalBYTES_PER_ELEMENT_:Int

Returns a number value of the element size.

finalbuffer:ArrayBuffer

Returns the ArrayBuffer referenced by the Uint8ClampedArray Fixed at construction time and thus read only.

finalbyteLength:Int

Returns the length (in bytes) of the Uint8ClampedArray from the start of its ArrayBuffer. Fixed at construction time and thus read only.

finalbyteOffset:Int

Returns the offset (in bytes) of the Uint8ClampedArray from the start of its ArrayBuffer. Fixed at construction time and thus read only.

finallength:Int

Returns the number of elements hold in the Uint8ClampedArray. Fixed at construction time and thus read only.

Methods

copyWithin(target:Int, start:Int, ?end:Int):Uint8ClampedArray

Copies a sequence of array elements within the array. See also Array.prototype.copyWithin().

entries():Iterator<KeyValue<Int, Int>>

Returns a new Array Iterator object that contains the key/value pairs for each index in the array. See also Array.prototype.entries().

every(callback:(currentValue:Int, index:Int, array:Uint8ClampedArray) ‑> Bool, ?thisArg:Any):Bool

every(callback:(currentValue:Int) ‑> Bool, ?thisArg:Any):Bool

every(callback:(currentValue:Int, index:Int) ‑> Bool, ?thisArg:Any):Bool

Tests whether all elements in the array pass the test provided by a function. See also Array.prototype.every().

fill(value:Int, ?start:Int, ?end:Int):Uint8ClampedArray

Fills all the elements of an array from a start index to an end index with a static value. See also Array.prototype.fill().

filter(callback:(element:Int, index:Int, array:Uint8ClampedArray) ‑> Bool, ?thisArg:Any):Uint8ClampedArray

filter(callback:(element:Int) ‑> Bool, ?thisArg:Any):Uint8ClampedArray

filter(callback:(element:Int, index:Int) ‑> Bool, ?thisArg:Any):Uint8ClampedArray

Creates a new array with all of the elements of this array for which the provided filtering function returns true. See also Array.prototype.filter().

find(callback:(element:Int, index:Int, array:Uint8ClampedArray) ‑> Bool, ?thisArg:Any):Null<Int>

find(callback:(element:Int) ‑> Bool, ?thisArg:Any):Null<Int>

find(callback:(element:Int, index:Int) ‑> Bool, ?thisArg:Any):Null<Int>

Returns the found value in the array, if an element in the array satisfies the provided testing function or undefined if not found. See also Array.prototype.find().

findIndex(callback:(element:Int, index:Int, array:Uint8ClampedArray) ‑> Bool, ?thisArg:Any):Int

findIndex(callback:(element:Int) ‑> Bool, ?thisArg:Any):Int

findIndex(callback:(element:Int, index:Int) ‑> Bool, ?thisArg:Any):Int

Returns the found index in the array, if an element in the array satisfies the provided testing function or -1 if not found. See also Array.prototype.findIndex().

forEach(callback:(element:Int, index:Int, array:Uint8ClampedArray) ‑> Void, ?thisArg:Any):Void

forEach(callback:(element:Int) ‑> Void, ?thisArg:Any):Void

forEach(callback:(element:Int, index:Int) ‑> Void, ?thisArg:Any):Void

Calls a function for each element in the array. See also Array.prototype.forEach().

includes(searchElement:Int, ?fromIndex:Int):Bool

Determines whether a typed array includes a certain element, returning true or false as appropriate. See also Array.prototype.includes().

indexOf(searchElement:Int, ?fromIndex:Int):Int

Returns the first (least) index of an element within the array equal to the specified value, or -1 if none is found. See also Array.prototype.indexOf().

join(?separator:String):String

Joins all elements of an array into a string. See also Array.prototype.join().

keys():Iterator<Int>

Returns a new Array Iterator that contains the keys for each index in the array. See also Array.prototype.keys().

lastIndexOf(searchElement:Int, ?fromIndex:Int):Int

Returns the last (greatest) index of an element within the array equal to the specified value, or -1 if none is found. See also Array.prototype.lastIndexOf().

map(callback:(element:Int, index:Int, array:Uint8ClampedArray) ‑> Int, ?thisArg:Any):Uint8ClampedArray

map(callback:(element:Int) ‑> Int, ?thisArg:Any):Uint8ClampedArray

map(callback:(element:Int, index:Int) ‑> Int, ?thisArg:Any):Uint8ClampedArray

Creates a new array with the results of calling a provided function on every element in this array. See also Array.prototype.map().

reduce<T>(callback:(previousValue:T, currentValue:Int, index:Int, array:Uint8ClampedArray) ‑> T, initialValue:T):T

reduce<T>(callback:(previousValue:T, currentValue:Int) ‑> T, initialValue:T):T

reduce<T>(callback:(previousValue:T, currentValue:Int, index:Int) ‑> T, initialValue:T):T

reduce(callbackfn:(previousValue:Int, currentValue:Int) ‑> Int):Int

reduce(callbackfn:(previousValue:Int, currentValue:Int, index:Int) ‑> Int):Int

reduce(callbackfn:(previousValue:Int, currentValue:Int, index:Int, array:Uint8ClampedArray) ‑> Int):Int

Apply a function against an accumulator and each value of the array (from left-to-right) as to reduce it to a single value. See also Array.prototype.reduce().

reduceRight<T>(callback:(previousValue:T, currentValue:Int, index:Int, array:Uint8ClampedArray) ‑> T, initialValue:T):T

reduceRight<T>(callback:(previousValue:T, currentValue:Int) ‑> T, initialValue:T):T

reduceRight<T>(callback:(previousValue:T, currentValue:Int, index:Int) ‑> T, initialValue:T):T

reduceRight(callbackfn:(previousValue:Int, currentValue:Int) ‑> Int):Int

reduceRight(callbackfn:(previousValue:Int, currentValue:Int, index:Int) ‑> Int):Int

reduceRight(callbackfn:(previousValue:Int, currentValue:Int, index:Int, array:Uint8ClampedArray) ‑> Int):Int

Apply a function against an accumulator and each value of the array (from right-to-left) as to reduce it to a single value. See also Array.prototype.reduceRight().

reverse():Uint8ClampedArray

Reverses the order of the elements of an array — the first becomes the last, and the last becomes the first. See also Array.prototype.reverse().

set(array:Array<Int>, ?offset:Int):Void

set(array:Int8Array, ?offset:Int):Void

set(array:Uint8Array, ?offset:Int):Void

set(array:Uint8ClampedArray, ?offset:Int):Void

set(array:Int16Array, ?offset:Int):Void

set(array:Uint16Array, ?offset:Int):Void

set(array:Int32Array, ?offset:Int):Void

set(array:Uint32Array, ?offset:Int):Void

set(array:Float32Array, ?offset:Int):Void

set(array:Float64Array, ?offset:Int):Void

Stores multiple values in the typed array, reading input values from a specified array.

slice(?start:Int, ?end:Int):Uint8ClampedArray

Extracts a section of an array and returns a new array. See also Array.prototype.slice().

some(callback:(element:Int, index:Int, array:Uint8ClampedArray) ‑> Bool, ?thisArg:Any):Bool

some(callback:(element:Int) ‑> Bool, ?thisArg:Any):Bool

some(callback:(element:Int, index:Int) ‑> Bool, ?thisArg:Any):Bool

Returns true if at least one element in this array satisfies the provided testing function. See also Array.prototype.some().

sort(?compareFn:(x:Int, y:Int) ‑> Int):Uint8ClampedArray

Sorts the elements of an array in place and returns the array. See also Array.prototype.sort().

subarray(?begin:Int, ?end:Int):Uint8ClampedArray

Returns a new TypedArray from the given start and end element index.

toLocaleString(?locales:String, ?options:Null<NumberFormatOptions>):String

Returns a string representing the array and its elements. See also Array.prototype.toString().

toString():String

Returns a string representing the array and its elements. See also Array.prototype.toString().

values():Iterator<Int>

Returns a new Array Iterator object that contains the values for each index in the array. See also Array.prototype.values().