DivoomJimp | node-divoom-timebox-evo

Hierarchy

Jimp
- DivoomJimp
  - DivoomJimpAnim
  - DivoomJimpStatic

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DivoomJimp(path: string, cb?: ImageCallback): Jimp
new DivoomJimp(urlOptions: URLOptions, cb?: ImageCallback): Jimp
new DivoomJimp(image: Jimp, cb?: ImageCallback): Jimp
new DivoomJimp(data: Buffer, cb?: ImageCallback): Jimp
new DivoomJimp(data: Bitmap, cb?: ImageCallback): Jimp
new DivoomJimp(w: number, h: number, cb?: ImageCallback): Jimp
new DivoomJimp(w: number, h: number, background?: number | string, cb?: ImageCallback): Jimp
new DivoomJimp(...args: any[]): Jimp

Inherited from Jimp.__new
- Defined in node_modules/jimp/jimp.d.ts:4
Parameters
- path: string
- Optional cb: ImageCallback
Returns Jimp
Inherited from Jimp.__new
- Defined in node_modules/jimp/jimp.d.ts:6
Parameters
- urlOptions: URLOptions
- Optional cb: ImageCallback
Returns Jimp
Inherited from Jimp.__new
- Defined in node_modules/jimp/jimp.d.ts:7
Parameters
- image: Jimp
- Optional cb: ImageCallback
Returns Jimp
Inherited from Jimp.__new
- Defined in node_modules/jimp/jimp.d.ts:8
Parameters
- data: Buffer
- Optional cb: ImageCallback
Returns Jimp
Inherited from Jimp.__new
- Defined in node_modules/jimp/jimp.d.ts:9
Parameters
- data: Bitmap
- Optional cb: ImageCallback
Returns Jimp
Inherited from Jimp.__new
- Defined in node_modules/jimp/jimp.d.ts:10
Parameters
- w: number
- h: number
- Optional cb: ImageCallback
Returns Jimp
Inherited from Jimp.__new
- Defined in node_modules/jimp/jimp.d.ts:11
Parameters
- w: number
- h: number
- Optional background: number | string
- Optional cb: ImageCallback
Returns Jimp
Inherited from Jimp.__new
- Defined in node_modules/jimp/jimp.d.ts:17
Parameters
- Rest ...args: any[]
Returns Jimp

Properties

AUTO

AUTO: -1

BLEND_DARKEN

BLEND_DARKEN: string

BLEND_DESTINATION_OVER

BLEND_DESTINATION_OVER: string

BLEND_DIFFERENCE

BLEND_DIFFERENCE: string

BLEND_EXCLUSION

BLEND_EXCLUSION: string

BLEND_HARDLIGHT

BLEND_HARDLIGHT: string

BLEND_LIGHTEN

BLEND_LIGHTEN: string

BLEND_MULTIPLY

BLEND_MULTIPLY: string

BLEND_OVERLAY

BLEND_OVERLAY: string

BLEND_SCREEN

BLEND_SCREEN: string

BLEND_SOURCE_OVER

BLEND_SOURCE_OVER: string

EDGE_CROP

EDGE_CROP: 3

EDGE_EXTEND

EDGE_EXTEND: 1

EDGE_WRAP

EDGE_WRAP: 2

FONT_SANS_10_BLACK

FONT_SANS_10_BLACK: string

FONT_SANS_128_BLACK

FONT_SANS_128_BLACK: string

FONT_SANS_128_WHITE

FONT_SANS_128_WHITE: string

FONT_SANS_12_BLACK

FONT_SANS_12_BLACK: string

FONT_SANS_14_BLACK

FONT_SANS_14_BLACK: string

FONT_SANS_16_BLACK

FONT_SANS_16_BLACK: string

FONT_SANS_16_WHITE

FONT_SANS_16_WHITE: string

FONT_SANS_32_BLACK

FONT_SANS_32_BLACK: string

FONT_SANS_32_WHITE

FONT_SANS_32_WHITE: string

FONT_SANS_64_BLACK

FONT_SANS_64_BLACK: string

FONT_SANS_64_WHITE

FONT_SANS_64_WHITE: string

FONT_SANS_8_BLACK

FONT_SANS_8_BLACK: string

FONT_SANS_8_WHITE

FONT_SANS_8_WHITE: string

HORIZONTAL_ALIGN_CENTER

HORIZONTAL_ALIGN_CENTER: 2

HORIZONTAL_ALIGN_LEFT

HORIZONTAL_ALIGN_LEFT: 1

HORIZONTAL_ALIGN_RIGHT

HORIZONTAL_ALIGN_RIGHT: 4

MIME_BMP

MIME_BMP: "image/bmp"

MIME_GIF

MIME_GIF: "image/gif"

MIME_JGD

MIME_JGD: "image/jgd"

