ApiLayout

class ApiLayout

Description

Class representing a slide layout.

Instance Methods

GetClassType(): layout

Returns the type of the ApiLayout class.

SetName(sName): boolean

Sets a name to the current layout.

AddObject(oDrawing): boolean

Adds an object (image, shape or chart) to the current slide layout.

RemoveObject(nPos, nCount): boolean

Removes objects (image, shape or chart) from the current slide layout.

SetBackground(oApiFill): boolean

Sets the background to the current slide layout.

ClearBackground(): boolean

Clears the slide layout background.

FollowMasterBackground(): boolean

Sets the master background as the background of the layout.

Copy(): ApiLayout | "null"

Creates a copy of the specified slide layout object.

Delete(): boolean

Deletes the specified object from the parent slide master if it exists.

Duplicate(nPos): ApiLayout | "null"

Creates a duplicate of the specified slide layout object, adds the new slide layout to the slide layout collection.

MoveTo(nPos): boolean

Moves the specified layout to a specific location within the same collection.

GetAllDrawings(): Drawing[]

Returns an array with all the drawing objects from the slide layout.

GetAllShapes(): ApiShape[]

Returns an array with all the shape objects from the slide layout.

GetAllImages(): ApiImage[]

Returns an array with all the image objects from the slide layout.

GetAllCharts(): ApiChart[]

Returns an array with all the chart objects from the slide layout.

GetAllOleObjects(): ApiOleObject[]

Returns an array with all the OLE objects from the slide layout.

GetMaster(): ApiMaster

Returns the parent slide master of the current layout.

ToJSON(bWriteMaster, bWriteTableStyles): JSON

Converts the ApiLayout object into the JSON object.

GetDrawingsByPlaceholderType(sType): Drawing[]

Gets drawings by placeholder type.

Get Help

  • If you have any questions about ONLYOFFICE Docs, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).