Skip to content

Interface: BackgroundIr ​

A slide's background, already reduced to what the write API's background accepts.

data rather than image, because BackgroundProps is DataOrPathProps & ShapeFillProps and data is the key it actually reads. An image key would print, typecheck against IrValue, and be ignored at run time.

type, gradient and pattern are the ShapeFillProps keys a non-solid background is spelled with, the same values a shape's fill carries for the same elements. type: 'none' is a slide's explicit a:noFill, which turns its layout's background off.

Properties ​

color? ​

optional color?: string


data? ​

optional data?: AssetRef


gradient? ​

optional gradient?: IrValue


image? ​

optional image?: IrValue

A cropped picture: { data, crop }, the spelling that carries the crop. An uncropped one is data.


pattern? ​

optional pattern?: IrValue


transparency? ​

optional transparency?: number


type? ​

optional type?: "none" | "pattern" | "gradient"