MIME_JPEG

MIME_JPEG: "image/jpeg"

MIME_PNG

MIME_PNG: "image/png"

MIME_TIFF

MIME_TIFF: "image/tiff"

MIME_X_MS_BMP

MIME_X_MS_BMP: "image/x-ms-bmp"

PNG_FILTER_AUTO

PNG_FILTER_AUTO: -1

PNG_FILTER_AVERAGE

PNG_FILTER_AVERAGE: 3

PNG_FILTER_NONE

PNG_FILTER_NONE: 0

PNG_FILTER_PATH

PNG_FILTER_PATH: 4

PNG_FILTER_SUB

PNG_FILTER_SUB: 1

PNG_FILTER_UP

PNG_FILTER_UP: 2

RESIZE_BEZIER

RESIZE_BEZIER: "bezierInterpolation"

RESIZE_BICUBIC

RESIZE_BICUBIC: "bicubicInterpolation"

RESIZE_BILINEAR

RESIZE_BILINEAR: "bilinearInterpolation"

RESIZE_HERMITE

RESIZE_HERMITE: "hermiteInterpolation"

RESIZE_NEAREST_NEIGHBOR

RESIZE_NEAREST_NEIGHBOR: "nearestNeighbor"

VERTICAL_ALIGN_BOTTOM

VERTICAL_ALIGN_BOTTOM: 32

VERTICAL_ALIGN_MIDDLE

VERTICAL_ALIGN_MIDDLE: 16

VERTICAL_ALIGN_TOP

VERTICAL_ALIGN_TOP: 8

_background

_background: number

_deflateLevel

_deflateLevel: number

_deflateStrategy

_deflateStrategy: number

_filterType

_filterType: number

_originalMime

_originalMime: string

_quality

_quality: number

_rgba

_rgba: boolean

bitmap

bitmap: Bitmap

prototype

prototype: Jimp

Static Jimp

Jimp: Jimp

Methods

appendConstructorOption

appendConstructorOption<T>(name: string, test: function, run: function): void

Inherited from Jimp.appendConstructorOption
- Defined in node_modules/jimp/jimp.d.ts:332
Type parameters
- T: any[]
Parameters
- name: string
- test: function
  - - (...args: T[]): boolean
    - Parameters
      - Rest ...args: T[]
      Returns boolean
- run: function
  - - (this: Jimp, resolve: function, reject: function, ...args: T[]): any
    - Parameters
      - this: Jimp
      - resolve: function
        
        (jimp: Jimp): any
        
        Parameters
        
        jimp: Jimp
        
        Returns any
      - reject: function
        
        (reason: Error): any
        
        Parameters
        
        reason: Error
        
        Returns any
      - Rest ...args: T[]
      Returns any
Returns void

asBinaryBuffer

asBinaryBuffer(): Buffer[]

- Defined in drawing/jimp_overloads.ts:121
Returns Buffer[]

autocrop

autocrop(tolerance?: number, cb?: ImageCallback): this
autocrop(cropOnlyFrames?: boolean, cb?: ImageCallback): this
autocrop(tolerance?: number, cropOnlyFrames?: boolean, cb?: ImageCallback): this
autocrop(options: object, cb?: ImageCallback): this

Inherited from Jimp.autocrop
- Defined in node_modules/jimp/jimp.d.ts:256
Parameters
- Optional tolerance: number
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.autocrop
- Defined in node_modules/jimp/jimp.d.ts:257
Parameters
- Optional cropOnlyFrames: boolean
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.autocrop
- Defined in node_modules/jimp/jimp.d.ts:258
Parameters
- Optional tolerance: number
- Optional cropOnlyFrames: boolean
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.autocrop
- Defined in node_modules/jimp/jimp.d.ts:263
Parameters
- options: object
  - Optional cropOnlyFrames?: boolean
  - Optional cropSymmetric?: boolean
  - Optional leaveBorder?: number
  - Optional tolerance?: number
- Optional cb: ImageCallback
Returns this

background

background(hex: number, cb?: ImageCallback): this

Inherited from Jimp.background
- Defined in node_modules/jimp/jimp.d.ts:161
Parameters
- hex: number
- Optional cb: ImageCallback
Returns this

backgroundQuiet

backgroundQuiet(hex: number, cb?: ImageCallback): this

Inherited from Jimp.backgroundQuiet
- Defined in node_modules/jimp/jimp.d.ts:162
Parameters
- hex: number
- Optional cb: ImageCallback
Returns this

blit

blit(src: Jimp, x: number, y: number, cb?: ImageCallback): this
blit(src: Jimp, x: number, y: number, srcx: number, srcy: number, srcw: number, srch: number, cb?: ImageCallback): this

