api/utils/render

Module rendering views as images

Description:

  • Module rendering views as images

Source:

Methods

(static) renderView(options, cb) → {void}

Description:

  • Function to render views as images

Source:
Parameters:
Name Type Description
options object

options required for rendering

Properties
Name Type Description
host string

the hostname
token string

the login token value
view string

the view to open
id string

the id of the block to capture screenshot of
savePath string

path where to save the screenshot
cbFn function

function called after opening the view
beforeScrnCbFn function

function called just before capturing the screenshot
dimensions object

the dimensions of the screenshot

Properties
Name Type Description
width number

the width of the screenshot
height number

the height of the screenshot
padding number

the padding value to subtract from the height of the screenshot
scale number

the scale(ppi) value of the screenshot
cb function

callback function called with the error value or the image data
Returns:

void

Type
void

(inner) fetchChromeExecutablePath() → {Promise}

Description:

  • Function to fetch Chrome executable

Source:
Returns:

Promise

Type
Promise

(inner) saveScreenshot(image, path, source) → {Promise}

Description:

  • Function to save screenshots

Source:
Parameters:
Name Type Description
image Buffer

image data to store
path String

path where image should be stored
source String

who provided image
Returns:

Promise

Type
Promise

(inner) timeout(ms) → {Promise}

Description:

  • Function to set a timeout

Source:
Parameters:
Name Type Description
ms number

Total milliseconds
Returns:

Promise

Type
Promise