Skip to main content

Delete

Deletes the specified drawing object.

note

This functionality is available in paid ONLYOFFICE Docs editions.

Syntax​

expression.Delete();

expression - A variable that represents a ApiDrawing class.

Parameters​

This method doesn't have any parameters.

Returns​

boolean

Example​

Remove a shape from the sheet and confirm the removal in a spreadsheet.

// How do I permanently delete a shape that was placed on a sheet in a spreadsheet?

// Verify that a shape is gone by reporting the outcome inside another shape in a spreadsheet.

const worksheet = Api.GetActiveSheet();

const fill1 = Api.CreateSolidFill(Api.RGB(80, 60, 100));
const fill2 = Api.CreateSolidFill(Api.RGB(60, 90, 80));
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const drawing1 = worksheet.AddShape(
	'rect',
	60 * 36000, 35 * 36000,
	fill1, stroke,
	0, 0, 0, 0
);
const drawing2 = worksheet.AddShape(
	'rect',
	60 * 36000, 35 * 36000,
	fill2, stroke,
	0, 0, 10, 0
);

const isDeleted = drawing1.Delete();

const content = drawing2.GetContent();
const paragraph = content.GetElement(0);
paragraph.AddText('The first shape was deleted: ' + isDeleted);