Inherited from Jimp.blit
- Defined in node_modules/jimp/jimp.d.ts:318
Parameters
- src: Jimp
- x: number
- y: number
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.blit
- Defined in node_modules/jimp/jimp.d.ts:319
Parameters
- src: Jimp
- x: number
- y: number
- srcx: number
- srcy: number
- srcw: number
- srch: number
- Optional cb: ImageCallback
Returns this

blur

blur(r: number, cb?: ImageCallback): this

Inherited from Jimp.blur
- Defined in node_modules/jimp/jimp.d.ts:300
Parameters
- r: number
- Optional cb: ImageCallback
Returns this

brightness

brightness(val: number, cb?: ImageCallback): this

Inherited from Jimp.brightness
- Defined in node_modules/jimp/jimp.d.ts:189
Parameters
- val: number
- Optional cb: ImageCallback
Returns this

clone

clone(cb?: ImageCallback): this

Inherited from Jimp.clone
- Defined in node_modules/jimp/jimp.d.ts:159
Parameters
- Optional cb: ImageCallback
Returns this

cloneQuiet

cloneQuiet(cb?: ImageCallback): this

Inherited from Jimp.cloneQuiet
- Defined in node_modules/jimp/jimp.d.ts:160
Parameters
- Optional cb: ImageCallback
Returns this

color

color(actions: ColorAction[], cb?: ImageCallback): this

Inherited from Jimp.color
- Defined in node_modules/jimp/jimp.d.ts:222
Parameters
- actions: ColorAction[]
- Optional cb: ImageCallback
Returns this

colorDiff

colorDiff(rgba1: RGB, rgba2: RGB): number
colorDiff(rgba1: RGBA, rgba2: RGBA): number

Inherited from Jimp.colorDiff
- Defined in node_modules/jimp/jimp.d.ts:370
Parameters
- rgba1: RGB
- rgba2: RGB
Returns number
Inherited from Jimp.colorDiff
- Defined in node_modules/jimp/jimp.d.ts:371
Parameters
- rgba1: RGBA
- rgba2: RGBA
Returns number

colorType

colorType(s: number, cb?: ImageCallback): this

Inherited from Jimp.colorType
- Defined in node_modules/jimp/jimp.d.ts:123
Parameters
- s: number
- Optional cb: ImageCallback
Returns this

colour

colour(actions: ColorAction[], cb?: ImageCallback): this

Inherited from Jimp.colour
- Defined in node_modules/jimp/jimp.d.ts:223
Parameters
- actions: ColorAction[]
- Optional cb: ImageCallback
Returns this

compareHashes

compareHashes(hash1: string, hash2: string): number

Inherited from Jimp.compareHashes
- Defined in node_modules/jimp/jimp.d.ts:369
Parameters
- hash1: string
- hash2: string
Returns number

composite

composite(src: Jimp, x: number, y: number, options?: BlendMode, cb?: ImageCallback): this

Inherited from Jimp.composite
- Defined in node_modules/jimp/jimp.d.ts:311
Parameters
- src: Jimp
- x: number
- y: number
- Optional options: BlendMode
- Optional cb: ImageCallback
Returns this

contain

contain(w: number, h: number, cb?: ImageCallback): this
contain(w: number, h: number, mode?: string, cb?: ImageCallback): this
contain(w: number, h: number, alignBits?: number, cb?: ImageCallback): this
contain(w: number, h: number, alignBits?: number, mode?: string, cb?: ImageCallback): this

Inherited from Jimp.contain
- Defined in node_modules/jimp/jimp.d.ts:241
Parameters
- w: number
- h: number
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.contain
- Defined in node_modules/jimp/jimp.d.ts:242
Parameters
- w: number
- h: number
- Optional mode: string
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.contain
- Defined in node_modules/jimp/jimp.d.ts:243
Parameters
- w: number
- h: number
- Optional alignBits: number
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.contain
- Defined in node_modules/jimp/jimp.d.ts:244
Parameters
- w: number
- h: number
- Optional alignBits: number
- Optional mode: string
- Optional cb: ImageCallback
Returns this

contrast

contrast(val: number, cb?: ImageCallback): this

Inherited from Jimp.contrast
- Defined in node_modules/jimp/jimp.d.ts:190
Parameters
- val: number
- Optional cb: ImageCallback
Returns this

convolute

convolute(kernel: number[][], cb?: ImageCallback): this
convolute(kernel: number[][], x: number, y: number, w: number, h: number, cb?: ImageCallback): this

Inherited from Jimp.convolute
- Defined in node_modules/jimp/jimp.d.ts:213
Parameters
- kernel: number[][]
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.convolute
- Defined in node_modules/jimp/jimp.d.ts:214
Parameters
- kernel: number[][]
- x: number
- y: number
- w: number
- h: number
- Optional cb: ImageCallback
Returns this

convolution

