mozIRepresentativeColorCallback

toolkit/components/places/mozIColorAnalyzer.idlScriptable

Provides callback methods for mozIColorAnalyzer

1.0

Introduced

Gecko 17.0

Inherits from: nsISupports Last changed in Gecko 17.0 (Firefox 17.0 / Thunderbird 17.0 / SeaMonkey 2.14)

Method overview

void onComplete(in boolean success, [optional] in unsigned long color);

Requires Gecko 17.0 (Firefox 17.0 / Thunderbird 17.0 / SeaMonkey 2.14)

Will be called when color analysis finishes.

void onComplete(
  in boolean success,
  [optional] in unsigned long color
);

success: True if analysis was successful, false otherwise. Analysis can fail if the image is transparent, imageURI doesn't resolve to a valid image, or the image is too big.
color: The representative color as an integer in RGB form. e.g. 0xFF0102 == rgb(255,1,2). If success is false, color is not provided.