PowerPoint.Graphic class

Package:

powerpoint

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents a graphic object in PowerPoint.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
shape	Returns the Shape object associated with the graphic.

Methods

convertToShape()
load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
toJSON()	Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original PowerPoint.Graphic object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.GraphicData) that contains shallow copies of any loaded child properties from the original object.

Property Details

context

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

PowerPoint.RequestContext

shape

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns the Shape object associated with the graphic.

readonly shape: PowerPoint.Shape;

Property Value

PowerPoint.Shape

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Method Details

convertToShape()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

convertToShape(): PowerPoint.ShapeScopedCollection;

Returns

PowerPoint.ShapeScopedCollection

load(options)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: PowerPoint.Interfaces.GraphicLoadOptions): PowerPoint.Graphic;

Parameters

options

PowerPoint.Interfaces.GraphicLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.Graphic

load(propertyNames)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): PowerPoint.Graphic;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

PowerPoint.Graphic

load(propertyNamesAndPaths)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.Graphic;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

PowerPoint.Graphic

toJSON()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original PowerPoint.Graphic object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.GraphicData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): PowerPoint.Interfaces.GraphicData;

Returns

PowerPoint.Interfaces.GraphicData