convolution(kernel: number[][], cb?: ImageCallback): this
convolution<T>(kernel: number[][], edgeHandling: string, cb?: ImageCallback): this

Inherited from Jimp.convolution
- Defined in node_modules/jimp/jimp.d.ts:197
Parameters
- kernel: number[][]
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.convolution
- Defined in node_modules/jimp/jimp.d.ts:198
Type parameters
- T
Parameters
- kernel: number[][]
- edgeHandling: string
- Optional cb: ImageCallback
Returns this

cover

cover(w: number, h: number, cb?: ImageCallback): this
cover(w: number, h: number, alignBits?: number, cb?: ImageCallback): this
cover(w: number, h: number, alignBits?: number, mode?: string, cb?: ImageCallback): this

Inherited from Jimp.cover
- Defined in node_modules/jimp/jimp.d.ts:232
Parameters
- w: number
- h: number
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.cover
- Defined in node_modules/jimp/jimp.d.ts:233
Parameters
- w: number
- h: number
- Optional alignBits: number
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.cover
- Defined in node_modules/jimp/jimp.d.ts:234
Parameters
- w: number
- h: number
- Optional alignBits: number
- Optional mode: string
- Optional cb: ImageCallback
Returns this

create

create(path: string): Promise<Jimp>
create(image: Jimp): Promise<Jimp>
create(data: Buffer): Promise<Jimp>
create(w: number, h: number, background?: number | string): Promise<Jimp>

Inherited from Jimp.create
- Defined in node_modules/jimp/jimp.d.ts:346
Parameters
- path: string
Returns Promise<Jimp>
Inherited from Jimp.create
- Defined in node_modules/jimp/jimp.d.ts:347
Parameters
- image: Jimp
Returns Promise<Jimp>
Inherited from Jimp.create
- Defined in node_modules/jimp/jimp.d.ts:348
Parameters
- data: Buffer
Returns Promise<Jimp>
Inherited from Jimp.create
- Defined in node_modules/jimp/jimp.d.ts:349
Parameters
- w: number
- h: number
- Optional background: number | string
Returns Promise<Jimp>

crop

crop(x: number, y: number, w: number, h: number, cb?: ImageCallback): this

Inherited from Jimp.crop
- Defined in node_modules/jimp/jimp.d.ts:179
Parameters
- x: number
- y: number
- w: number
- h: number
- Optional cb: ImageCallback
Returns this

cropQuiet

cropQuiet(x: number, y: number, w: number, h: number, cb?: ImageCallback): this

Inherited from Jimp.cropQuiet
- Defined in node_modules/jimp/jimp.d.ts:180
Parameters
- x: number
- y: number
- w: number
- h: number
- Optional cb: ImageCallback
Returns this

cssColorToHex

cssColorToHex(cssColor: string): number

Inherited from Jimp.cssColorToHex
- Defined in node_modules/jimp/jimp.d.ts:358
Parameters
- cssColor: string
Returns number

deflateLevel

deflateLevel(l: number, cb?: ImageCallback): this

Inherited from Jimp.deflateLevel
- Defined in node_modules/jimp/jimp.d.ts:121
Parameters
- l: number
- Optional cb: ImageCallback
Returns this

deflateStrategy

deflateStrategy(s: number, cb?: ImageCallback): this

Inherited from Jimp.deflateStrategy
- Defined in node_modules/jimp/jimp.d.ts:122
Parameters
- s: number
- Optional cb: ImageCallback
Returns this

diff

diff(img1: Jimp, img2: Jimp, threshold?: number): object

Inherited from Jimp.diff
- Defined in node_modules/jimp/jimp.d.ts:360
Parameters
- img1: Jimp
- img2: Jimp
- Optional threshold: number
Returns object
- image: Jimp
- percent: number

displace

displace(map: Jimp, offset: number, cb?: ImageCallback): this

Inherited from Jimp.displace
- Defined in node_modules/jimp/jimp.d.ts:255
Parameters
- map: Jimp
- offset: number
- Optional cb: ImageCallback
Returns this

distance

distance(img1: Jimp, img2: Jimp): number

Inherited from Jimp.distance
- Defined in node_modules/jimp/jimp.d.ts:368
Parameters
- img1: Jimp
- img2: Jimp
Returns number

distanceFromHash

distanceFromHash(hash: string): number

Inherited from Jimp.distanceFromHash
- Defined in node_modules/jimp/jimp.d.ts:118
Parameters
- hash: string
Returns number

dither16

dither16(cb?: ImageCallback): this

Inherited from Jimp.dither16
- Defined in node_modules/jimp/jimp.d.ts:302
Parameters
- Optional cb: ImageCallback
Returns this

dither565

dither565(cb?: ImageCallback): this

Inherited from Jimp.dither565
- Defined in node_modules/jimp/jimp.d.ts:301
Parameters
- Optional cb: ImageCallback
Returns this

