Api

The main class of the Presentation API. Use it to get the current presentation and to create slides and slide elements, such as shapes, images, tables, and charts.

Methods

The following table lists the available methods.

Method	Returns	Description
CentimetersToPoints	number	Converts centimeters to points.
Color	ApiColor	Creates an ApiColor from a universal input.
CreateBlipFill	ApiFill	Creates a blip fill to apply to the object using the selected image as the object background.
CreateBullet	ApiBullet	Creates a bullet for a paragraph with the character or symbol specified with the sSymbol parameter.
CreateChart	ApiChart	Creates a chart with the parameters specified.
CreateCustomGeometry	ApiGeometry	Creates a new custom geometry.
CreateGradientStop	ApiGradientStop	Creates a gradient stop used for different types of gradients.
CreateGroup	ApiGroup	Creates a group of drawings.
CreateHyperlink	ApiHyperlink	Creates a new hyperlink object to be used for setting hyperlinks on drawing objects (shapes or images).
CreateImage	ApiImage	Creates an image with the parameters specified.
CreateLayout	ApiLayout	Creates a new slide layout and adds it to the slide master if it is specified.
CreateLinearGradientFill	ApiFill	Creates a linear gradient fill to apply to the object using the selected linear gradient as the object background.
CreateMaster	ApiMaster	Creates a new slide master.
CreateNoFill	ApiFill	Creates no fill and removes the fill from the element.
CreateNumbering	ApiBullet	Creates a bullet for a paragraph with the numbering character or symbol specified with the numType parameter.
CreateOleObject	ApiOleObject	Creates an OLE object with the parameters specified.
CreateParagraph	ApiParagraph	Creates a new paragraph.
CreatePatternFill	ApiFill	Creates a pattern fill to apply to the object using the selected pattern as the object background.
CreatePlaceholder	ApiPlaceholder	Creates a new placeholder.
CreatePresetColor	ApiPresetColor	Creates a color selecting it from one of the available color presets.
CreatePresetGeometry	ApiGeometry | null	Creates a geometry using one of the available preset shapes.
CreateRGBColor	ApiRGBColor	Creates an RGB color setting the appropriate values for the red, green and blue color components.
CreateRadialGradientFill	ApiFill	Creates a radial gradient fill to apply to the object using the selected radial gradient as the object background.
CreateRun	ApiRun	Creates a new smaller text block to be inserted to the current paragraph or table.
CreateSchemeColor	ApiSchemeColor	Creates a complex color scheme selecting from one of the available schemes.
CreateShape	ApiShape	Creates a shape with the parameters specified.
CreateSlide	ApiSlide	Creates a new slide.
CreateSlideShowTransition	ApiSlideShowTransition	Creates a new slide show transition object.
CreateSolidFill	ApiFill	Creates a solid fill to apply to the object using a selected solid color as the object background.
CreateStroke	ApiStroke	Creates a stroke adding shadows to the element.
CreateTable	ApiTable	Creates a table.
CreateTextPr	ApiTextPr	Creates the empty text properties.
CreateTheme	ApiTheme | null	Creates a new presentation theme.
CreateThemeColorScheme	ApiThemeColorScheme	Creates a new theme color scheme.
CreateThemeFontScheme	ApiThemeFontScheme	Creates a new theme font scheme.
CreateThemeFormatScheme	ApiThemeFormatScheme	Creates a new theme format scheme.
CreateWordArt	ApiDrawing	Creates a Text Art object with the parameters specified.
EmusToMillimeters	mm	Converts English Metric Units (EMUs) to millimeters.
EmusToPoints	number	Converts EMUs (English Metric Units) to points.
FromJSON	None	Converts the specified JSON object into the Document Builder object of the corresponding type.
GetFirstSlide	ApiSlide	Returns the first slide of the presentation.
GetFullName	string	Returns the full name of the currently opened file.
GetLastSlide	ApiSlide	Returns the last slide of the presentation.
GetPresentation	ApiPresentation	Returns the main presentation.
GetSelection	ApiSelection	Returns the selection from the current presentation.
GetSlideByIndex	ApiSlide	Returns a slide by its position in the presentation.
HexColor	ApiColor	Creates a color from a HEX string.
InchesToPoints	number	Converts inches to points.
LinesToPoints	number	Converts lines to points (1 line = 12 points).
MillimetersToEmus	EMU	Converts millimeters to English Metric Units (EMUs).
MillimetersToPixels	number	Converts millimeters to pixels.
MillimetersToPoints	number	Converts millimeters to points.
PicasToPoints	number	Converts picas to points.
PixelsToEmus	number	Converts pixels to EMUs (English Metric Units).
PixelsToPoints	number	Converts pixels to points.
PointsToCentimeters	number	Converts points to centimeters.
PointsToEmus	number	Converts points to EMUs (English Metric Units).
PointsToInches	number	Converts points to inches.
PointsToLines	number	Converts points to lines (1 line = 12 points).
PointsToMillimeters	number	Converts points to millimeters.
PointsToPicas	number	Converts points to picas (1 pica = 12 points).
PointsToPixels	number	Converts points to pixels.
PointsToTwips	number	Converts points to twips.
RGB	ApiColor	Creates an RGB color from red, green and blue components.
RGBA	ApiColor	Creates an RGBA color from red, green, blue and alpha components.
ReplaceTextSmart	boolean	Replaces each paragraph (or text in cell) in the select with the corresponding text from an array of strings.
Save	None	Saves changes to the specified document.
ThemeColor	ApiColor	Creates a theme color.
TwipsToPoints	number	Converts twips to points.
attachEvent	None	Subscribes to the specified event and calls the callback function when the event fires.
detachEvent	None	Unsubscribes from the specified event.