Skip to content
Spreadsheet Editor

GraphicBitmap

type GraphicBitmap = {
alpha?: Percentage;
desc?: string;
id: string;
mediaId: string;
name: string;
noChangeAspect?: boolean;
shape?: Shape;
srcRect?: RelativeRect;
stretchRect?: RelativeRect;
text?: TextBody;
type: "bitmap";
xfrm?: Xfrm;
};
Property Type Default value Description
alpha? Percentage 0 Opacity value (0-100, where 100 is fully opaque). Min 0 Max 100
desc? string undefined Optional description or alt text for the bitmap.
id string undefined Unique identifier for this bitmap object.
mediaId string undefined Reference to the media/image resource to use. See Workbook.images.
name string undefined Display name of the bitmap.
noChangeAspect? boolean undefined Whether to lock the aspect ratio when resizing.
shape? Shape undefined Visual styling properties (fill, line, effects, etc.).
srcRect? RelativeRect undefined Rectangle defining the source crop area of the image (relative coordinates).
stretchRect? RelativeRect undefined Rectangle defining how the image should be stretched (relative coordinates).
text? TextBody undefined Optional text content overlaid on the bitmap.
type "bitmap" undefined Type discriminator for bitmap graphics.
xfrm? Xfrm undefined 2D transformation (position, rotation, scale).