Skip to main content

GetFill

Gets the fill properties from the current shape.

Syntax​

expression.GetFill();

expression - A variable that represents a ApiShape class.

Parameters​

This method doesn't have any parameters.

Returns​

ApiFill | null

Example​

Read the fill applied to a shape and report its type in a cell in a spreadsheet.

// How do I check what fill a shape is using in a spreadsheet?

// Retrieve the color or gradient covering a shape and display the fill type on the sheet in a spreadsheet.

let worksheet = Api.GetActiveSheet();
let gs1 = Api.CreateGradientStop(Api.CreateRGBColor(255, 213, 191), 0);
let gs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 111, 61), 100000);
let fill = Api.CreateLinearGradientFill([gs1, gs2], 5400000);
let stroke = Api.CreateStroke(0, Api.CreateNoFill());
let shape = worksheet.AddShape("rect", 60 * 36000, 40 * 36000, fill, stroke, 3, 0, 2, 2);
let retrievedFill = shape.GetFill();
if (retrievedFill) {
    worksheet.GetRange("A1").SetValue("Fill type: " + retrievedFill.GetType());
}