Interface IRenderOptions

The options for the renderImage function.

interface IRenderOptions {
    height?: number;
    host: HTMLElement;
    mimeType: string;
    needsBackground?: string;
    source: string;
    unconfined?: boolean;
    width?: number;
}

Properties

height? host mimeType needsBackground? source unconfined? width?

Properties

Optional height

height?: number

The optional height for the image.

host

host: HTMLElement

The image node to update with the content.

mimeType

mimeType: string

The mime type for the image.

Optional needsBackground

needsBackground?: string

Whether an image requires a background for legibility.

source

source: string

The base64 encoded source for the image.

Optional unconfined

unconfined?: boolean

Whether the image should be unconfined.

Optional width

width?: number

The optional width for the image.

Settings

Member Visibility

Theme

On This Page

heighthostmimeTypeneedsBackgroundsourceunconfinedwidth