height

OverviewLink to this section

Sets the height of the browser window in CSS pixels. Unless fullPage is on, it is also the height of the image.

Values above 10,000 are capped at 10,000 and decimals are rounded. Zero, negative numbers and anything that is not a number fall back to 720. A number written as a string, such as "900", works too.

ExampleLink to this section

The same request with the SDK, with cURL and as the raw JSON body.

import { Url2Image } from '@url2image/sdk'

const { success, data, message } = await Url2Image({
    url: 'https://example.com',
    token: process.env.URL2IMAGE_TOKEN,
    options: {
        height: 1080
    }
})

Good to knowLink to this section

Related optionsLink to this section

• widthViewport width in pixels, up to 10000.
• fullPageCapture the whole scrollable page instead of just the viewport.

Every option, grouped, is in the options overview.