ApiMaster

class ApiMaster

Description

Class representing a slide master.

Instance Methods

GetClassType(): master

Returns the type of the ApiMaster class.

GetLayout(nPos): ApiLayout | "null"

Returns a layout of the specified slide master by its position.

AddLayout(nPos, oLayout): boolean

Adds a layout to the specified slide master.

RemoveLayout(nPos, nCount): boolean

Removes the layouts from the current slide master.

GetLayoutsCount(): number

Returns a number of layout objects.

AddObject(oDrawing): boolean

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

RemoveObject(nPos, nCount): boolean

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

SetBackground(oApiFill): boolean

Sets the background to the current slide master.

ClearBackground(): boolean

Clears the slide master background.

Copy(): ApiMaster | "null"

Creates a copy of the specified slide master object.

Duplicate(nPos): ApiMaster | "null"

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

Delete(): boolean

Deletes the specified object from the parent if it exists.

GetTheme(): ApiTheme | "null"

Returns a theme of the slide master.

SetTheme(oTheme): boolean

Sets a theme to the slide master.

GetAllDrawings(): Drawing[]

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

GetAllShapes(): ApiShape[]

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

GetAllImages(): ApiImage[]

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

GetAllCharts(): ApiChart[]

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

GetAllOleObjects(): ApiOleObject[]

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

ToJSON(bWriteTableStyles): JSON

Converts the ApiMaster 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).