fade

fade(f: number, cb?: ImageCallback): this

Inherited from Jimp.fade
- Defined in node_modules/jimp/jimp.d.ts:196
Parameters
- f: number
- Optional cb: ImageCallback
Returns this

filterType

filterType(f: number, cb?: ImageCallback): this

Inherited from Jimp.filterType
- Defined in node_modules/jimp/jimp.d.ts:124
Parameters
- f: number
- Optional cb: ImageCallback
Returns this

flip

flip(horizontal: boolean, vertical: boolean, cb?: ImageCallback): this

Inherited from Jimp.flip
- Defined in node_modules/jimp/jimp.d.ts:228
Parameters
- horizontal: boolean
- vertical: boolean
- Optional cb: ImageCallback
Returns this

gaussian

gaussian(r: number, cb?: ImageCallback): this

Inherited from Jimp.gaussian
- Defined in node_modules/jimp/jimp.d.ts:310
Parameters
- r: number
- Optional cb: ImageCallback
Returns this

getBase64

getBase64(mime: string, cb: GenericCallback<string, any, this>): this

Inherited from Jimp.getBase64
- Defined in node_modules/jimp/jimp.d.ts:127
Parameters
- mime: string
- cb: GenericCallback<string, any, this>
Returns this

getBase64Async

getBase64Async(mime: string): Promise<string>

Inherited from Jimp.getBase64Async
- Defined in node_modules/jimp/jimp.d.ts:128
Parameters
- mime: string
Returns Promise<string>

getBuffer

getBuffer(mime: string, cb: GenericCallback<Buffer>): this

Inherited from Jimp.getBuffer
- Defined in node_modules/jimp/jimp.d.ts:134
Parameters
- mime: string
- cb: GenericCallback<Buffer>
Returns this

getBufferAsync

getBufferAsync(mime: string): Promise<Buffer>

Inherited from Jimp.getBufferAsync
- Defined in node_modules/jimp/jimp.d.ts:135
Parameters
- mime: string
Returns Promise<Buffer>

getColorsAndPixels

getColorsAndPixels(): object

- Defined in drawing/jimp_overloads.ts:71
Returns object
- colors: string[]
- pixels: number[]

getExtension

getExtension(): string

Inherited from Jimp.getExtension
- Defined in node_modules/jimp/jimp.d.ts:117
Returns string

getHeight

getHeight(): number

Inherited from Jimp.getHeight
- Defined in node_modules/jimp/jimp.d.ts:112
Returns number

getMIME

getMIME(): string

Inherited from Jimp.getMIME
- Defined in node_modules/jimp/jimp.d.ts:116
Returns string

getPixelColor

getPixelColor(x: number, y: number, cb?: GenericCallback<number, any, this>): number

Inherited from Jimp.getPixelColor
- Defined in node_modules/jimp/jimp.d.ts:147
Parameters
- x: number
- y: number
- Optional cb: GenericCallback<number, any, this>
Returns number

getPixelColour

getPixelColour(x: number, y: number, cb?: GenericCallback<number, any, this>): number

Inherited from Jimp.getPixelColour
- Defined in node_modules/jimp/jimp.d.ts:152
Parameters
- x: number
- y: number
- Optional cb: GenericCallback<number, any, this>
Returns number

getPixelIndex

getPixelIndex(x: number, y: number, cb?: GenericCallback<number, any, this>): number
getPixelIndex(x: number, y: number, edgeHandling: string, cb?: GenericCallback<number, any, this>): number

Inherited from Jimp.getPixelIndex
- Defined in node_modules/jimp/jimp.d.ts:136
Parameters
- x: number
- y: number
- Optional cb: GenericCallback<number, any, this>
Returns number
Inherited from Jimp.getPixelIndex
- Defined in node_modules/jimp/jimp.d.ts:141
Parameters
- x: number
- y: number
- edgeHandling: string
- Optional cb: GenericCallback<number, any, this>
Returns number

getPixelString

getPixelString(pixelArray: number[], nbColors: number): string

- Defined in drawing/jimp_overloads.ts:100
This builds the pixel string to use in a message

Parameters
- pixelArray: number[]
  
  the pixel array, each item being a reference to the color in the color array
- nbColors: number
  
  the number of colors in the colors array
Returns string

the pixel sting to use in a message

getWidth

getWidth(): number

Inherited from Jimp.getWidth
- Defined in node_modules/jimp/jimp.d.ts:113
Returns number

grayscale

grayscale(cb?: ImageCallback): this

Inherited from Jimp.grayscale
- Defined in node_modules/jimp/jimp.d.ts:193
Parameters
- Optional cb: ImageCallback
Returns this

greyscale

greyscale(cb?: ImageCallback): this

