Interface ImageApiGetSplashscreenRequest

Request parameters for getSplashscreen operation in ImageApi.

Export

ImageApiGetSplashscreenRequest

interface ImageApiGetSplashscreenRequest {
    backgroundColor?: string;
    blur?: number;
    fillHeight?: number;
    fillWidth?: number;
    foregroundLayer?: string;
    format?: ImageFormat;
    height?: number;
    maxHeight?: number;
    maxWidth?: number;
    quality?: number;
    tag?: string;
    width?: number;
}

Index

Properties

backgroundColor? blur? fillHeight? fillWidth? foregroundLayer? format? height? maxHeight? maxWidth? quality? tag? width?

Properties

`Optional` `Readonly`backgroundColor

backgroundColor?: string

Apply a background color for transparent images.

Memberof

ImageApiGetSplashscreen

`Optional` `Readonly`blur

blur?: number

Blur image.

Memberof

ImageApiGetSplashscreen

`Optional` `Readonly`fillHeight

fillHeight?: number

Height of box to fill.

Memberof

ImageApiGetSplashscreen

`Optional` `Readonly`fillWidth

fillWidth?: number

Width of box to fill.

Memberof

ImageApiGetSplashscreen

`Optional` `Readonly`foregroundLayer

foregroundLayer?: string

Apply a foreground layer on top of the image.

Memberof

ImageApiGetSplashscreen

`Optional` `Readonly`format

format?: ImageFormat

Determines the output format of the image - original,gif,jpg,png.

Memberof

ImageApiGetSplashscreen

`Optional` `Readonly`height

height?: number

The fixed image height to return.

Memberof

ImageApiGetSplashscreen

`Optional` `Readonly`maxHeight

maxHeight?: number

The maximum image height to return.

Memberof

ImageApiGetSplashscreen

`Optional` `Readonly`maxWidth

maxWidth?: number

The maximum image width to return.

Memberof

ImageApiGetSplashscreen

`Optional` `Readonly`quality

quality?: number

Quality setting, from 0-100.

Memberof

ImageApiGetSplashscreen

`Optional` `Readonly`tag

tag?: string

Supply the cache tag from the item object to receive strong caching headers.

Memberof

ImageApiGetSplashscreen

`Optional` `Readonly`width

width?: number

The fixed image width to return.

Memberof

ImageApiGetSplashscreen

Interface ImageApiGetSplashscreenRequest

Export

Index

Properties

Properties

`Optional` `Readonly`backgroundColor

Memberof

`Optional` `Readonly`blur

Memberof

`Optional` `Readonly`fillHeight

Memberof

`Optional` `Readonly`fillWidth

Memberof

`Optional` `Readonly`foregroundLayer

Memberof

`Optional` `Readonly`format

Memberof

`Optional` `Readonly`height

Memberof

`Optional` `Readonly`maxHeight

Memberof

`Optional` `Readonly`maxWidth

Memberof

`Optional` `Readonly`quality

Memberof

`Optional` `Readonly`tag

Memberof

`Optional` `Readonly`width

Memberof

Settings

On This Page

Interface ImageApiGetSplashscreenRequest

Export

Index

Properties

Properties

Optional ReadonlybackgroundColor

Memberof

Optional Readonlyblur

Memberof

Optional ReadonlyfillHeight

Memberof

Optional ReadonlyfillWidth

Memberof

Optional ReadonlyforegroundLayer

Memberof

Optional Readonlyformat

Memberof

Optional Readonlyheight

Memberof

Optional ReadonlymaxHeight

Memberof

Optional ReadonlymaxWidth

Memberof

Optional Readonlyquality

Memberof

Optional Readonlytag

Memberof

Optional Readonlywidth

Memberof

Settings

On This Page

`Optional` `Readonly`backgroundColor

`Optional` `Readonly`blur

`Optional` `Readonly`fillHeight

`Optional` `Readonly`fillWidth

`Optional` `Readonly`foregroundLayer

`Optional` `Readonly`format

`Optional` `Readonly`height

`Optional` `Readonly`maxHeight

`Optional` `Readonly`maxWidth

`Optional` `Readonly`quality

`Optional` `Readonly`tag

`Optional` `Readonly`width