Skip to main content

Highlights

Function that, given an RGB image and a factor, returns an RGB image with the highlights progressively brightened or darkened by the factor, proportionally to their pre-edit lightness.

Syntax​

changeHighlights(image, factor)

Parameters​

  • image : HTMLImageElement
    The image element to change the highlights of.

  • factor : number
    The highlights adjustment factor (-100 to 100):

    • factor > 0: the image highlights gets increased by the factor.
    • factor < 0: the image highlights gets decreased by the factor.
    • factor = 0: the image does not change.

Return​

  • Promise : Promise<HTMLImageElement>
    A promise that resolves with the image element with adjusted highlights.

Throws​

  • Error
    Thrown if the specified highlights factor is outside the valid range.

Examples​

const editpix = new EditPix();

// image url
const url = "images/img.jpg";

// crate image
var image = new Image();
image.src = url;

// waiting image load
image.onload = () => {
    // change image contrast
    editpix.changeHighlights(image, 15)
        .then(resultImage => {
            // render modified image
            document.body.appendChild(resultImage);
        })
        .catch(error => { console.log(error) })
}