Inherited from Jimp.greyscale
- Defined in node_modules/jimp/jimp.d.ts:192
Parameters
- Optional cb: ImageCallback
Returns this

hasAlpha

hasAlpha(): boolean

Inherited from Jimp.hasAlpha
- Defined in node_modules/jimp/jimp.d.ts:111
Returns boolean

hash

hash(cb?: GenericCallback<string, any, this>): this
hash(base: number | null | undefined, cb?: GenericCallback<string, any, this>): this

Inherited from Jimp.hash
- Defined in node_modules/jimp/jimp.d.ts:129
Parameters
- Optional cb: GenericCallback<string, any, this>
Returns this
Inherited from Jimp.hash
- Defined in node_modules/jimp/jimp.d.ts:130
Parameters
- base: number | null | undefined
- Optional cb: GenericCallback<string, any, this>
Returns this

histogram

histogram(): object

Inherited from Jimp.histogram
- Defined in node_modules/jimp/jimp.d.ts:303
Returns object
- b: number[]
- g: number[]
- r: number[]

inspect

inspect(): string

Inherited from Jimp.inspect
- Defined in node_modules/jimp/jimp.d.ts:114
Returns string

intToRGBA

intToRGBA(i: number, cb?: GenericCallback<RGBA>): RGBA

Inherited from Jimp.intToRGBA
- Defined in node_modules/jimp/jimp.d.ts:357
Parameters
- i: number
- Optional cb: GenericCallback<RGBA>
Returns RGBA

invert

invert(cb?: ImageCallback): this

Inherited from Jimp.invert
- Defined in node_modules/jimp/jimp.d.ts:309
Parameters
- Optional cb: ImageCallback
Returns this

limit255

limit255(n: number): number

Inherited from Jimp.limit255
- Defined in node_modules/jimp/jimp.d.ts:359
Parameters
- n: number
Returns number

loadFont

loadFont(file: string): Promise<Font>
loadFont(file: string, cb: GenericCallback<Font, any, any>): Promise<never>

Inherited from Jimp.loadFont
- Defined in node_modules/jimp/jimp.d.ts:372
Parameters
- file: string
Returns Promise<Font>
Inherited from Jimp.loadFont
- Defined in node_modules/jimp/jimp.d.ts:373
Parameters
- file: string
- cb: GenericCallback<Font, any, any>
Returns Promise<never>

mask

mask(src: Jimp, x: number, y: number, cb?: ImageCallback): this

Inherited from Jimp.mask
- Defined in node_modules/jimp/jimp.d.ts:329
Parameters
- src: Jimp
- x: number
- y: number
- Optional cb: ImageCallback
Returns this

measureText

measureText(font: Font, text: PrintableText): number

Inherited from Jimp.measureText
- Defined in node_modules/jimp/jimp.d.ts:374
Parameters
- font: Font
- text: PrintableText
Returns number

measureTextHeight

measureTextHeight(font: Font, text: PrintableText, maxWidth: number): number

Inherited from Jimp.measureTextHeight
- Defined in node_modules/jimp/jimp.d.ts:375
Parameters
- font: Font
- text: PrintableText
- maxWidth: number
Returns number

mirror

mirror(horizontal: boolean, vertical: boolean, cb?: ImageCallback): this

Inherited from Jimp.mirror
- Defined in node_modules/jimp/jimp.d.ts:229
Parameters
- horizontal: boolean
- vertical: boolean
- Optional cb: ImageCallback
Returns this

normalize

normalize(cb?: ImageCallback): this

Inherited from Jimp.normalize
- Defined in node_modules/jimp/jimp.d.ts:308
Parameters
- Optional cb: ImageCallback
Returns this

on

on<T>(event: T, cb: function): any

Inherited from Jimp.on
- Defined in node_modules/jimp/jimp.d.ts:102
Type parameters
- T: ListenableName
Parameters
- event: T
- cb: function
  - - (data: ListenerData<T>): any
    - Parameters
      - data: ListenerData<T>
      Returns any
Returns any

opacity

opacity(f: number, cb?: ImageCallback): this

Inherited from Jimp.opacity
- Defined in node_modules/jimp/jimp.d.ts:194
Parameters
- f: number
- Optional cb: ImageCallback
Returns this

opaque

opaque(cb?: ImageCallback): this

Inherited from Jimp.opaque
- Defined in node_modules/jimp/jimp.d.ts:203
Parameters
- Optional cb: ImageCallback
Returns this

parseBitmap

parseBitmap(data: Buffer, path: string | null | undefined, cb?: ImageCallback): void

Inherited from Jimp.parseBitmap
- Defined in node_modules/jimp/jimp.d.ts:106
Parameters
- data: Buffer
- path: string | null | undefined
- Optional cb: ImageCallback
Returns void

pixelate

