Class Image

constructor

• new Image(width?: number, height?: number, spectrum?: number): Image

  Parameters

  • width: number = 1
  • height: number = 1
  • spectrum: number = 1

  Returns Image

imageBase

loaded

data

• get data(): number[]

  The data buffer

  Returns number[]

height

• get height(): number

  The image height

  Returns number

length

• get length(): number

  The image data buffer length

  Returns number

spectrum

• get spectrum(): number

  The image spectrum

  Returns number

width

• get width(): number

  The image width

  Returns number

add

• add(other: number | Image): Image

  Parameters

  • other: number | Image

  Returns Image

applyFilters

• applyFilters(filters: any): Image

  Parameters

  • filters: any

  Returns Image

bloom

• bloom(): Image

  Returns Image

blutify

• blutify(): Image

  Returns Image

brightnessContrast

• brightnessContrast(properties: any): Image

  Parameters

  • properties: any

  Returns Image

clone

• clone(): Image

  Returns Image

colorAdjust

• colorAdjust(rgb: number[] | { b: number; g: number; r: number }): Image

  Parameters

  • rgb: number[] | { b: number; g: number; r: number }

  Returns Image

convolve

• convolve(kernel: Kernel): Image

  Parameters

  • kernel: Kernel

  Returns Image

copy

• copy(image: Image): Image

  Parameters

  • image: Image

  Returns Image

create

• create(w?: number, h?: number, s?: number): Image

  (Re)Create the image given its dimension

  Parameters

  • w: number = 1
  • h: number = 1
  • s: number = 1

  Returns Image

  this

crop

• crop(x: number, y: number, w: number, h: number): Image

  Parameters

  • x: number
  • y: number
  • w: number
  • h: number

  Returns Image

crop2

• crop2(x1: number, y1: number, x2: number, y2: number): Image

  Parameters

  • x1: number
  • y1: number
  • x2: number
  • y2: number

  Returns Image

desaturate

• desaturate(params?: any): Image

  Parameters

  • Optionalparams: any

  Returns Image

dispose

• dispose(): void

  Returns void

equalize

• equalize(): Image

  Histogram equalization

  Returns Image

eval

• eval(filters: any, codes: any): Image

  Parameters

  • filters: any
  • codes: any

  Returns Image

fill

• fill(data: number | number[]): Image

  Parameters

  • data: number | number[]

  Returns Image

forC

• forC(imgForC: (c: number) => void): Image

  Parameters

  • imgForC: (c: number) => void

  Returns Image

forInXY

• forInXY(mx: any, my: any, Mx: any, My: any, _forInXY: any): Image

  Parameters

  • mx: any
  • my: any
  • Mx: any
  • My: any
  • _forInXY: any

  Returns Image

forXY

• forXY(callback: (index: { i: number; x: number; y: number }) => void): Image

  Parameters

  • callback: (index: { i: number; x: number; y: number }) => void

  Returns Image

forXY2

• forXY2(callback: (x: number, y: number, data: number[]) => void): Image

  Parameters

  • callback: (x: number, y: number, data: number[]) => void

  Returns Image

forXYC

• forXYC(forxyc: any): Image

  Parameters

  • forxyc: any

  Returns Image

getHistogram

• getHistogram(length: any): void

  Parameters

  • length: any

  Returns void

getHTMLImage

• getHTMLImage(): HTMLImageElement

  Returns HTMLImageElement

getImageData

• getImageData(): ImageData

  Returns ImageData

grungy

• grungy(): Image

  Returns Image

index

• index(x: number, y?: number, c?: number): number

  Get the index given the specified value coordinate

  Parameters

  • x: number

    x-coordinate
  • y: number = 0

    y-coordinate
  • c: number = 0

    spectrum layer

  Returns number

lighten

• lighten(factor?: number): Image

  Lighten the image by a specific factor

  Parameters

  • factor: number = 0.1

    The lightening factor

  Returns Image

  this

lightVintage

• lightVintage(): Image

  Returns Image

load

• load(src: string): Promise<Image>

  Load an image from the given source file

  Parameters

  • src: string

  Returns Promise<Image>

love

• love(): Image

  Returns Image

multiply

• multiply(other: number | Image): Image

  Parameters

  • other: number | Image

  Returns Image

negative

• negative(max?: number): void

  Parameters

  • max: number = 255

  Returns void

output

• output(canvas: string | HTMLCanvasElement): Image

  Parameters

  • canvas: string | HTMLCanvasElement

    The HTMLCanvasElement, or its id.

  Returns Image

pixelate

• pixelate(p?: number | { pixelSize: number }): Image

  Parameters

  • p: number | { pixelSize: number } = 5

  Returns Image

repeat

• repeat(filter: any, n: any, params: any): Image

  Parameters

  • filter: any
  • n: any
  • params: any

  Returns Image

resize

• resize(w: number, h: number): Image

  Parameters

  • w: number
  • h: number

  Returns Image

saturation

• saturation(p?: number | { amount: number }): Image

  Change the image saturation

  Parameters

  • p: number | { amount: number } = 1

  Returns Image

selectiveSaturation

• selectiveSaturation(p: any): Image

  Parameters

  • p: any

  Returns Image

sepia

• sepia(): Image

  Returns Image

sharpen

• sharpen(amount: number | { amount: number; ker: Kernel }, ker?: Kernel): Image

  Parameters

  • amount: number | { amount: number; ker: Kernel }
  • Optionalker: Kernel

  Returns Image

subtract

• subtract(other: number | Image): Image

  Parameters

  • other: number | Image

  Returns Image

toDataURL

• toDataURL(): string

  Returns string

vintage

• vintage(): Image

  Returns Image

Staticload

• load(src: string): Promise<Image>

  Load an image

  Parameters

  • src: string

  Returns Promise<Image>