Link

Extract Images from PDF using Javascript

Table of contents

  1. Introduction
  2. Prerequisites
  3. Code Example
  4. Configuration Options
  5. Upload by URL
  6. Using Authentication
  7. Further details

Introduction

The following tutorial shows you how to extract images from PDFs using a hosted JPedal cloud API, such as:

Whilst all the above services can be accessed with plain old HTTP requests, this tutorial uses our open source Javascript IDRCloudClient which provides a simple Javascript wrapper around the REST API.

Prerequisites

To add the client to your project use will need to add the file idrcloudclient.js to your project and include the following line to access it:

<script src="path/to/idrcloudclient.js" type="text/javascript"></script>

Code Example

Here is a basic code example to extract images from PDFs. Configuration options and advanced features can be found below.

var endpoint = 'https://cloud.idrsolutions.com/cloud/' + IDRCloudClient.JPEDAL;
var parameters =  {
    //token: 'Token', //Required only when connecting to the IDRsolutions trial and cloud subscription service
    input: IDRCloudClient.UPLOAD,
    file: 'path/to/exampleFile.pdf',
    settings: '{"mode":"extractImages","type":"rawImages","format":"png"}'
}

function progressListener(e) {
    console.log(JSON.stringify(e));
}

function failureListener(e) {
    console.log(e);
    console.log('Failed!');
}

function successListener(e) {
    console.log(JSON.stringify(e));
    console.log('Download URL: ' + e.downloadUrl);
}

IDRCloudClient.convert({
    endpoint: endpoint,
    parameters: parameters,
    
    // The below are the available listeners
    progress: progressListener,
    success: successListener,
    failure: failureListener
});

An example using the Javascript client can be found here.

Configuration Options

The JPedal API accepts a stringified JSON object containing key value pair configuration options to customise your extraction. The settings should be added to the parameters array. A full list of the configuration options to extract images from PDFs can be found here.

settings: '{"key":"value","key":"value"}'

Upload by URL

As well as uploading a local file you can also provide a URL which the JPedal Microservice will download and then perform the extraction. To do this you should replace the input and file values in the parameters variable with the following.

input: IDRCloudClient.DOWNLOAD
url: 'http://exampleURL/exampleFile.pdf'

Using Authentication

If you have deployed your own JPedal Microservice that requires a username and password to extract images from PDFs, you will need to provide them with each conversion. These are provided by passing two variables named username and password to the convert method as shown below.

username: 'username',
password: 'password',

Further details

IDRCloudClient on GitHub
IDRCloudClient Online Example
JPedal Microservice API
JPedal Microservice Use

Still need help? Send us your questions.