pixelate(size: number, cb?: ImageCallback): this
pixelate(size: number, x: number, y: number, w: number, h: number, cb?: ImageCallback): this

Inherited from Jimp.pixelate
- Defined in node_modules/jimp/jimp.d.ts:204
Parameters
- size: number
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.pixelate
- Defined in node_modules/jimp/jimp.d.ts:205
Parameters
- size: number
- x: number
- y: number
- w: number
- h: number
- Optional cb: ImageCallback
Returns this

posterize

posterize(n: number, cb?: ImageCallback): this

Inherited from Jimp.posterize
- Defined in node_modules/jimp/jimp.d.ts:191
Parameters
- n: number
- Optional cb: ImageCallback
Returns this

print

print(font: Font, x: number, y: number, text: PrintableText, cb?: ImageCallback): this
print(font: Font, x: number, y: number, text: PrintableText, maxWidth?: number, cb?: ImageCallback): this
print(font: Font, x: number, y: number, text: PrintableText, maxWidth?: number, maxHeight?: number, cb?: ImageCallback): this

Inherited from Jimp.print
- Defined in node_modules/jimp/jimp.d.ts:274
Parameters
- font: Font
- x: number
- y: number
- text: PrintableText
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.print
- Defined in node_modules/jimp/jimp.d.ts:281
Parameters
- font: Font
- x: number
- y: number
- text: PrintableText
- Optional maxWidth: number
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.print
- Defined in node_modules/jimp/jimp.d.ts:289
Parameters
- font: Font
- x: number
- y: number
- text: PrintableText
- Optional maxWidth: number
- Optional maxHeight: number
- Optional cb: ImageCallback
Returns this

quality

quality(n: number, cb?: ImageCallback): this

Inherited from Jimp.quality
- Defined in node_modules/jimp/jimp.d.ts:126
Parameters
- n: number
- Optional cb: ImageCallback
Returns this

read

read(path: string): Promise<Jimp>
read(image: Jimp): Promise<Jimp>
read(data: Buffer): Promise<Jimp>
read(w: number, h: number, background?: number | string): Promise<Jimp>

Inherited from Jimp.read
- Defined in node_modules/jimp/jimp.d.ts:342
Parameters
- path: string
Returns Promise<Jimp>
Inherited from Jimp.read
- Defined in node_modules/jimp/jimp.d.ts:343
Parameters
- image: Jimp
Returns Promise<Jimp>
Inherited from Jimp.read
- Defined in node_modules/jimp/jimp.d.ts:344
Parameters
- data: Buffer
Returns Promise<Jimp>
Inherited from Jimp.read
- Defined in node_modules/jimp/jimp.d.ts:345
Parameters
- w: number
- h: number
- Optional background: number | string
Returns Promise<Jimp>

resize

resize(w: number, h: number, cb?: ImageCallback): this
resize(w: number, h: number, mode?: string, cb?: ImageCallback): this

Inherited from Jimp.resize
- Defined in node_modules/jimp/jimp.d.ts:230
Parameters
- w: number
- h: number
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.resize
- Defined in node_modules/jimp/jimp.d.ts:231
Parameters
- w: number
- h: number
- Optional mode: string
- Optional cb: ImageCallback
Returns this

rgba

rgba(bool: boolean, cb?: ImageCallback): this

Inherited from Jimp.rgba
- Defined in node_modules/jimp/jimp.d.ts:125
Parameters
- bool: boolean
- Optional cb: ImageCallback
Returns this

rgbaToInt

rgbaToInt(r: number, g: number, b: number, a: number, cb: GenericCallback<number, any, Jimp>): number

Inherited from Jimp.rgbaToInt
- Defined in node_modules/jimp/jimp.d.ts:350
Parameters
- r: number
- g: number
- b: number
- a: number
- cb: GenericCallback<number, any, Jimp>
Returns number

rotate

rotate(deg: number, cb?: ImageCallback): this
rotate(deg: number, mode: string | boolean, cb?: ImageCallback): this

Inherited from Jimp.rotate
- Defined in node_modules/jimp/jimp.d.ts:226
Parameters
- deg: number
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.rotate
- Defined in node_modules/jimp/jimp.d.ts:227
Parameters
- deg: number
- mode: string | boolean
- Optional cb: ImageCallback
Returns this

scale

scale(f: number, cb?: ImageCallback): this
scale(f: number, mode?: string, cb?: ImageCallback): this

Inherited from Jimp.scale
- Defined in node_modules/jimp/jimp.d.ts:251
Parameters
- f: number
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.scale
- Defined in node_modules/jimp/jimp.d.ts:252
Parameters
- f: number
- Optional mode: string
- Optional cb: ImageCallback
Returns this

scaleToFit

scaleToFit(w: number, h: number, cb?: ImageCallback): this
scaleToFit(w: number, h: number, mode?: string, cb?: ImageCallback): this

