# addImage

### Methods

#### (inner) addImage(imageData, format, x, y, width, height, alias, compression, rotation)

Source:
  - modules/addimage.js, line 783

Adds an Image to the PDF.

##### Parameters:

Name | Type | Description
--- | --- | ---
`imageData` | string | HTMLImageElement | HTMLCanvasElement | Uint8Array | RGBAData | imageData as base64 encoded DataUrl or Image-HTMLElement or Canvas-HTMLElement or object containing RGBA array (like output from canvas.getImageData).
`format` | string | format of file if filetype-recognition fails or in case of a Canvas-Element needs to be specified (default for Canvas is JPEG), e.g. 'JPEG', 'PNG', 'WEBP'
`x` | number | x Coordinate (in units declared at inception of PDF document) against left edge of the page
`y` | number | y Coordinate (in units declared at inception of PDF document) against upper edge of the page
`width` | number | width of the image (in units declared at inception of PDF document)
`height` | number | height of the Image (in units declared at inception of PDF document)
`alias` | string | alias of the image (if used multiple times)
`compression` | string | compression of the generated JPEG, can have the values 'NONE', 'FAST', 'MEDIUM' and 'SLOW'
`rotation` | number | rotation of the image in degrees (0-359)

##### Returns:

jsPDF

#### (inner) arrayBufferToBinaryString(ArrayBuffer) → {String}

Source:
  - modules/addimage.js, line 745

Convert the Buffer to a Binary String

##### Parameters:

Name | Type | Description
--- | --- | ---
`ArrayBuffer` | ArrayBuffer | ArrayBufferView | buffer or bufferView with ImageData

##### Returns:

Type
  String

#### (inner) binaryStringToUint8Array(BinaryString) → {Uint8Array}

Source:
  - modules/addimage.js, line 725

Convert Binary String to ArrayBuffer

##### Parameters:

Name | Type | Description
--- | --- | ---
`BinaryString` | string | with ImageData

##### Returns:

Type
  Uint8Array

#### (inner) convertBase64ToBinaryString(stringData) → {string}

Source:
  - modules/addimage.js, line 934

##### Parameters:

Name | Type | Description
--- | --- | ---
`stringData` | string |

##### Returns:

binary string

Type
  string

#### (inner) extractImageFromDataUrl(dataUrl) → {Array}

Source:
  - modules/addimage.js, line 638

Strips out and returns info from a valid base64 data URI

##### Parameters:

Name | Type | Description
--- | --- | ---
`dataUrl` | string | a valid data URI of format 'data:[][;base64],'

##### Returns:

an Array containing the following [0] the complete data URI [1] [2] format - the second part of the mime-type i.e 'png' in 'image/png' [4]

Type
  Array

#### (inner) getImageFileTypeByImageData(imageData, format) → {string}

Source:
  - modules/addimage.js, line 117

Recognize filetype of Image by magic-bytes

https://en.wikipedia.org/wiki/List_of_file_signatures

##### Parameters:

Name | Type | Description
--- | --- | ---
`imageData` | string | arraybuffer | imageData as binary String or arraybuffer
`format` | string | format of file if filetype-recognition fails, e.g. 'JPEG'

##### Returns:

filetype of Image

Type
  string

#### (inner) getImageProperties(imageData) → {Object}

Source:
  - modules/addimage.js, line 972

##### Parameters:

Name | Type | Description
--- | --- | ---
`imageData` | Object |

##### Returns:

Type
  Object

#### (inner) isArrayBuffer(object) → {boolean}

Source:
  - modules/addimage.js, line 685

Tests supplied object to determine if ArrayBuffer

##### Parameters:

Name | Type | Description
--- | --- | ---
`object` | Object | an Object

##### Returns:

Type
  boolean

#### (inner) isArrayBufferView(object) → {boolean}

Source:
  - modules/addimage.js, line 698

Tests supplied object to determine if it implements the ArrayBufferView (TypedArray) interface

##### Parameters:

Name | Type | Description
--- | --- | ---
`object` | Object | an Object

##### Returns:

Type
  boolean

#### (inner) sHashCode(data) → {string}

Source:
  - modules/addimage.js, line 567

##### Parameters:

Name | Type | Description
--- | --- | ---
`data` | string |

##### Returns:

Type
  string

#### (inner) supportsArrayBuffer() → {boolean}

Source:
  - modules/addimage.js, line 672

Check to see if ArrayBuffer is supported

##### Returns:

Type
  boolean

#### (inner) validateStringAsBase64(possible) → {boolean}

Source:
  - modules/addimage.js, line 594

Validates if given String is a valid Base64-String

##### Parameters:

Name | Type | Description
--- | --- | ---
`possible` | String | Base64-String

##### Returns:

Type
  boolean

### Type Definitions

#### RGBAData

Source:
  - modules/addimage.js, line 774

##### Properties:

Name | Type | Description
--- | --- | ---
`data` | Uint8ClampedArray | Single dimensional array of RGBA values. For example from canvas getImageData.
`width` | number | Image width as the data does not carry this information in itself.
`height` | number | Image height as the data does not carry this information in itself.

Possible parameter for addImage, an RGBA buffer with size.

##### Type:

- Object