Inherited from Jimp.scaleToFit
- Defined in node_modules/jimp/jimp.d.ts:253
Parameters
- w: number
- h: number
- Optional cb: ImageCallback
Returns this
Inherited from Jimp.scaleToFit
- Defined in node_modules/jimp/jimp.d.ts:254
Parameters
- w: number
- h: number
- Optional mode: string
- Optional cb: ImageCallback
Returns this

scan

scan(x: number, y: number, w: number, h: number, f: function, cb?: ImageCallback): this

Inherited from Jimp.scan
- Defined in node_modules/jimp/jimp.d.ts:163
Parameters
- x: number
- y: number
- w: number
- h: number
- f: function
  - - (this: this, x: number, y: number, idx: number): any
    - Parameters
      - this: this
      - x: number
      - y: number
      - idx: number
      Returns any
- Optional cb: ImageCallback
Returns this

scanQuiet

scanQuiet(x: number, y: number, w: number, h: number, f: function, cb?: ImageCallback): this

Inherited from Jimp.scanQuiet
- Defined in node_modules/jimp/jimp.d.ts:171
Parameters
- x: number
- y: number
- w: number
- h: number
- f: function
  - - (this: this, x: number, y: number, idx: number): any
    - Parameters
      - this: this
      - x: number
      - y: number
      - idx: number
      Returns any
- Optional cb: ImageCallback
Returns this

sepia

sepia(cb?: ImageCallback): this

Inherited from Jimp.sepia
- Defined in node_modules/jimp/jimp.d.ts:195
Parameters
- Optional cb: ImageCallback
Returns this

setPixelColor

setPixelColor(hex: number, x: number, y: number, cb?: ImageCallback): this

Inherited from Jimp.setPixelColor
- Defined in node_modules/jimp/jimp.d.ts:157
Parameters
- hex: number
- x: number
- y: number
- Optional cb: ImageCallback
Returns this

setPixelColour

setPixelColour(hex: number, x: number, y: number, cb?: ImageCallback): this

Inherited from Jimp.setPixelColour
- Defined in node_modules/jimp/jimp.d.ts:158
Parameters
- hex: number
- x: number
- y: number
- Optional cb: ImageCallback
Returns this

toString

toString(): string

Inherited from Jimp.toString
- Defined in node_modules/jimp/jimp.d.ts:115
Returns string

write

write(path: string, cb?: ImageCallback): this

Inherited from Jimp.write
- Defined in node_modules/jimp/jimp.d.ts:119
Parameters
- path: string
- Optional cb: ImageCallback
Returns this

writeAsync

writeAsync(path: string): Promise<Jimp>

Inherited from Jimp.writeAsync
- Defined in node_modules/jimp/jimp.d.ts:120
Parameters
- path: string
Returns Promise<Jimp>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

path: string

Optional cb: ImageCallback

Returns Jimp

Parameters

urlOptions: URLOptions

Optional cb: ImageCallback

Returns Jimp

Parameters

image: Jimp

Optional cb: ImageCallback

Returns Jimp

Parameters

data: Buffer

Optional cb: ImageCallback

Returns Jimp

Parameters

data: Bitmap

Optional cb: ImageCallback

Returns Jimp

Parameters

w: number

h: number

Optional cb: ImageCallback

Returns Jimp

Parameters

w: number

h: number

Optional background: number | string

Optional cb: ImageCallback

Returns Jimp

Parameters

Rest ...args: any[]

Returns Jimp

Properties

AUTO

BLEND_DARKEN

BLEND_DESTINATION_OVER

BLEND_DIFFERENCE

BLEND_EXCLUSION

BLEND_HARDLIGHT

BLEND_LIGHTEN

BLEND_MULTIPLY

BLEND_OVERLAY

BLEND_SCREEN

BLEND_SOURCE_OVER

EDGE_CROP

EDGE_EXTEND

EDGE_WRAP

FONT_SANS_10_BLACK

FONT_SANS_128_BLACK

FONT_SANS_128_WHITE

FONT_SANS_12_BLACK

FONT_SANS_14_BLACK

FONT_SANS_16_BLACK

FONT_SANS_16_WHITE

FONT_SANS_32_BLACK

FONT_SANS_32_WHITE

FONT_SANS_64_BLACK

FONT_SANS_64_WHITE

FONT_SANS_8_BLACK

FONT_SANS_8_WHITE

HORIZONTAL_ALIGN_CENTER

HORIZONTAL_ALIGN_LEFT

HORIZONTAL_ALIGN_RIGHT

MIME_BMP

MIME_GIF

MIME_JGD

MIME_JPEG

MIME_PNG

MIME_TIFF

MIME_X_MS_BMP

PNG_FILTER_AUTO