This service allows scripts to create, access, and modify Google Slides files. See also the Google Slides documentation for more details on the underlying features of the Slides service.
Classes
Name | Brief description |
---|---|
AffineTransform | A 3x3 matrix used to transform source coordinates (x1, y1) into destination coordinates (x2, y2) according to matrix multiplication: |
AffineTransformBuilder | A builder for AffineTransform objects. |
AlignmentPosition | The alignment position to apply. |
ArrowStyle | The kinds of start and end forms with which linear geometry can be rendered. |
AutoText | An element of text that is dynamically replaced with content that can change over time, such as a slide number. |
AutoTextType | The types of auto text. |
Autofit | Describes the autofit settings of a shape. |
AutofitType | The autofit types. |
Border | Describes the border around an element. |
CellMergeState | The table cell merge states. |
Color | An opaque color |
ColorScheme | A color scheme defines a mapping from members of ThemeColorType to the actual colors used
to render them. |
ConnectionSite | The connection site on a PageElement that can connect to a connector . |
ContentAlignment | The content alignments for a Shape or TableCell . |
DashStyle | The kinds of dashes with which linear geometry can be rendered. |
Fill | Describes the page element's background |
FillType | The kinds of fill. |
Group | A collection of PageElement s joined as a single unit. |
Image | A PageElement representing an image. |
Layout | A layout in a presentation. |
Line | A PageElement representing a line. |
LineCategory | The line category. |
LineFill | Describes the fill of a line or outline |
LineFillType | The kinds of line fill. |
LineType | The line types. |
Link | A hypertext link. |
LinkType | The types of a Link . |
List | A list in the text. |
ListPreset | Preset patterns of glyphs for lists in text. |
ListStyle | The list styling for a range of text. |
Master | A master in a presentation. |
NotesMaster | A notes master in a presentation. |
NotesPage | A notes page in a presentation. |
Page | A page in a presentation. |
PageBackground | Describes the page's background |
PageBackgroundType | The kinds of page backgrounds. |
PageElement | A visual element rendered on a page. |
PageElementRange | A collection of one or more PageElement instances. |
PageElementType | The page element type. |
PageRange | A collection of one or more Page instances. |
PageType | The page types. |
Paragraph | A segment of text terminated by a newline character. |
ParagraphAlignment | The types of text alignment for a paragraph. |
ParagraphStyle | The styles of text that apply to entire paragraphs. |
PictureFill | A fill that renders an image that's stretched to the dimensions of its container. |
PlaceholderType | The placeholder types. |
Point | A point representing a location. |
PredefinedLayout | Predefined layouts. |
Presentation | A presentation. |
Selection | The user's selection in the active presentation. |
SelectionType | Type of Selection . |
Shape | A PageElement representing a generic shape that does not have a more specific
classification. |
ShapeType | The shape types. |
SheetsChart | A PageElement representing a linked chart embedded from Google Sheets. |
SheetsChartEmbedType | The Sheets chart's embed type. |
Slide | A slide in a presentation. |
SlideLinkingMode | The mode of links between slides. |
SlidePosition | The relative position of a Slide . |
SlidesApp | Creates and opens Presentations that can be edited. |
SolidFill | A solid color fill. |
SpacingMode | The different modes for paragraph spacing. |
SpeakerSpotlight | A PageElement representing a speaker spotlight. |
Table | A PageElement representing a table. |
TableCell | A cell in a table. |
TableCellRange | A collection of one or more TableCell instances. |
TableColumn | A column in a table. |
TableRow | A row in a table. |
TextBaselineOffset | The text vertical offset from its normal position. |
TextDirection | The directions text can flow in. |
TextRange | A segment of the text contents of a Shape or a TableCell . |
TextStyle | The style of text. |
ThemeColor | A color that refers to an entry in the page's ColorScheme . |
ThemeColorType | The name of an entry in the page's color scheme. |
Video | A PageElement representing a video. |
VideoSourceType | The video source types. |
WordArt | A PageElement representing word art. |
AffineTransform
Methods
Method | Return type | Brief description |
---|---|---|
getScaleX() | Number | Gets the X coordinate scaling element. |
getScaleY() | Number | Gets the Y coordinate scaling element. |
getShearX() | Number | Gets the X coordinate shearing element. |
getShearY() | Number | Gets the Y coordinate shearing element. |
getTranslateX() | Number | Gets the X coordinate translation element in points. |
getTranslateY() | Number | Gets the Y coordinate translation element in points. |
toBuilder() | AffineTransformBuilder | Returns a new AffineTransformBuilder based on this transform. |
AffineTransformBuilder
Methods
Method | Return type | Brief description |
---|---|---|
build() | AffineTransform | Creates an AffineTransform object initialized with the elements set in the builder. |
setScaleX(scaleX) | AffineTransformBuilder | Sets the X coordinate scaling element and returns the builder. |
setScaleY(scaleY) | AffineTransformBuilder | Sets the Y coordinate scaling element and returns the builder. |
setShearX(shearX) | AffineTransformBuilder | Sets the X coordinate shearing element and returns the builder. |
setShearY(shearY) | AffineTransformBuilder | Sets the Y coordinate shearing element and returns the builder. |
setTranslateX(translateX) | AffineTransformBuilder | Sets the X coordinate translation element in points, and returns the builder. |
setTranslateY(translateY) | AffineTransformBuilder | Sets the Y coordinate translation element in points, and returns the builder. |
AlignmentPosition
Properties
Property | Type | Description |
---|---|---|
CENTER | Enum | Align to the center. |
HORIZONTAL_CENTER | Enum | Align to the horizontal center. |
VERTICAL_CENTER | Enum | Align to the vertical center. |
ArrowStyle
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | An arrow style that is not supported. |
NONE | Enum | No arrow. |
STEALTH_ARROW | Enum | Arrow with notched back. |
FILL_ARROW | Enum | Filled arrow. |
FILL_CIRCLE | Enum | Filled circle. |
FILL_SQUARE | Enum | Filled square. |
FILL_DIAMOND | Enum | Filled diamond. |
OPEN_ARROW | Enum | Hollow arrow. |
OPEN_CIRCLE | Enum | Hollow circle. |
OPEN_SQUARE | Enum | Hollow square. |
OPEN_DIAMOND | Enum | Hollow diamond. |
AutoText
Methods
Method | Return type | Brief description |
---|---|---|
getAutoTextType() | AutoTextType | Returns the type of auto text. |
getIndex() | Integer | Returns the index of the auto text. |
getRange() | TextRange | Returns a TextRange spanning the auto text. |
AutoTextType
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | An auto text type that is not supported. |
SLIDE_NUMBER | Enum | A slide number. |
Autofit
Methods
Method | Return type | Brief description |
---|---|---|
disableAutofit() | Autofit | Sets the AutofitType of a shape to AutofitType.NONE . |
getAutofitType() | AutofitType | Gets the AutofitType of the shape. |
getFontScale() | Number | Gets the font scale applied to the shape. |
getLineSpacingReduction() | Number | Gets the line spacing reduction applied to the shape. |
AutofitType
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | An autofit type that is not supported. |
NONE | Enum | Autofit isn't applied. |
TEXT_AUTOFIT | Enum | Shrinks the text on overflow. |
SHAPE_AUTOFIT | Enum | Resizes the shape to fit the text. |
Border
Methods
Method | Return type | Brief description |
---|---|---|
getDashStyle() | DashStyle | Gets the DashStyle of the border. |
getLineFill() | LineFill | Gets the LineFill of the border. |
getWeight() | Number | Gets the thickness of the border in points. |
isVisible() | Boolean | Gets whether the border is visible or not. |
setDashStyle(style) | Border | Sets the DashStyle of the border. |
setTransparent() | Border | Sets the border to be transparent. |
setWeight(points) | Border | Sets the thickness of the border in points. |
CellMergeState
Properties
Property | Type | Description |
---|---|---|
NORMAL | Enum | The cell is not merged. |
HEAD | Enum | The cell is merged and it is the head (i.e. |
MERGED | Enum | The cell is merged but is not the head (i.e. |
Color
Methods
Method | Return type | Brief description |
---|---|---|
asRgbColor() | RgbColor | Converts this color to an RgbColor . |
asThemeColor() | ThemeColor | Converts this color to a ThemeColor . |
getColorType() | ColorType | Get the type of this color. |
ColorScheme
Methods
Method | Return type | Brief description |
---|---|---|
getConcreteColor(theme) | Color | Returns the concrete Color associated with the ThemeColorType in this color
scheme. |
getThemeColors() | ThemeColorType[] | Returns a list of all possible theme color types in a color scheme. |
setConcreteColor(type, color) | ColorScheme | Sets the concrete color associated with the ThemeColorType in this color scheme to the
given color. |
setConcreteColor(type, red, green, blue) | ColorScheme | Sets the concrete color associated with the ThemeColorType in this color scheme to the
given color in RGB format. |
setConcreteColor(type, hexColor) | ColorScheme | Sets the concrete color associated with the ThemeColorType in this color scheme to the
given color in HEX format. |
ConnectionSite
Methods
Method | Return type | Brief description |
---|---|---|
getIndex() | Integer | Returns the index of the connection site. |
getPageElement() | PageElement | Returns the PageElement that the connection site is on. |
ContentAlignment
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A content alignment that is not supported. |
TOP | Enum | Aligns the content to the top of the content holder. |
MIDDLE | Enum | Aligns the content to the middle of the content holder. |
BOTTOM | Enum | Aligns the content to the bottom of the content holder. |
DashStyle
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A dash style that is not supported. |
SOLID | Enum | Solid line. |
DOT | Enum | Dotted line. |
DASH | Enum | Dashed line. |
DASH_DOT | Enum | Alternating dashes and dots. |
LONG_DASH | Enum | Line with large dashes. |
LONG_DASH_DOT | Enum | Alternating large dashes and dots. |
Fill
Methods
Method | Return type | Brief description |
---|---|---|
getSolidFill() | SolidFill | Get the solid fill of this background, or null if the fill type is not FillType.SOLID . |
getType() | FillType | Get the type of this fill. |
isVisible() | Boolean | Whether the background is visible. |
setSolidFill(color) | void | Sets the solid fill to the given Color . |
setSolidFill(color, alpha) | void | Sets the solid fill to the given alpha and Color . |
setSolidFill(red, green, blue) | void | Sets the solid fill to the given RGB values. |
setSolidFill(red, green, blue, alpha) | void | Sets the solid fill to the given alpha and RGB values. |
setSolidFill(hexString) | void | Sets the solid fill to the given hex color string. |
setSolidFill(hexString, alpha) | void | Sets the solid fill to the given alpha and hex color string. |
setSolidFill(color) | void | Sets the solid fill to the given ThemeColorType . |
setSolidFill(color, alpha) | void | Sets the solid fill to the given alpha and ThemeColorType . |
setTransparent() | void | Sets the background to transparent. |
FillType
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A fill type that is not supported. |
NONE | Enum | No fill, so the background is transparent. |
SOLID | Enum | A solid color fill. |
Group
Methods
Method | Return type | Brief description |
---|---|---|
alignOnPage(alignmentPosition) | Group | Aligns the element to the specified alignment position on the page. |
bringForward() | Group | Brings the page element forward on the page by one element. |
bringToFront() | Group | Brings the page element to the front of the page. |
duplicate() | PageElement | Duplicates the page element. |
getChildren() | PageElement[] | Gets the collection of page elements in the group. |
getConnectionSites() | ConnectionSite[] | Returns the list of ConnectionSite s on the page element, or an empty list if the page
element does not have any connection sites. |
getDescription() | String | Returns the page element's alt text description. |
getHeight() | Number | Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
getInherentHeight() | Number | Returns the element's inherent height in points. |
getInherentWidth() | Number | Returns the element's inherent width in points. |
getLeft() | Number | Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
getObjectId() | String | Returns the unique ID for this object. |
getPageElementType() | PageElementType | Returns the page element's type, represented as a PageElementType enum. |
getParentGroup() | Group | Returns the group this page element belongs to, or null if the element is not in a
group. |
getParentPage() | Page | Returns the page this page element is on. |
getRotation() | Number | Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation. |
getTitle() | String | Returns the page element's alt text title. |
getTop() | Number | Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
getTransform() | AffineTransform | Gets the page element's transform. |
getWidth() | Number | Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
preconcatenateTransform(transform) | Group | Preconcatenates the provided transform to the existing transform of the page element. |
remove() | void | Removes the page element. |
scaleHeight(ratio) | Group | Scales the element's height by the specified ratio. |
scaleWidth(ratio) | Group | Scales the element's width by the specified ratio. |
select() | void | Selects only the PageElement in the active presentation and removes any previous
selection. |
select(replace) | void | Selects the PageElement in the active presentation. |
sendBackward() | Group | Sends the page element backward on the page by one element. |
sendToBack() | Group | Sends the page element to the back of the page. |
setDescription(description) | Group | Sets the page element's alt text description. |
setHeight(height) | Group | Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
setLeft(left) | Group | Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
setRotation(angle) | Group | Sets the element's clockwise rotation angle around its center in degrees. |
setTitle(title) | Group | Sets the page element's alt text title. |
setTop(top) | Group | Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
setTransform(transform) | Group | Sets the transform of the page element with the provided transform. |
setWidth(width) | Group | Sets the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
ungroup() | void | Ungroups the elements of the group. |
Image
Methods
Method | Return type | Brief description |
---|---|---|
alignOnPage(alignmentPosition) | Image | Aligns the element to the specified alignment position on the page. |
bringForward() | Image | Brings the page element forward on the page by one element. |
bringToFront() | Image | Brings the page element to the front of the page. |
duplicate() | PageElement | Duplicates the page element. |
getAs(contentType) | Blob | Return the data inside this object as a blob converted to the specified content type. |
getBlob() | Blob | Return the data inside this image as a blob. |
getBorder() | Border | Returns the Border of the image. |
getConnectionSites() | ConnectionSite[] | Returns the list of ConnectionSite s on the page element, or an empty list if the page
element does not have any connection sites. |
getContentUrl() | String | Gets a URL to the image. |
getDescription() | String | Returns the page element's alt text description. |
getHeight() | Number | Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
getInherentHeight() | Number | Returns the element's inherent height in points. |
getInherentWidth() | Number | Returns the element's inherent width in points. |
getLeft() | Number | Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
getLink() | Link | Returns the Link or null if there is no link. |
getObjectId() | String | Returns the unique ID for this object. |
getPageElementType() | PageElementType | Returns the page element's type, represented as a PageElementType enum. |
getParentGroup() | Group | Returns the group this page element belongs to, or null if the element is not in a
group. |
getParentPage() | Page | Returns the page this page element is on. |
getParentPlaceholder() | PageElement | Returns the parent page element of the placeholder. |
getPlaceholderIndex() | Integer | Returns the index of the placeholder image. |
getPlaceholderType() | PlaceholderType | Returns the placeholder type of the image, or PlaceholderType.NONE if the shape is not
a placeholder. |
getRotation() | Number | Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation. |
getSourceUrl() | String | Gets the image's source URL, if available. |
getTitle() | String | Returns the page element's alt text title. |
getTop() | Number | Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
getTransform() | AffineTransform | Returns the page element's transform. |
getWidth() | Number | Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
preconcatenateTransform(transform) | Image | Preconcatenates the provided transform to the existing transform of the page element. |
remove() | void | Removes the page element. |
removeLink() | void | Removes a Link . |
replace(blobSource) | Image | Replaces this image with an image described by a BlobSource object. |
replace(blobSource, crop) | Image | Replaces this image with an image described by a Image object, optionally cropping
the image to fit. |
replace(imageUrl) | Image | Replaces this image with another image downloaded from the provided URL. |
replace(imageUrl, crop) | Image | Replaces this image with another image downloaded from the provided URL, optionally cropping the image to fit. |
scaleHeight(ratio) | Image | Scales the element's height by the specified ratio. |
scaleWidth(ratio) | Image | Scales the element's width by the specified ratio. |
select() | void | Selects only the PageElement in the active presentation and removes any previous
selection. |
select(replace) | void | Selects the PageElement in the active presentation. |
sendBackward() | Image | Sends the page element backward on the page by one element. |
sendToBack() | Image | Sends the page element to the back of the page. |
setDescription(description) | Image | Sets the page element's alt text description. |
setHeight(height) | Image | Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
setLeft(left) | Image | Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
setLinkSlide(slideIndex) | Link | Sets a Link to the given Slide using the zero-based index of the slide. |
setLinkSlide(slide) | Link | Sets a Link to the given Slide , the link is set by the given slide ID. |
setLinkSlide(slidePosition) | Link | Sets a Link to the given Slide using the relative position of the slide. |
setLinkUrl(url) | Link | Sets a Link to the given non-empty URL string. |
setRotation(angle) | Image | Sets the element's clockwise rotation angle around its center in degrees. |
setTitle(title) | Image | Sets the page element's alt text title. |
setTop(top) | Image | Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
setTransform(transform) | Image | Sets the transform of the page element with the provided transform. |
setWidth(width) | Image | Sets the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
Layout
Methods
Method | Return type | Brief description |
---|---|---|
getBackground() | PageBackground | Gets the page's background. |
getColorScheme() | ColorScheme | Gets the ColorScheme associated with the page. |
getGroups() | Group[] | Returns the list of Group objects on the page. |
getImages() | Image[] | Returns the list of Image objects on the page. |
getLayoutName() | String | Gets the name of the layout. |
getLines() | Line[] | Returns the list of Line objects on the page. |
getMaster() | Master | Gets the master that the layout is based on. |
getObjectId() | String | Gets the unique ID for the page. |
getPageElementById(id) | PageElement | Returns the PageElement on the page with the given ID, or null if none exists. |
getPageElements() | PageElement[] | Returns the list of PageElement objects rendered on the page. |
getPageType() | PageType | Gets the type of the page. |
getPlaceholder(placeholderType) | PageElement | Returns the placeholder PageElement object for a specified PlaceholderType or
null if a matching placeholder is not present. |
getPlaceholder(placeholderType, placeholderIndex) | PageElement | Returns the placeholder PageElement object for a specified PlaceholderType and
a placeholder index, or null if the placeholder is not present. |
getPlaceholders() | PageElement[] | Returns the list of placeholder PageElement objects in the page. |
getShapes() | Shape[] | Returns the list of Shape objects on the page. |
getSheetsCharts() | SheetsChart[] | Returns the list of SheetsChart objects on the page. |
getTables() | Table[] | Returns the list of Table objects on the page. |
getVideos() | Video[] | Returns the list of Video objects on the page. |
getWordArts() | WordArt[] | Returns the list of WordArt objects on the page. |
group(pageElements) | Group | Groups all the specified page elements. |
insertGroup(group) | Group | Inserts a copy of the provided Group on the page. |
insertImage(blobSource) | Image | Inserts an image at the top left corner of the page with a default size from the specified image blob. |
insertImage(blobSource, left, top, width, height) | Image | Inserts an image on the page with the provided position and size from the specified image blob. |
insertImage(image) | Image | Inserts a copy of the provided Image on the page. |
insertImage(imageUrl) | Image | Inserts an image at the top left corner of the page with a default size from the provided URL. |
insertImage(imageUrl, left, top, width, height) | Image | Inserts an image on the page with the provided position and size from the provided URL. |
insertLine(line) | Line | Inserts a copy of the provided Line on the page. |
insertLine(lineCategory, startConnectionSite, endConnectionSite) | Line | Inserts a line on the page connecting two connection sites . |
insertLine(lineCategory, startLeft, startTop, endLeft, endTop) | Line | Inserts a line on the page. |
insertPageElement(pageElement) | PageElement | Inserts a copy of the provided PageElement on the page. |
insertShape(shape) | Shape | Inserts a copy of the provided Shape on the page. |
insertShape(shapeType) | Shape | Inserts a shape on the page. |
insertShape(shapeType, left, top, width, height) | Shape | Inserts a shape on the page. |
insertSheetsChart(sourceChart) | SheetsChart | Inserts a Google Sheets chart on the page. |
insertSheetsChart(sourceChart, left, top, width, height) | SheetsChart | Inserts a Google Sheets chart on the page with the provided position and size. |
insertSheetsChart(sheetsChart) | SheetsChart | Inserts a copy of the provided SheetsChart on the page. |
insertSheetsChartAsImage(sourceChart) | Image | Inserts a Google Sheets chart as an Image on the page. |
insertSheetsChartAsImage(sourceChart, left, top, width, height) | Image | Inserts a Google Sheets chart as an Image on the page with the provided position and
size. |
insertTable(numRows, numColumns) | Table | Inserts a table on the page. |
insertTable(numRows, numColumns, left, top, width, height) | Table | Inserts a table on the page with the provided position and size. |
insertTable(table) | Table | Inserts a copy of the provided Table on the page. |
insertTextBox(text) | Shape | Inserts a text box Shape containing the provided string on the page. |
insertTextBox(text, left, top, width, height) | Shape | Inserts a text box Shape containing the provided string on the page. |
insertVideo(videoUrl) | Video | Inserts a video at the top left corner of the page with a default size. |
insertVideo(videoUrl, left, top, width, height) | Video | Inserts a video on the page with the provided position and size. |
insertVideo(video) | Video | Inserts a copy of the provided Video on the page. |
insertWordArt(wordArt) | WordArt | Inserts a copy of the provided WordArt on the page. |
remove() | void | Removes the page. |
replaceAllText(findText, replaceText) | Integer | Replaces all instances of text matching find text with replace text. |
replaceAllText(findText, replaceText, matchCase) | Integer | Replaces all instances of text matching find text with replace text. |
selectAsCurrentPage() | void | Selects the Page in the active presentation as the current page selection and removes any previous selection. |
Line
Methods
Method | Return type | Brief description |
---|---|---|
alignOnPage(alignmentPosition) | Line | Aligns the element to the specified alignment position on the page. |
bringForward() | Line | Brings the page element forward on the page by one element. |
bringToFront() | Line | Brings the page element to the front of the page. |
duplicate() | PageElement | Duplicates the page element. |
getConnectionSites() | ConnectionSite[] | Returns the list of ConnectionSite s on the page element, or an empty list if the page
element does not have any connection sites. |
getDashStyle() | DashStyle | Gets the DashStyle of the line. |
getDescription() | String | Returns the page element's alt text description. |
getEnd() | Point | Returns the end point of the line, measured from the upper-left corner of the page. |
getEndArrow() | ArrowStyle | Gets the ArrowStyle of the arrow at the end of the line. |
getEndConnection() | ConnectionSite | Returns the connection at the end of the line, or null if there is no connection. |
getHeight() | Number | Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
getInherentHeight() | Number | Returns the element's inherent height in points. |
getInherentWidth() | Number | Returns the element's inherent width in points. |
getLeft() | Number | Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
getLineCategory() | LineCategory | Gets the LineCategory of the line. |
getLineFill() | LineFill | Gets the LineFill of the line. |
getLineType() | LineType | Gets the LineType of the line. |
getLink() | Link | Returns the Link or null if there is no link. |
getObjectId() | String | Returns the unique ID for this object. |
getPageElementType() | PageElementType | Returns the page element's type, represented as a PageElementType enum. |
getParentGroup() | Group | Returns the group this page element belongs to, or null if the element is not in a
group. |
getParentPage() | Page | Returns the page this page element is on. |
getRotation() | Number | Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation. |
getStart() | Point | Returns the start point of the line, measured from the upper-left corner of the page. |
getStartArrow() | ArrowStyle | Gets the ArrowStyle of the arrow at the beginning of the line. |
getStartConnection() | ConnectionSite | Returns the connection at the beginning of the line, or null if there is no connection. |
getTitle() | String | Returns the page element's alt text title. |
getTop() | Number | Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
getTransform() | AffineTransform | Returns the page element's transform. |
getWeight() | Number | Returns the thickness of the line in points. |
getWidth() | Number | Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
isConnector() | Boolean | Returns true if the line is a connector, or false if not. |
preconcatenateTransform(transform) | Line | Preconcatenates the provided transform to the existing transform of the page element. |
remove() | void | Removes the page element. |
removeLink() | void | Removes a Link . |
reroute() | Line | Reroutes the start and end of the line to the closest two connection sites on the connected page elements. |
scaleHeight(ratio) | Line | Scales the element's height by the specified ratio. |
scaleWidth(ratio) | Line | Scales the element's width by the specified ratio. |
select() | void | Selects only the PageElement in the active presentation and removes any previous
selection. |
select(replace) | void | Selects the PageElement in the active presentation. |
sendBackward() | Line | Sends the page element backward on the page by one element. |
sendToBack() | Line | Sends the page element to the back of the page. |
setDashStyle(style) | Line | Sets the DashStyle of the line. |
setDescription(description) | Line | Sets the page element's alt text description. |
setEnd(left, top) | Line | Sets the position of the end point of the line. |
setEnd(point) | Line | Sets the position of the end point of the line. |
setEndArrow(style) | Line | Sets the ArrowStyle of the arrow at the end of the line. |
setEndConnection(connectionSite) | Line | Sets the connection at the end of the line. |
setHeight(height) | Line | Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
setLeft(left) | Line | Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
setLineCategory(lineCategory) | Line | Sets the LineCategory of the line. |
setLinkSlide(slideIndex) | Link | Sets a Link to the given Slide using the zero-based index of the slide. |
setLinkSlide(slide) | Link | Sets a Link to the given Slide , the link is set by the given slide ID. |
setLinkSlide(slidePosition) | Link | Sets a Link to the given Slide using the relative position of the slide. |
setLinkUrl(url) | Link | Sets a Link to the given non-empty URL string. |
setRotation(angle) | Line | Sets the element's clockwise rotation angle around its center in degrees. |
setStart(left, top) | Line | Sets the position of the start point of the line. |
setStart(point) | Line | Sets the position of the start point of the line. |
setStartArrow(style) | Line | Sets the ArrowStyle of the arrow at the beginning of the line. |
setStartConnection(connectionSite) | Line | Sets the connection at the beginning of the line. |
setTitle(title) | Line | Sets the page element's alt text title. |
setTop(top) | Line | Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
setTransform(transform) | Line | Sets the transform of the page element with the provided transform. |
setWeight(points) | Line | Sets the thickness of the line in points. |
setWidth(width) | Line | Sets the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
LineCategory
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A line category that is not supported. |
STRAIGHT | Enum | Straight connectors, including straight connector 1. |
BENT | Enum | Bent connectors, including bent connector 2 to 5. |
CURVED | Enum | Curved connectors, including curved connector 2 to 5. |
LineFill
Methods
Method | Return type | Brief description |
---|---|---|
getFillType() | LineFillType | Gets the type of the line fill. |
getSolidFill() | SolidFill | Gets the solid fill of the line, or null if the fill type is not LineFillType.SOLID . |
setSolidFill(color) | void | Sets the solid fill to the given Color . |
setSolidFill(color, alpha) | void | Sets the solid fill to the given alpha and Color . |
setSolidFill(red, green, blue) | void | Sets the solid fill to the given RGB values. |
setSolidFill(red, green, blue, alpha) | void | Sets the solid fill to the given alpha and RGB values. |
setSolidFill(hexString) | void | Sets the solid fill to the given hex color string. |
setSolidFill(hexString, alpha) | void | Sets the solid fill to the given alpha and hex color string. |
setSolidFill(color) | void | Sets the solid fill to the given ThemeColorType . |
setSolidFill(color, alpha) | void | Sets the solid fill to the given alpha and ThemeColorType . |
LineFillType
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A line fill type that is not supported. |
NONE | Enum | No fill, so the line or outline is transparent. |
SOLID | Enum | A solid color fill. |
LineType
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A line type that is not supported. |
STRAIGHT_CONNECTOR_1 | Enum | Straight connector 1 form. |
BENT_CONNECTOR_2 | Enum | Bent connector 2 form. |
BENT_CONNECTOR_3 | Enum | Bent connector 3 form. |
BENT_CONNECTOR_4 | Enum | Bent connector 4 form. |
BENT_CONNECTOR_5 | Enum | Bent connector 5 form. |
CURVED_CONNECTOR_2 | Enum | Curved connector 2 form. |
CURVED_CONNECTOR_3 | Enum | Curved connector 3 form. |
CURVED_CONNECTOR_4 | Enum | Curved connector 4 form. |
CURVED_CONNECTOR_5 | Enum | Curved connector 5 form. |
STRAIGHT_LINE | Enum | Straight line. |
Link
Methods
Method | Return type | Brief description |
---|---|---|
getLinkType() | LinkType | Returns the LinkType . |
getLinkedSlide() | Slide | Returns the linked Slide for non-URL links types, if it exists. |
getSlideId() | String | Returns the ID of the linked Slide or null if the LinkType is not
LinkType.SLIDE_ID . |
getSlideIndex() | Integer | Returns the zero-based index of the linked Slide or null if the LinkType is not LinkType.SLIDE_INDEX . |
getSlidePosition() | SlidePosition | Returns the SlidePosition of the linked Slide or null if the LinkType is not LinkType.SLIDE_POSITION . |
getUrl() | String | Returns the URL to the external web page or null if the LinkType is not LinkType.URL . |
LinkType
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A link type that is not supported. |
URL | Enum | A link to an external web page. |
SLIDE_POSITION | Enum | A link to a specific slide in this presentation, addressed by its position. |
SLIDE_ID | Enum | A link to a specific slide in this presentation, addressed by its ID. |
SLIDE_INDEX | Enum | A link to a specific slide in this presentation, addressed by its zero-based index. |
List
Methods
Method | Return type | Brief description |
---|---|---|
getListId() | String | Returns the ID of the list. |
getListParagraphs() | Paragraph[] | Returns all the Paragraphs in the list. |
ListPreset
Properties
Property | Type | Description |
---|---|---|
DISC_CIRCLE_SQUARE | Enum | A list with a `DISC`, `CIRCLE` and `SQUARE` glyphs for the first 3 list nesting levels. |
DIAMONDX_ARROW3D_SQUARE | Enum | A list with a `DIAMONDX`, `ARROW3D` and `SQUARE` glyphs for the first 3 list nesting levels. |
CHECKBOX | Enum | A list with `CHECKBOX` glyphs for all list nesting levels. |
ARROW_DIAMOND_DISC | Enum | A list with a `ARROW`, `DIAMOND` and `DISC` glyphs for the first 3 list nesting levels. |
STAR_CIRCLE_SQUARE | Enum | A list with a `STAR`, `CIRCLE` and `SQUARE` glyphs for the first 3 list nesting levels. |
ARROW3D_CIRCLE_SQUARE | Enum | A list with a `ARROW3D`, `CIRCLE` and `SQUARE` glyphs for the first 3 list nesting levels. |
LEFTTRIANGLE_DIAMOND_DISC | Enum | A list with a `LEFTTRIANGLE`, `DIAMOND` and `DISC` glyphs for the first 3 list nesting levels. |
DIAMONDX_HOLLOWDIAMOND_SQUARE | Enum | A list with a `DIAMONDX`, `HOLLOWDIAMOND` and `SQUARE` glyphs for the first 3 list nesting levels. |
DIAMOND_CIRCLE_SQUARE | Enum | A list with a `DIAMOND`, `CIRCLE` and `SQUARE` glyphs for the first 3 list nesting levels. |
DIGIT_ALPHA_ROMAN | Enum | A list with `DIGIT`, `ALPHA` and `ROMAN` glyphs for the first 3 list nesting levels, followed by periods. |
DIGIT_ALPHA_ROMAN_PARENS | Enum | A list with `DIGIT`, `ALPHA` and `ROMAN` glyphs for the first 3 list nesting levels, followed by parenthesis. |
DIGIT_NESTED | Enum | A list with `DIGIT` glyphs separated by periods, where each nesting level uses the previous nesting level's glyph as a prefix. |
UPPERALPHA_ALPHA_ROMAN | Enum | A list with `UPPERALPHA`, `ALPHA` and `ROMAN` glyphs for the first 3 list nesting levels, followed by periods. |
UPPERROMAN_UPPERALPHA_DIGIT | Enum | A list with `UPPERROMAN`, `UPPERALPHA` and `DIGIT` glyphs for the first 3 list nesting levels, followed by periods. |
ZERODIGIT_ALPHA_ROMAN | Enum | A list with `ZERODIGIT`, `ALPHA` and `ROMAN` glyphs for the first 3 list nesting levels, followed by periods. |
ListStyle
Methods
Method | Return type | Brief description |
---|---|---|
applyListPreset(listPreset) | ListStyle | Applies the specified ListPreset to all of the paragraphs that overlap with the text. |
getGlyph() | String | Returns the rendered glyph for the text. |
getList() | List | Returns the List the text is in, or null if none of the text is in a list, or
part of the text is in a list, or the text is in multiple lists. |
getNestingLevel() | Integer | Returns the 0-based nesting level of the text. |
isInList() | Boolean | Returns true if the text is in exactly one list, false if none of the text is
in a list, and null if only some of the text is in a list or if the text is in multiple
lists. |
removeFromList() | ListStyle | Removes the paragraphs that overlap with the text from any lists. |
Master
Methods
Method | Return type | Brief description |
---|---|---|
getBackground() | PageBackground | Gets the page's background. |
getColorScheme() | ColorScheme | Gets the ColorScheme associated with the page. |
getGroups() | Group[] | Returns the list of Group objects on the page. |
getImages() | Image[] | Returns the list of Image objects on the page. |
getLayouts() | Layout[] | Gets this master's layouts. |
getLines() | Line[] | Returns the list of Line objects on the page. |
getObjectId() | String | Gets the unique ID for the page. |
getPageElementById(id) | PageElement | Returns the PageElement on the page with the given ID, or null if none exists. |
getPageElements() | PageElement[] | Returns the list of PageElement objects rendered on the page. |
getPageType() | PageType | Gets the type of the page. |
getPlaceholder(placeholderType) | PageElement | Returns the placeholder PageElement object for a specified PlaceholderType or
null if a matching placeholder is not present. |
getPlaceholder(placeholderType, placeholderIndex) | PageElement | Returns the placeholder PageElement object for a specified PlaceholderType and
a placeholder index, or null if the placeholder is not present. |
getPlaceholders() | PageElement[] | Returns the list of placeholder PageElement objects in the page. |
getShapes() | Shape[] | Returns the list of Shape objects on the page. |
getSheetsCharts() | SheetsChart[] | Returns the list of SheetsChart objects on the page. |
getTables() | Table[] | Returns the list of Table objects on the page. |
getVideos() | Video[] | Returns the list of Video objects on the page. |
getWordArts() | WordArt[] | Returns the list of WordArt objects on the page. |
group(pageElements) | Group | Groups all the specified page elements. |
insertGroup(group) | Group | Inserts a copy of the provided Group on the page. |
insertImage(blobSource) | Image | Inserts an image at the top left corner of the page with a default size from the specified image blob. |
insertImage(blobSource, left, top, width, height) | Image | Inserts an image on the page with the provided position and size from the specified image blob. |
insertImage(image) | Image | Inserts a copy of the provided Image on the page. |
insertImage(imageUrl) | Image | Inserts an image at the top left corner of the page with a default size from the provided URL. |
insertImage(imageUrl, left, top, width, height) | Image | Inserts an image on the page with the provided position and size from the provided URL. |
insertLine(line) | Line | Inserts a copy of the provided Line on the page. |
insertLine(lineCategory, startConnectionSite, endConnectionSite) | Line | Inserts a line on the page connecting two connection sites . |
insertLine(lineCategory, startLeft, startTop, endLeft, endTop) | Line | Inserts a line on the page. |
insertPageElement(pageElement) | PageElement | Inserts a copy of the provided PageElement on the page. |
insertShape(shape) | Shape | Inserts a copy of the provided Shape on the page. |
insertShape(shapeType) | Shape | Inserts a shape on the page. |
insertShape(shapeType, left, top, width, height) | Shape | Inserts a shape on the page. |
insertSheetsChart(sourceChart) | SheetsChart | Inserts a Google Sheets chart on the page. |
insertSheetsChart(sourceChart, left, top, width, height) | SheetsChart | Inserts a Google Sheets chart on the page with the provided position and size. |
insertSheetsChart(sheetsChart) | SheetsChart | Inserts a copy of the provided SheetsChart on the page. |
insertSheetsChartAsImage(sourceChart) | Image | Inserts a Google Sheets chart as an Image on the page. |
insertSheetsChartAsImage(sourceChart, left, top, width, height) | Image | Inserts a Google Sheets chart as an Image on the page with the provided position and
size. |
insertTable(numRows, numColumns) | Table | Inserts a table on the page. |
insertTable(numRows, numColumns, left, top, width, height) | Table | Inserts a table on the page with the provided position and size. |
insertTable(table) | Table | Inserts a copy of the provided Table on the page. |
insertTextBox(text) | Shape | Inserts a text box Shape containing the provided string on the page. |
insertTextBox(text, left, top, width, height) | Shape | Inserts a text box Shape containing the provided string on the page. |
insertVideo(videoUrl) | Video | Inserts a video at the top left corner of the page with a default size. |
insertVideo(videoUrl, left, top, width, height) | Video | Inserts a video on the page with the provided position and size. |
insertVideo(video) | Video | Inserts a copy of the provided Video on the page. |
insertWordArt(wordArt) | WordArt | Inserts a copy of the provided WordArt on the page. |
remove() | void | Removes the page. |
replaceAllText(findText, replaceText) | Integer | Replaces all instances of text matching find text with replace text. |
replaceAllText(findText, replaceText, matchCase) | Integer | Replaces all instances of text matching find text with replace text. |
selectAsCurrentPage() | void | Selects the Page in the active presentation as the current page selection and removes any previous selection. |
NotesMaster
Methods
Method | Return type | Brief description |
---|---|---|
getGroups() | Group[] | Returns the list of Group objects on the page. |
getImages() | Image[] | Returns the list of Image objects on the page. |
getLines() | Line[] | Returns the list of Line objects on the page. |
getObjectId() | String | Gets the unique ID for the page. |
getPageElementById(id) | PageElement | Returns the PageElement on the page with the given ID, or null if none exists. |
getPageElements() | PageElement[] | Returns the list of PageElement objects rendered on the page. |
getPlaceholder(placeholderType) | PageElement | Returns the placeholder PageElement object for a specified PlaceholderType or
null if a matching placeholder is not present. |
getPlaceholder(placeholderType, placeholderIndex) | PageElement | Returns the placeholder PageElement object for a specified PlaceholderType and
a placeholder index, or null if the placeholder is not present. |
getPlaceholders() | PageElement[] | Returns the list of placeholder PageElement objects in the page. |
getShapes() | Shape[] | Returns the list of Shape objects on the page. |
getSheetsCharts() | SheetsChart[] | Returns the list of SheetsChart objects on the page. |
getTables() | Table[] | Returns the list of Table objects on the page. |
getVideos() | Video[] | Returns the list of Video objects on the page. |
getWordArts() | WordArt[] | Returns the list of WordArt objects on the page. |
NotesPage
Methods
Method | Return type | Brief description |
---|---|---|
getGroups() | Group[] | Returns the list of Group objects on the page. |
getImages() | Image[] | Returns the list of Image objects on the page. |
getLines() | Line[] | Returns the list of Line objects on the page. |
getObjectId() | String | Gets the unique ID for the page. |
getPageElementById(id) | PageElement | Returns the PageElement on the page with the given ID, or null if none exists. |
getPageElements() | PageElement[] | Returns the list of PageElement objects rendered on the page. |
getPlaceholder(placeholderType) | PageElement | Returns the placeholder PageElement object for a specified PlaceholderType or
null if a matching placeholder is not present. |
getPlaceholder(placeholderType, placeholderIndex) | PageElement | Returns the placeholder PageElement object for a specified PlaceholderType and
a placeholder index, or null if the placeholder is not present. |
getPlaceholders() | PageElement[] | Returns the list of placeholder PageElement objects in the page. |
getShapes() | Shape[] | Returns the list of Shape objects on the page. |
getSheetsCharts() | SheetsChart[] | Returns the list of SheetsChart objects on the page. |
getSpeakerNotesShape() | Shape | Gets the shape containing the speaker notes on the page. |
getTables() | Table[] | Returns the list of Table objects on the page. |
getVideos() | Video[] | Returns the list of Video objects on the page. |
getWordArts() | WordArt[] | Returns the list of WordArt objects on the page. |
replaceAllText(findText, replaceText) | Integer | Replaces all instances of text matching find text with replace text. |
replaceAllText(findText, replaceText, matchCase) | Integer | Replaces all instances of text matching find text with replace text. |
Page
Methods
Method | Return type | Brief description |
---|---|---|
asLayout() | Layout | Returns the page as a layout. |
asMaster() | Master | Returns the page as a master. |
asSlide() | Slide | Returns the page as a slide. |
getBackground() | PageBackground | Gets the page's background. |
getColorScheme() | ColorScheme | Gets the ColorScheme associated with the page. |
getGroups() | Group[] | Returns the list of Group objects on the page. |
getImages() | Image[] | Returns the list of Image objects on the page. |
getLines() | Line[] | Returns the list of Line objects on the page. |
getObjectId() | String | Gets the unique ID for the page. |
getPageElementById(id) | PageElement | Returns the PageElement on the page with the given ID, or null if none exists. |
getPageElements() | PageElement[] | Returns the list of PageElement objects rendered on the page. |
getPageType() | PageType | Gets the type of the page. |
getPlaceholder(placeholderType) | PageElement | Returns the placeholder PageElement object for a specified PlaceholderType or
null if a matching placeholder is not present. |
getPlaceholder(placeholderType, placeholderIndex) | PageElement | Returns the placeholder PageElement object for a specified PlaceholderType and
a placeholder index, or null if the placeholder is not present. |
getPlaceholders() | PageElement[] | Returns the list of placeholder PageElement objects in the page. |
getShapes() | Shape[] | Returns the list of Shape objects on the page. |
getSheetsCharts() | SheetsChart[] | Returns the list of SheetsChart objects on the page. |
getTables() | Table[] | Returns the list of Table objects on the page. |
getVideos() | Video[] | Returns the list of Video objects on the page. |
getWordArts() | WordArt[] | Returns the list of WordArt objects on the page. |
group(pageElements) | Group | Groups all the specified page elements. |
insertGroup(group) | Group | Inserts a copy of the provided Group on the page. |
insertImage(blobSource) | Image | Inserts an image at the top left corner of the page with a default size from the specified image blob. |
insertImage(blobSource, left, top, width, height) | Image | Inserts an image on the page with the provided position and size from the specified image blob. |
insertImage(image) | Image | Inserts a copy of the provided Image on the page. |
insertImage(imageUrl) | Image | Inserts an image at the top left corner of the page with a default size from the provided URL. |
insertImage(imageUrl, left, top, width, height) | Image | Inserts an image on the page with the provided position and size from the provided URL. |
insertLine(line) | Line | Inserts a copy of the provided Line on the page. |
insertLine(lineCategory, startConnectionSite, endConnectionSite) | Line | Inserts a line on the page connecting two connection sites . |
insertLine(lineCategory, startLeft, startTop, endLeft, endTop) | Line | Inserts a line on the page. |
insertPageElement(pageElement) | PageElement | Inserts a copy of the provided PageElement on the page. |
insertShape(shape) | Shape | Inserts a copy of the provided Shape on the page. |
insertShape(shapeType) | Shape | Inserts a shape on the page. |
insertShape(shapeType, left, top, width, height) | Shape | Inserts a shape on the page. |
insertSheetsChart(sourceChart) | SheetsChart | Inserts a Google Sheets chart on the page. |
insertSheetsChart(sourceChart, left, top, width, height) | SheetsChart | Inserts a Google Sheets chart on the page with the provided position and size. |
insertSheetsChart(sheetsChart) | SheetsChart | Inserts a copy of the provided SheetsChart on the page. |
insertSheetsChartAsImage(sourceChart) | Image | Inserts a Google Sheets chart as an Image on the page. |
insertSheetsChartAsImage(sourceChart, left, top, width, height) | Image | Inserts a Google Sheets chart as an Image on the page with the provided position and
size. |
insertTable(numRows, numColumns) | Table | Inserts a table on the page. |
insertTable(numRows, numColumns, left, top, width, height) | Table | Inserts a table on the page with the provided position and size. |
insertTable(table) | Table | Inserts a copy of the provided Table on the page. |
insertTextBox(text) | Shape | Inserts a text box Shape containing the provided string on the page. |
insertTextBox(text, left, top, width, height) | Shape | Inserts a text box Shape containing the provided string on the page. |
insertVideo(videoUrl) | Video | Inserts a video at the top left corner of the page with a default size. |
insertVideo(videoUrl, left, top, width, height) | Video | Inserts a video on the page with the provided position and size. |
insertVideo(video) | Video | Inserts a copy of the provided Video on the page. |
insertWordArt(wordArt) | WordArt | Inserts a copy of the provided WordArt on the page. |
remove() | void | Removes the page. |
replaceAllText(findText, replaceText) | Integer | Replaces all instances of text matching find text with replace text. |
replaceAllText(findText, replaceText, matchCase) | Integer | Replaces all instances of text matching find text with replace text. |
selectAsCurrentPage() | void | Selects the Page in the active presentation as the current page selection and removes any previous selection. |
PageBackground
Methods
Method | Return type | Brief description |
---|---|---|
getPictureFill() | PictureFill | Get the stretched picture fill of this background, or null if the background fill type
is not PageBackgroundType.PICTURE . |
getSolidFill() | SolidFill | Get the solid fill of this background, or null if the background fill type is not
PageBackgroundType.SOLID . |
getType() | PageBackgroundType | Get the type of this page background. |
isVisible() | Boolean | Whether the background is visible. |
setPictureFill(blobSource) | void | Sets an image from the specified image blob as the page background. |
setPictureFill(imageUrl) | void | Sets the image at the provided URL as the page background. |
setSolidFill(color) | void | Sets the solid fill to the given Color . |
setSolidFill(color, alpha) | void | Sets the solid fill to the given alpha and Color . |
setSolidFill(red, green, blue) | void | Sets the solid fill to the given RGB values. |
setSolidFill(red, green, blue, alpha) | void | Sets the solid fill to the given alpha and RGB values. |
setSolidFill(hexString) | void | Sets the solid fill to the given hex color string. |
setSolidFill(hexString, alpha) | void | Sets the solid fill to the given alpha and hex color string. |
setSolidFill(color) | void | Sets the solid fill to the given ThemeColorType . |
setSolidFill(color, alpha) | void | Sets the solid fill to the given alpha and ThemeColorType . |
setTransparent() | void | Sets the background to transparent. |
PageBackgroundType
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A page background type that is not supported. |
NONE | Enum | No fill, so the background is rendered white. |
SOLID | Enum | A solid color fill. |
PICTURE | Enum | A picture that is stretched to fill the page. |
PageElement
Methods
Method | Return type | Brief description |
---|---|---|
alignOnPage(alignmentPosition) | PageElement | Aligns the element to the specified alignment position on the page. |
asGroup() | Group | Returns the page element as a group. |
asImage() | Image | Returns the page element as an image. |
asLine() | Line | Returns the page element as a line. |
asShape() | Shape | Returns the page element as a shape. |
asSheetsChart() | SheetsChart | Returns the page element as a linked chart embedded from Google Sheets. |
asSpeakerSpotlight() | SpeakerSpotlight | Returns the page element as a speaker spotlight. |
asTable() | Table | Returns the page element as a table. |
asVideo() | Video | Returns the page element as a video. |
asWordArt() | WordArt | Returns the page element as word art. |
bringForward() | PageElement | Brings the page element forward on the page by one element. |
bringToFront() | PageElement | Brings the page element to the front of the page. |
duplicate() | PageElement | Duplicates the page element. |
getConnectionSites() | ConnectionSite[] | Returns the list of ConnectionSite s on the page element, or an empty list if the page
element does not have any connection sites. |
getDescription() | String | Returns the page element's alt text description. |
getHeight() | Number | Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
getInherentHeight() | Number | Returns the element's inherent height in points. |
getInherentWidth() | Number | Returns the element's inherent width in points. |
getLeft() | Number | Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
getObjectId() | String | Returns the unique ID for this object. |
getPageElementType() | PageElementType | Returns the page element's type, represented as a PageElementType enum. |
getParentGroup() | Group | Returns the group this page element belongs to, or null if the element is not in a
group. |
getParentPage() | Page | Returns the page this page element is on. |
getRotation() | Number | Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation. |
getTitle() | String | Returns the page element's alt text title. |
getTop() | Number | Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
getTransform() | AffineTransform | Returns the page element's transform. |
getWidth() | Number | Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
preconcatenateTransform(transform) | PageElement | Preconcatenates the provided transform to the existing transform of the page element. |
remove() | void | Removes the page element. |
scaleHeight(ratio) | PageElement | Scales the element's height by the specified ratio. |
scaleWidth(ratio) | PageElement | Scales the element's width by the specified ratio. |
select() | void | Selects only the PageElement in the active presentation and removes any previous
selection. |
select(replace) | void | Selects the PageElement in the active presentation. |
sendBackward() | PageElement | Sends the page element backward on the page by one element. |
sendToBack() | PageElement | Sends the page element to the back of the page. |
setDescription(description) | PageElement | Sets the page element's alt text description. |
setHeight(height) | PageElement | Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
setLeft(left) | PageElement | Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
setRotation(angle) | PageElement | Sets the element's clockwise rotation angle around its center in degrees. |
setTitle(title) | PageElement | Sets the page element's alt text title. |
setTop(top) | PageElement | Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
setTransform(transform) | PageElement | Sets the transform of the page element with the provided transform. |
setWidth(width) | PageElement | Sets the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
PageElementRange
Methods
Method | Return type | Brief description |
---|---|---|
getPageElements() | PageElement[] | Returns the list of PageElement instances. |
PageElementType
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | Represents a page element that is not supported and cannot be further classified. |
SHAPE | Enum | Represents a generic shape that does not have a more specific classification. |
IMAGE | Enum | Represents an image. |
VIDEO | Enum | Represents a video. |
TABLE | Enum | Represents a table. |
GROUP | Enum | Represents a collection of page elements joined as a single unit. |
LINE | Enum | Represents a line. |
WORD_ART | Enum | Represents word art. |
SHEETS_CHART | Enum | Represents a linked chart embedded from Google Sheets. |
SPEAKER_SPOTLIGHT | Enum | Represents a speaker spotlight. |
PageRange
Methods
Method | Return type | Brief description |
---|---|---|
getPages() | Page[] | Returns the list of Page instances. |
PageType
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A page type that is not supported. |
SLIDE | Enum | A slide page. |
LAYOUT | Enum | A layout page. |
MASTER | Enum | A master page. |
Paragraph
Methods
Method | Return type | Brief description |
---|---|---|
getIndex() | Integer | Returns the index of the paragraph's newline. |
getRange() | TextRange | Returns a TextRange spanning the text in the paragraph ended by this object's newline
character. |
ParagraphAlignment
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A paragraph alignment that is not supported. |
START | Enum | The paragraph is aligned to the start of the line. |
CENTER | Enum | The paragraph is centered. |
END | Enum | The paragraph is aligned to the end of the line. |
JUSTIFIED | Enum | The paragraph is justified. |
ParagraphStyle
Methods
Method | Return type | Brief description |
---|---|---|
getIndentEnd() | Number | Returns the text end indentation for paragraphs in the TextRange in points, or null if there are multiple paragraph styles on the given text. |
getIndentFirstLine() | Number | Returns the indentation for the first line of paragraphs in the TextRange in points, or
null if there are multiple paragraph styles on the given text. |
getIndentStart() | Number | Returns the text start indentation for paragraphs in the TextRange in points, or null if there are multiple paragraph styles on the given text. |
getLineSpacing() | Number | Returns the line spacing, or null if there are multiple paragraph styles on the given
text. |
getParagraphAlignment() | ParagraphAlignment | Returns the ParagraphAlignment of paragraphs in the TextRange , or null
if there are multiple paragraph styles on the given text. |
getSpaceAbove() | Number | Returns the extra space above paragraphs in the TextRange in points, or null if
there are multiple paragraph styles on the given text. |
getSpaceBelow() | Number | Returns the extra space below paragraphs in the TextRange in points, or null if
there are multiple paragraph styles on the given text. |
getSpacingMode() | SpacingMode | Returns the SpacingMode for paragraphs in the TextRange , or null if
there are multiple paragraph styles on the given text. |
getTextDirection() | TextDirection | Returns the TextDirection for paragraphs in the TextRange , or null if
there are multiple paragraph styles on the given text. |
setIndentEnd(indent) | ParagraphStyle | Sets the text end indentation for paragraphs in the TextRange in points. |
setIndentFirstLine(indent) | ParagraphStyle | Sets the indentation for the first line of paragraphs in the TextRange in points. |
setIndentStart(indent) | ParagraphStyle | Sets the text start indentation for paragraphs in the TextRange in points. |
setLineSpacing(spacing) | ParagraphStyle | Sets the line spacing. |
setParagraphAlignment(alignment) | ParagraphStyle | Sets the ParagraphAlignment of paragraphs in the TextRange . |
setSpaceAbove(space) | ParagraphStyle | Sets the extra space above paragraphs in the TextRange in points. |
setSpaceBelow(space) | ParagraphStyle | Sets the extra space below paragraphs in the TextRange in points. |
setSpacingMode(mode) | ParagraphStyle | Sets the SpacingMode for paragraphs in the TextRange . |
setTextDirection(direction) | ParagraphStyle | Sets the TextDirection for paragraphs in the TextRange . |
PictureFill
Methods
Method | Return type | Brief description |
---|---|---|
getAs(contentType) | Blob | Return the data inside this object as a blob converted to the specified content type. |
getBlob() | Blob | Return the data inside this object as a blob. |
getContentUrl() | String | Gets a URL to the image. |
getSourceUrl() | String | Gets the image's source URL, if available. |
PlaceholderType
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A placeholder type that is not supported. |
NONE | Enum | Not a Placeholder. |
BODY | Enum | Body text. |
CHART | Enum | Chart or graph. |
CLIP_ART | Enum | Clip art image. |
CENTERED_TITLE | Enum | Title centered. |
DIAGRAM | Enum | Diagram. |
DATE_AND_TIME | Enum | Date and time. |
FOOTER | Enum | Footer text. |
HEADER | Enum | Header text. |
MEDIA | Enum | Multimedia. |
OBJECT | Enum | Any content type. |
PICTURE | Enum | Picture. |
SLIDE_NUMBER | Enum | Number of a slide. |
SUBTITLE | Enum | Subtitle. |
TABLE | Enum | Table. |
TITLE | Enum | Slide title. |
SLIDE_IMAGE | Enum | Slide image. |
Point
Methods
Method | Return type | Brief description |
---|---|---|
getX() | Number | Gets the horizontal coordinate, measured in points. |
getY() | Number | Gets the vertical coordinate, measured in points. |
PredefinedLayout
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A layout that is not supported. |
BLANK | Enum | Blank layout, with no placeholders. |
CAPTION_ONLY | Enum | Layout with a caption at the bottom. |
TITLE | Enum | Layout with a title and a subtitle. |
TITLE_AND_BODY | Enum | Layout with a title and body. |
TITLE_AND_TWO_COLUMNS | Enum | Layout with a title and two columns. |
TITLE_ONLY | Enum | Layout with only a title. |
SECTION_HEADER | Enum | Layout with a section title. |
SECTION_TITLE_AND_DESCRIPTION | Enum | Layout with a title and subtitle on one side and description on the other. |
ONE_COLUMN_TEXT | Enum | Layout with one title and one body, arranged in a single column. |
MAIN_POINT | Enum | Layout with a main point. |
BIG_NUMBER | Enum | Layout with a big number heading. |
Presentation
Methods
Method | Return type | Brief description |
---|---|---|
addEditor(emailAddress) | Presentation | Adds the given user to the list of editors for the Presentation . |
addEditor(user) | Presentation | Adds the given user to the list of editors for the Presentation . |
addEditors(emailAddresses) | Presentation | Adds the given array of users to the list of editors for the Presentation . |
addViewer(emailAddress) | Presentation | Adds the given user to the list of viewers for the Presentation . |
addViewer(user) | Presentation | Adds the given user to the list of viewers for the Presentation . |
addViewers(emailAddresses) | Presentation | Adds the given array of users to the list of viewers for the Presentation . |
appendSlide() | Slide | Appends a slide to the end of the presentation using the PredefinedLayout.BLANK
predefined layout based on the current master. |
appendSlide(layout) | Slide | Appends a slide to the end of the presentation using the specified layout based on the current master. |
appendSlide(predefinedLayout) | Slide | Appends a slide to the end of the presentation using the specified predefined layout based on the current master. |
appendSlide(slide) | Slide | Appends a copy of the provided Slide to the end of the presentation. |
appendSlide(slide, linkingMode) | Slide | Appends a copy of the provided Slide from the source presentation to the end of the
current presentation, and sets the slide link as specified by the SlideLinkingMode . |
getEditors() | User[] | Gets the list of editors for this Presentation . |
getId() | String | Gets the presentation's unique identifier. |
getLayouts() | Layout[] | Gets the layouts in the presentation. |
getMasters() | Master[] | Gets the masters in the presentation. |
getName() | String | Gets the name or title of the presentation. |
getNotesMaster() | NotesMaster | Gets the notes master of the presentation. |
getNotesPageHeight() | Number | Gets the page height of the notes master and notes pages in the presentation in points. |
getNotesPageWidth() | Number | Gets the page width of the notes master and notes pages in the presentation in points. |
getPageElementById(id) | PageElement | Returns the PageElement with the given ID, or null if none exists. |
getPageHeight() | Number | Gets the page height of the slides, layouts, and masters in the presentation in points. |
getPageWidth() | Number | Gets the page width of the slides, layouts, and masters in the presentation in points. |
getSelection() | Selection | Gets the user’s selection in the active presentation. |
getSlideById(id) | Slide | Returns the Slide with the given ID, or null if none exists. |
getSlides() | Slide[] | Gets the slides in the presentation. |
getUrl() | String | Retrieves the URL to access this presentation. |
getViewers() | User[] | Gets the list of viewers and commenters for this Presentation . |
insertSlide(insertionIndex) | Slide | Inserts a slide at the specified index in the presentation using the PredefinedLayout.BLANK predefined layout based on the current master. |
insertSlide(insertionIndex, layout) | Slide | Inserts a slide at the specified index in the presentation using the specified layout based on the current master. |
insertSlide(insertionIndex, predefinedLayout) | Slide | Inserts a slide at the specified index in the presentation using the specified predefined layout based on the current master. |
insertSlide(insertionIndex, slide) | Slide | Inserts a copy of the provided Slide at the specified index in the presentation. |
insertSlide(insertionIndex, slide, linkingMode) | Slide | Inserts a copy of the provided Slide from the source presentation into the specified
index in the current presentation, and sets the slide link as specified by the SlideLinkingMode . |
removeEditor(emailAddress) | Presentation | Removes the given user from the list of editors for the Presentation . |
removeEditor(user) | Presentation | Removes the given user from the list of editors for the Presentation . |
removeViewer(emailAddress) | Presentation | Removes the given user from the list of viewers and commenters for the Presentation . |
removeViewer(user) | Presentation | Removes the given user from the list of viewers and commenters for the Presentation . |
replaceAllText(findText, replaceText) | Integer | Replaces all instances of text matching find text with replace text. |
replaceAllText(findText, replaceText, matchCase) | Integer | Replaces all instances of text matching find text with replace text. |
saveAndClose() | void | Saves the current Presentation . |
setName(name) | void | Sets the name or title of the presentation. |
Selection
Methods
Method | Return type | Brief description |
---|---|---|
getCurrentPage() | Page | Returns the currently active Page or null if there is no active page. |
getPageElementRange() | PageElementRange | Returns the PageElementRange collection of PageElement instances that are
selected or null if there are no PageElement instances selected. |
getPageRange() | PageRange | Returns the PageRange a collection of Page instances in the flimstrip that are
selected or null if the selection is not of type SelectionType.PAGE . |
getSelectionType() | SelectionType | Returns the SelectionType . |
getTableCellRange() | TableCellRange | Returns the TableCellRange collection of TableCell instances that are selected
or null if there are no TableCell instances selected. |
getTextRange() | TextRange | Returns the TextRange that is selected or null if the selection is not of type
SelectionType.TEXT . |
SelectionType
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A selection type that is not supported. |
NONE | Enum | No selection. |
TEXT | Enum | Text selection. |
TABLE_CELL | Enum | Table cell selection. |
PAGE | Enum | Page selection in the thumbnail flimstrip. |
PAGE_ELEMENT | Enum | Page element selection. |
CURRENT_PAGE | Enum | Current page selection. |
Shape
Methods
Method | Return type | Brief description |
---|---|---|
alignOnPage(alignmentPosition) | Shape | Aligns the element to the specified alignment position on the page. |
bringForward() | Shape | Brings the page element forward on the page by one element. |
bringToFront() | Shape | Brings the page element to the front of the page. |
duplicate() | PageElement | Duplicates the page element. |
getAutofit() | Autofit | Returns the Autofit of the text within this shape. |
getBorder() | Border | Returns the Border of the shape. |
getConnectionSites() | ConnectionSite[] | Returns the list of ConnectionSite s on the page element, or an empty list if the page
element does not have any connection sites. |
getContentAlignment() | ContentAlignment | Returns the ContentAlignment of the text in the shape. |
getDescription() | String | Returns the page element's alt text description. |
getFill() | Fill | Returns the Fill of the shape. |
getHeight() | Number | Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
getInherentHeight() | Number | Returns the element's inherent height in points. |
getInherentWidth() | Number | Returns the element's inherent width in points. |
getLeft() | Number | Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
getLink() | Link | Returns the Link or null if there is no link. |
getObjectId() | String | Returns the unique ID for this object. |
getPageElementType() | PageElementType | Returns the page element's type, represented as a PageElementType enum. |
getParentGroup() | Group | Returns the group this page element belongs to, or null if the element is not in a
group. |
getParentPage() | Page | Returns the page this page element is on. |
getParentPlaceholder() | PageElement | Returns the parent page element of the placeholder. |
getPlaceholderIndex() | Integer | Returns the placeholder index of the shape. |
getPlaceholderType() | PlaceholderType | Returns the placeholder type of the shape, or PlaceholderType.NONE if the shape is not
a placeholder. |
getRotation() | Number | Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation. |
getShapeType() | ShapeType | Returns the type of the shape. |
getText() | TextRange | Returns the text content of the shape. |
getTitle() | String | Returns the page element's alt text title. |
getTop() | Number | Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
getTransform() | AffineTransform | Returns the page element's transform. |
getWidth() | Number | Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
preconcatenateTransform(transform) | Shape | Preconcatenates the provided transform to the existing transform of the page element. |
remove() | void | Removes the page element. |
removeLink() | void | Removes a Link . |
replaceWithImage(blobSource) | Image | Replaces this shape with an image provided by a BlobSource . |
replaceWithImage(blobSource, crop) | Image | Replaces this shape with an image provided by a BlobSource . |
replaceWithImage(imageUrl) | Image | Replaces this shape with an image. |
replaceWithImage(imageUrl, crop) | Image | Replaces this shape with an image. |
replaceWithSheetsChart(sourceChart) | SheetsChart | Replaces this shape with a Google Sheets chart. |
replaceWithSheetsChartAsImage(sourceChart) | Image | Replaces this shape with an image of a Google Sheets chart. |
scaleHeight(ratio) | Shape | Scales the element's height by the specified ratio. |
scaleWidth(ratio) | Shape | Scales the element's width by the specified ratio. |
select() | void | Selects only the PageElement in the active presentation and removes any previous
selection. |
select(replace) | void | Selects the PageElement in the active presentation. |
sendBackward() | Shape | Sends the page element backward on the page by one element. |
sendToBack() | Shape | Sends the page element to the back of the page. |
setContentAlignment(contentAlignment) | Shape | Sets the ContentAlignment of the text in the shape. |
setDescription(description) | Shape | Sets the page element's alt text description. |
setHeight(height) | Shape | Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
setLeft(left) | Shape | Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
setLinkSlide(slideIndex) | Link | Sets a Link to the given Slide using the zero-based index of the slide. |
setLinkSlide(slide) | Link | Sets a Link to the given Slide , the link is set by the given slide ID. |
setLinkSlide(slidePosition) | Link | Sets a Link to the given Slide using the relative position of the slide. |
setLinkUrl(url) | Link | Sets a Link to the given non-empty URL string. |
setRotation(angle) | Shape | Sets the element's clockwise rotation angle around its center in degrees. |
setTitle(title) | Shape | Sets the page element's alt text title. |
setTop(top) | Shape | Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
setTransform(transform) | Shape | Sets the transform of the page element with the provided transform. |
setWidth(width) | Shape | Sets the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
ShapeType
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A shape type that is not supported. |
TEXT_BOX | Enum | Text box shape. |
RECTANGLE | Enum | Rectangle shape. |
ROUND_RECTANGLE | Enum | Round corner rectangle shape. |
ELLIPSE | Enum | Ellipse shape. |
ARC | Enum | Curved arc shape. |
BENT_ARROW | Enum | Bent arrow shape. |
BENT_UP_ARROW | Enum | Bent up arrow shape. |
BEVEL | Enum | Bevel shape. |
BLOCK_ARC | Enum | Block arc shape. |
BRACE_PAIR | Enum | Brace pair shape. |
BRACKET_PAIR | Enum | Bracket pair shape. |
CAN | Enum | Can shape. |
CHEVRON | Enum | Chevron shape. |
CHORD | Enum | Chord shape. |
CLOUD | Enum | Cloud shape. |
CORNER | Enum | Corner shape. |
CUBE | Enum | Cube shape. |
CURVED_DOWN_ARROW | Enum | Curved down arrow shape. |
CURVED_LEFT_ARROW | Enum | Curved left arrow shape. |
CURVED_RIGHT_ARROW | Enum | Curved right arrow shape. |
CURVED_UP_ARROW | Enum | Curved up arrow shape. |
DECAGON | Enum | Decagon shape. |
DIAGONAL_STRIPE | Enum | Diagonal stripe shape. |
DIAMOND | Enum | Diamond shape. |
DODECAGON | Enum | Dodecagon shape. |
DONUT | Enum | Donut shape. |
DOUBLE_WAVE | Enum | Double wave shape. |
DOWN_ARROW | Enum | Down arrow shape. |
DOWN_ARROW_CALLOUT | Enum | Callout down arrow shape. |
FOLDED_CORNER | Enum | Folded corner shape. |
FRAME | Enum | Frame shape. |
HALF_FRAME | Enum | Half frame shape. |
HEART | Enum | Heart shape. |
HEPTAGON | Enum | Heptagon shape. |
HEXAGON | Enum | Hexagon shape. |
HOME_PLATE | Enum | Home plate shape. |
HORIZONTAL_SCROLL | Enum | Horizontal scroll shape. |
IRREGULAR_SEAL_1 | Enum | Irregular seal 1 shape. |
IRREGULAR_SEAL_2 | Enum | Irregular seal 2 shape. |
LEFT_ARROW | Enum | Left arrow shape. |
LEFT_ARROW_CALLOUT | Enum | Callout left arrow shape. |
LEFT_BRACE | Enum | Left brace shape. |
LEFT_BRACKET | Enum | Left bracket shape. |
LEFT_RIGHT_ARROW | Enum | Left right arrow shape. |
LEFT_RIGHT_ARROW_CALLOUT | Enum | Callout left right arrow shape. |
LEFT_RIGHT_UP_ARROW | Enum | Left right up arrow shape. |
LEFT_UP_ARROW | Enum | Left up arrow shape. |
LIGHTNING_BOLT | Enum | Lightning bolt shape. |
MATH_DIVIDE | Enum | Divide math shape. |
MATH_EQUAL | Enum | Equal math shape. |
MATH_MINUS | Enum | Minus math shape. |
MATH_MULTIPLY | Enum | Multiply math shape. |
MATH_NOT_EQUAL | Enum | Not equal math shape. |
MATH_PLUS | Enum | Plus math shape. |
MOON | Enum | Moon shape. |
NO_SMOKING | Enum | No smoking shape. |
NOTCHED_RIGHT_ARROW | Enum | Notched right arrow shape. |
OCTAGON | Enum | Octagon shape. |
PARALLELOGRAM | Enum | Parallelogram shape. |
PENTAGON | Enum | Pentagon shape. |
PIE | Enum | Pie shape. |
PLAQUE | Enum | Plaque shape. |
PLUS | Enum | Plus shape. |
QUAD_ARROW | Enum | Quad-arrow shape. |
QUAD_ARROW_CALLOUT | Enum | Callout quad-arrow shape. |
RIBBON | Enum | Ribbon shape. |
RIBBON_2 | Enum | Ribbon 2 shape. |
RIGHT_ARROW | Enum | Right arrow shape. |
RIGHT_ARROW_CALLOUT | Enum | Callout right arrow shape. |
RIGHT_BRACE | Enum | Right brace shape. |
RIGHT_BRACKET | Enum | Right bracket shape. |
ROUND_1_RECTANGLE | Enum | One round corner rectangle shape. |
ROUND_2_DIAGONAL_RECTANGLE | Enum | Two diagonal round corner rectangle shape. |
ROUND_2_SAME_RECTANGLE | Enum | Two same-side round corner rectangle shape. |
RIGHT_TRIANGLE | Enum | Right triangle shape. |
SMILEY_FACE | Enum | Smiley face shape. |
SNIP_1_RECTANGLE | Enum | One snip corner rectangle shape. |
SNIP_2_DIAGONAL_RECTANGLE | Enum | Two diagonal snip corner rectangle shape. |
SNIP_2_SAME_RECTANGLE | Enum | Two same-side snip corner rectangle shape. |
SNIP_ROUND_RECTANGLE | Enum | One snip one round corner rectangle shape. |
STAR_10 | Enum | Ten pointed star shape. |
STAR_12 | Enum | Twelve pointed star shape. |
STAR_16 | Enum | Sixteen pointed star shape. |
STAR_24 | Enum | Twenty four pointed star shape. |
STAR_32 | Enum | Thirty two pointed star shape. |
STAR_4 | Enum | Four pointed star shape. |
STAR_5 | Enum | Five pointed star shape. |
STAR_6 | Enum | Six pointed star shape. |
STAR_7 | Enum | Seven pointed star shape. |
STAR_8 | Enum | Eight pointed star shape. |
STRIPED_RIGHT_ARROW | Enum | Striped right arrow shape. |
SUN | Enum | Sun shape. |
TRAPEZOID | Enum | Trapezoid shape. |
TRIANGLE | Enum | Triangle shape. |
UP_ARROW | Enum | Up arrow shape. |
UP_ARROW_CALLOUT | Enum | Callout up arrow shape. |
UP_DOWN_ARROW | Enum | Up down arrow shape. |
UTURN_ARROW | Enum | U-turn arrow shape. |
VERTICAL_SCROLL | Enum | Vertical scroll shape. |
WAVE | Enum | Wave shape. |
WEDGE_ELLIPSE_CALLOUT | Enum | Callout wedge ellipse shape. |
WEDGE_RECTANGLE_CALLOUT | Enum | Callout wedge rectangle shape. |
WEDGE_ROUND_RECTANGLE_CALLOUT | Enum | Callout wedge round rectangle shape. |
FLOW_CHART_ALTERNATE_PROCESS | Enum | Alternate process flow shape. |
FLOW_CHART_COLLATE | Enum | Collate flow shape. |
FLOW_CHART_CONNECTOR | Enum | Connector flow shape. |
FLOW_CHART_DECISION | Enum | Decision flow shape. |
FLOW_CHART_DELAY | Enum | Delay flow shape. |
FLOW_CHART_DISPLAY | Enum | Display flow shape. |
FLOW_CHART_DOCUMENT | Enum | Document flow shape. |
FLOW_CHART_EXTRACT | Enum | Extract flow shape. |
FLOW_CHART_INPUT_OUTPUT | Enum | Input output flow shape. |
FLOW_CHART_INTERNAL_STORAGE | Enum | Internal storage flow shape. |
FLOW_CHART_MAGNETIC_DISK | Enum | Magnetic disk flow shape. |
FLOW_CHART_MAGNETIC_DRUM | Enum | Magnetic drum flow shape. |
FLOW_CHART_MAGNETIC_TAPE | Enum | Magnetic tape flow shape. |
FLOW_CHART_MANUAL_INPUT | Enum | Manual input flow shape. |
FLOW_CHART_MANUAL_OPERATION | Enum | Manual operation flow shape. |
FLOW_CHART_MERGE | Enum | Merge flow shape. |
FLOW_CHART_MULTIDOCUMENT | Enum | Multi-document flow shape. |
FLOW_CHART_OFFLINE_STORAGE | Enum | Offline storage flow shape. |
FLOW_CHART_OFFPAGE_CONNECTOR | Enum | Off-page connector flow shape. |
FLOW_CHART_ONLINE_STORAGE | Enum | Online storage flow shape. |
FLOW_CHART_OR | Enum | Or flow shape. |
FLOW_CHART_PREDEFINED_PROCESS | Enum | Predefined process flow shape. |
FLOW_CHART_PREPARATION | Enum | Preparation flow shape. |
FLOW_CHART_PROCESS | Enum | Process flow shape. |
FLOW_CHART_PUNCHED_CARD | Enum | Punched card flow shape. |
FLOW_CHART_PUNCHED_TAPE | Enum | Punched tape flow shape. |
FLOW_CHART_SORT | Enum | Sort flow shape. |
FLOW_CHART_SUMMING_JUNCTION | Enum | Summing junction flow shape. |
FLOW_CHART_TERMINATOR | Enum | Terminator flow shape. |
ARROW_EAST | Enum | East arrow shape. |
ARROW_NORTH_EAST | Enum | Northeast arrow shape. |
ARROW_NORTH | Enum | North arrow shape. |
SPEECH | Enum | Speech shape. |
STARBURST | Enum | Star burst shape. |
TEARDROP | Enum | Teardrop shape. |
ELLIPSE_RIBBON | Enum | Ellipse ribbon shape. |
ELLIPSE_RIBBON_2 | Enum | Ellipse ribbon 2 shape. |
CLOUD_CALLOUT | Enum | Callout cloud shape. |
CUSTOM | Enum | Custom shape. |
SheetsChart
Methods
Method | Return type | Brief description |
---|---|---|
alignOnPage(alignmentPosition) | SheetsChart | Aligns the element to the specified alignment position on the page. |
asImage() | Image | Returns the chart as an image or null if the chart is not an embedded image. |
bringForward() | SheetsChart | Brings the page element forward on the page by one element. |
bringToFront() | SheetsChart | Brings the page element to the front of the page. |
duplicate() | PageElement | Duplicates the page element. |
getChartId() | Integer | Gets the ID of the specific chart in the Google Sheets spreadsheet that is embedded. |
getConnectionSites() | ConnectionSite[] | Returns the list of ConnectionSite s on the page element, or an empty list if the page
element does not have any connection sites. |
getDescription() | String | Returns the page element's alt text description. |
getEmbedType() | SheetsChartEmbedType | Returns the embed type of the Sheets chart. |
getHeight() | Number | Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
getInherentHeight() | Number | Returns the element's inherent height in points. |
getInherentWidth() | Number | Returns the element's inherent width in points. |
getLeft() | Number | Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
getLink() | Link | Returns the Link or null if there is no link. |
getObjectId() | String | Returns the unique ID for this object. |
getPageElementType() | PageElementType | Returns the page element's type, represented as a PageElementType enum. |
getParentGroup() | Group | Returns the group this page element belongs to, or null if the element is not in a
group. |
getParentPage() | Page | Returns the page this page element is on. |
getRotation() | Number | Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation. |
getSpreadsheetId() | String | Gets the ID of the Google Sheets spreadsheet that contains the source chart. |
getTitle() | String | Returns the page element's alt text title. |
getTop() | Number | Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
getTransform() | AffineTransform | Returns the page element's transform. |
getWidth() | Number | Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
preconcatenateTransform(transform) | SheetsChart | Preconcatenates the provided transform to the existing transform of the page element. |
refresh() | void | Refreshes the chart by replacing it with the latest version of the chart from Google Sheets. |
remove() | void | Removes the page element. |
removeLink() | void | Removes a Link . |
scaleHeight(ratio) | SheetsChart | Scales the element's height by the specified ratio. |
scaleWidth(ratio) | SheetsChart | Scales the element's width by the specified ratio. |
select() | void | Selects only the PageElement in the active presentation and removes any previous
selection. |
select(replace) | void | Selects the PageElement in the active presentation. |
sendBackward() | SheetsChart | Sends the page element backward on the page by one element. |
sendToBack() | SheetsChart | Sends the page element to the back of the page. |
setDescription(description) | SheetsChart | Sets the page element's alt text description. |
setHeight(height) | SheetsChart | Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
setLeft(left) | SheetsChart | Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
setLinkSlide(slideIndex) | Link | Sets a Link to the given Slide using the zero-based index of the slide. |
setLinkSlide(slide) | Link | Sets a Link to the given Slide , the link is set by the given slide ID. |
setLinkSlide(slidePosition) | Link | Sets a Link to the given Slide using the relative position of the slide. |
setLinkUrl(url) | Link | Sets a Link to the given non-empty URL string. |
setRotation(angle) | SheetsChart | Sets the element's clockwise rotation angle around its center in degrees. |
setTitle(title) | SheetsChart | Sets the page element's alt text title. |
setTop(top) | SheetsChart | Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
setTransform(transform) | SheetsChart | Sets the transform of the page element with the provided transform. |
setWidth(width) | SheetsChart | Sets the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
SheetsChartEmbedType
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | Represents a chart that is not supported and cannot be further classified. |
IMAGE | Enum | Indicates that the chart is embedded as an image. |
Slide
Methods
Method | Return type | Brief description |
---|---|---|
duplicate() | Slide | Duplicates the slide. |
getBackground() | PageBackground | Gets the page's background. |
getColorScheme() | ColorScheme | Gets the ColorScheme associated with the page. |
getGroups() | Group[] | Returns the list of Group objects on the page. |
getImages() | Image[] | Returns the list of Image objects on the page. |
getLayout() | Layout | Gets the layout that the slide is based on or null if the slide is not based on a
layout. |
getLines() | Line[] | Returns the list of Line objects on the page. |
getNotesPage() | NotesPage | Returns the notes page associated with the slide. |
getObjectId() | String | Gets the unique ID for the page. |
getPageElementById(id) | PageElement | Returns the PageElement on the page with the given ID, or null if none exists. |
getPageElements() | PageElement[] | Returns the list of PageElement objects rendered on the page. |
getPageType() | PageType | Gets the type of the page. |
getPlaceholder(placeholderType) | PageElement | Returns the placeholder PageElement object for a specified PlaceholderType or
null if a matching placeholder is not present. |
getPlaceholder(placeholderType, placeholderIndex) | PageElement | Returns the placeholder PageElement object for a specified PlaceholderType and
a placeholder index, or null if the placeholder is not present. |
getPlaceholders() | PageElement[] | Returns the list of placeholder PageElement objects in the page. |
getShapes() | Shape[] | Returns the list of Shape objects on the page. |
getSheetsCharts() | SheetsChart[] | Returns the list of SheetsChart objects on the page. |
getSlideLinkingMode() | SlideLinkingMode | Returns a SlideLinkingMode indicating if the slide is linked to another slide. |
getSourcePresentationId() | String | Returns the source Presentation ID or null if the slide is not linked. |
getSourceSlideObjectId() | String | Returns the source slide ID or null if the slide is not linked. |
getTables() | Table[] | Returns the list of Table objects on the page. |
getVideos() | Video[] | Returns the list of Video objects on the page. |
getWordArts() | WordArt[] | Returns the list of WordArt objects on the page. |
group(pageElements) | Group | Groups all the specified page elements. |
insertGroup(group) | Group | Inserts a copy of the provided Group on the page. |
insertImage(blobSource) | Image | Inserts an image at the top left corner of the page with a default size from the specified image blob. |
insertImage(blobSource, left, top, width, height) | Image | Inserts an image on the page with the provided position and size from the specified image blob. |
insertImage(image) | Image | Inserts a copy of the provided Image on the page. |
insertImage(imageUrl) | Image | Inserts an image at the top left corner of the page with a default size from the provided URL. |
insertImage(imageUrl, left, top, width, height) | Image | Inserts an image on the page with the provided position and size from the provided URL. |
insertLine(line) | Line | Inserts a copy of the provided Line on the page. |
insertLine(lineCategory, startConnectionSite, endConnectionSite) | Line | Inserts a line on the page connecting two connection sites . |
insertLine(lineCategory, startLeft, startTop, endLeft, endTop) | Line | Inserts a line on the page. |
insertPageElement(pageElement) | PageElement | Inserts a copy of the provided PageElement on the page. |
insertShape(shape) | Shape | Inserts a copy of the provided Shape on the page. |
insertShape(shapeType) | Shape | Inserts a shape on the page. |
insertShape(shapeType, left, top, width, height) | Shape | Inserts a shape on the page. |
insertSheetsChart(sourceChart) | SheetsChart | Inserts a Google Sheets chart on the page. |
insertSheetsChart(sourceChart, left, top, width, height) | SheetsChart | Inserts a Google Sheets chart on the page with the provided position and size. |
insertSheetsChart(sheetsChart) | SheetsChart | Inserts a copy of the provided SheetsChart on the page. |
insertSheetsChartAsImage(sourceChart) | Image | Inserts a Google Sheets chart as an Image on the page. |
insertSheetsChartAsImage(sourceChart, left, top, width, height) | Image | Inserts a Google Sheets chart as an Image on the page with the provided position and
size. |
insertTable(numRows, numColumns) | Table | Inserts a table on the page. |
insertTable(numRows, numColumns, left, top, width, height) | Table | Inserts a table on the page with the provided position and size. |
insertTable(table) | Table | Inserts a copy of the provided Table on the page. |
insertTextBox(text) | Shape | Inserts a text box Shape containing the provided string on the page. |
insertTextBox(text, left, top, width, height) | Shape | Inserts a text box Shape containing the provided string on the page. |
insertVideo(videoUrl) | Video | Inserts a video at the top left corner of the page with a default size. |
insertVideo(videoUrl, left, top, width, height) | Video | Inserts a video on the page with the provided position and size. |
insertVideo(video) | Video | Inserts a copy of the provided Video on the page. |
insertWordArt(wordArt) | WordArt | Inserts a copy of the provided WordArt on the page. |
isSkipped() | Boolean | Returns whether the slide is skipped in the presentation mode. |
move(index) | void | Move the slide to the specified index. |
refreshSlide() | void | Refreshes the slide to reflect any changes made to the linked source slide. |
remove() | void | Removes the page. |
replaceAllText(findText, replaceText) | Integer | Replaces all instances of text matching find text with replace text. |
replaceAllText(findText, replaceText, matchCase) | Integer | Replaces all instances of text matching find text with replace text. |
selectAsCurrentPage() | void | Selects the Page in the active presentation as the current page selection and removes any previous selection. |
setSkipped(isSkipped) | void | Sets whether the slide is skipped in the presentation mode. |
unlink() | void | Unlinks the current Slide from its source slide. |
SlideLinkingMode
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A slide linking mode that isn't supported. |
LINKED | Enum | Indicates that slides are linked. |
NOT_LINKED | Enum | Indicates that slides aren't linked. |
SlidePosition
Properties
Property | Type | Description |
---|---|---|
NEXT_SLIDE | Enum | The next slide. |
PREVIOUS_SLIDE | Enum | The previous slide. |
FIRST_SLIDE | Enum | The first slide in the presentation. |
LAST_SLIDE | Enum | The last slide in the presentation. |
SlidesApp
Properties
Property | Type | Description |
---|---|---|
AlignmentPosition | AlignmentPosition | An enumeration of the types of alignment positions. |
ArrowStyle | ArrowStyle | An enumeration of the different arrow styles that a Line can have. |
AutoTextType | AutoTextType | An enumeration of the types of auto text. |
AutofitType | AutofitType | An enumeration of autofit types. |
CellMergeState | CellMergeState | An enumeration of the different merge states of a table cell. |
ColorType | ColorType | An enumeration of color types. |
ContentAlignment | ContentAlignment | An enumeration of values used to specify content alignment. |
DashStyle | DashStyle | An enumeration of the different dash styles that a Line can have. |
FillType | FillType | An enumeration of fill types. |
LineCategory | LineCategory | An enumeration of the categories of Line . |
LineFillType | LineFillType | An enumeration of the types of LineFill . |
LineType | LineType | An enumeration of the types of Line . |
LinkType | LinkType | An enumeration of the types of links. |
ListPreset | ListPreset | An enumeration of the types of list presets. |
PageBackgroundType | PageBackgroundType | An enumeration of the types of page backgrounds. |
PageElementType | PageElementType | An enumeration of the types of page elements. |
PageType | PageType | An enumeration of the types of pages. |
ParagraphAlignment | ParagraphAlignment | An enumeration of the types of paragraph alignment. |
PlaceholderType | PlaceholderType | An enumeration of the types of placeholders. |
PredefinedLayout | PredefinedLayout | An enumeration of the predefined layouts. |
SelectionType | SelectionType | An enumeration of the types of selections. |
ShapeType | ShapeType | An enumeration of the types of shapes. |
SheetsChartEmbedType | SheetsChartEmbedType | An enumeration of Sheets chart embed types. |
SlideLinkingMode | SlideLinkingMode | An enumeration of the ways Slides can be linked. |
SlidePosition | SlidePosition | An enumeration of the types of slide positions. |
SpacingMode | SpacingMode | An enumeration of the types of spacing modes. |
TextBaselineOffset | TextBaselineOffset | An enumeration of the types of text baseline offset. |
TextDirection | TextDirection | An enumeration of the types of text directions. |
ThemeColorType | ThemeColorType | An enumeration of theme colors. |
VideoSourceType | VideoSourceType | An enumeration of the types of video source. |
Methods
Method | Return type | Brief description |
---|---|---|
create(name) | Presentation | Creates and opens a new Presentation . |
getActivePresentation() | Presentation | Returns the currently active presentation to which the script is container-bound, or null if there is no
active presentation. |
getUi() | Ui | Returns an instance of the presentation's user-interface environment that allows the script to add features like menus, dialogs, and sidebars. |
newAffineTransformBuilder() | AffineTransformBuilder | Returns a new AffineTransformBuilder to build an AffineTransform . |
openById(id) | Presentation | Opens the Presentation with the given ID. |
openByUrl(url) | Presentation | Opens the Presentation with the given URL. |
SolidFill
Methods
Method | Return type | Brief description |
---|---|---|
getAlpha() | Number | Get the opacity of the color, in the interval from [0, 1.0], where 1.0 means fully opaque. |
getColor() | Color | Get the color of the fill. |
SpacingMode
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A spacing mode that is not supported. |
NEVER_COLLAPSE | Enum | Paragraph spacing is always rendered. |
COLLAPSE_LISTS | Enum | Paragraph spacing is skipped between list elements. |
SpeakerSpotlight
Methods
Method | Return type | Brief description |
---|---|---|
alignOnPage(alignmentPosition) | SpeakerSpotlight | Aligns the element to the specified alignment position on the page. |
bringForward() | SpeakerSpotlight | Brings the page element forward on the page by one element. |
bringToFront() | SpeakerSpotlight | Brings the page element to the front of the page. |
duplicate() | PageElement | Duplicates the page element. |
getBorder() | Border | Returns the Border of the speaker spotlight. |
getConnectionSites() | ConnectionSite[] | Returns the list of ConnectionSite s on the page element, or an empty list if the page
element does not have any connection sites. |
getDescription() | String | Returns the page element's alt text description. |
getHeight() | Number | Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
getInherentHeight() | Number | Returns the element's inherent height in points. |
getInherentWidth() | Number | Returns the element's inherent width in points. |
getLeft() | Number | Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
getMaskShapeType() | ShapeType | Returns the ShapeType of the mask applied to the speaker spotlight, or null if
there is no mask. |
getObjectId() | String | Returns the unique ID for this object. |
getPageElementType() | PageElementType | Returns the page element's type, represented as a PageElementType enum. |
getParentGroup() | Group | Returns the group this page element belongs to, or null if the element is not in a
group. |
getParentPage() | Page | Returns the page this page element is on. |
getRotation() | Number | Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation. |
getTitle() | String | Returns the page element's alt text title. |
getTop() | Number | Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
getTransform() | AffineTransform | Returns the page element's transform. |
getWidth() | Number | Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
preconcatenateTransform(transform) | SpeakerSpotlight | Preconcatenates the provided transform to the existing transform of the page element. |
remove() | void | Removes the page element. |
scaleHeight(ratio) | SpeakerSpotlight | Scales the element's height by the specified ratio. |
scaleWidth(ratio) | SpeakerSpotlight | Scales the element's width by the specified ratio. |
select() | void | Selects only the PageElement in the active presentation and removes any previous
selection. |
select(replace) | void | Selects the PageElement in the active presentation. |
sendBackward() | SpeakerSpotlight | Sends the page element backward on the page by one element. |
sendToBack() | SpeakerSpotlight | Sends the page element to the back of the page. |
setDescription(description) | SpeakerSpotlight | Sets the page element's alt text description. |
setHeight(height) | SpeakerSpotlight | Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
setLeft(left) | SpeakerSpotlight | Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
setRotation(angle) | SpeakerSpotlight | Sets the element's clockwise rotation angle around its center in degrees. |
setTitle(title) | SpeakerSpotlight | Sets the page element's alt text title. |
setTop(top) | SpeakerSpotlight | Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
setTransform(transform) | SpeakerSpotlight | Sets the transform of the page element with the provided transform. |
setWidth(width) | SpeakerSpotlight | Sets the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
Table
Methods
Method | Return type | Brief description |
---|---|---|
alignOnPage(alignmentPosition) | Table | Aligns the element to the specified alignment position on the page. |
appendColumn() | TableColumn | Appends a new column to the right of the last column of the table. |
appendRow() | TableRow | Appends a new row below the last row of the table. |
bringForward() | Table | Brings the page element forward on the page by one element. |
bringToFront() | Table | Brings the page element to the front of the page. |
duplicate() | PageElement | Duplicates the page element. |
getCell(rowIndex, columnIndex) | TableCell | Returns the specified cell in the table. |
getColumn(columnIndex) | TableColumn | Returns the specified column in the table. |
getConnectionSites() | ConnectionSite[] | Returns the list of ConnectionSite s on the page element, or an empty list if the page
element does not have any connection sites. |
getDescription() | String | Returns the page element's alt text description. |
getHeight() | Number | Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
getInherentHeight() | Number | Returns the element's inherent height in points. |
getInherentWidth() | Number | Returns the element's inherent width in points. |
getLeft() | Number | Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
getNumColumns() | Integer | Returns the number of columns in the table. |
getNumRows() | Integer | Returns the number of rows in the table. |
getObjectId() | String | Returns the unique ID for this object. |
getPageElementType() | PageElementType | Returns the page element's type, represented as a PageElementType enum. |
getParentGroup() | Group | Returns the group this page element belongs to, or null if the element is not in a
group. |
getParentPage() | Page | Returns the page this page element is on. |
getRotation() | Number | Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation. |
getRow(rowIndex) | TableRow | Returns the specified row in the table. |
getTitle() | String | Returns the page element's alt text title. |
getTop() | Number | Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
getTransform() | AffineTransform | Returns the page element's transform. |
getWidth() | Number | Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
insertColumn(index) | TableColumn | Inserts a new column at the specified index of the table. |
insertRow(index) | TableRow | Inserts a new row at the specified index of the table. |
preconcatenateTransform(transform) | Table | Preconcatenates the provided transform to the existing transform of the page element. |
remove() | void | Removes the page element. |
scaleHeight(ratio) | Table | Scales the element's height by the specified ratio. |
scaleWidth(ratio) | Table | Scales the element's width by the specified ratio. |
select() | void | Selects only the PageElement in the active presentation and removes any previous
selection. |
select(replace) | void | Selects the PageElement in the active presentation. |
sendBackward() | Table | Sends the page element backward on the page by one element. |
sendToBack() | Table | Sends the page element to the back of the page. |
setDescription(description) | Table | Sets the page element's alt text description. |
setHeight(height) | Table | Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
setLeft(left) | Table | Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
setRotation(angle) | Table | Sets the element's clockwise rotation angle around its center in degrees. |
setTitle(title) | Table | Sets the page element's alt text title. |
setTop(top) | Table | Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
setTransform(transform) | Table | Sets the transform of the page element with the provided transform. |
setWidth(width) | Table | Sets the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
TableCell
Methods
Method | Return type | Brief description |
---|---|---|
getColumnIndex() | Integer | Returns the 0-based column index of the table cell. |
getColumnSpan() | Integer | Returns the column span of the table cell. |
getContentAlignment() | ContentAlignment | Returns the ContentAlignment of the text in the table cell. |
getFill() | Fill | Returns the fill of the table cell. |
getHeadCell() | TableCell | Returns the head cell of this table cell. |
getMergeState() | CellMergeState | Returns the merge state of the table cell. |
getParentColumn() | TableColumn | Returns the table column containing the current cell. |
getParentRow() | TableRow | Returns the table row containing the current cell. |
getParentTable() | Table | Returns the table containing the current cell. |
getRowIndex() | Integer | Returns the 0-based row index of the table cell. |
getRowSpan() | Integer | Returns the row span of the table cell. |
getText() | TextRange | Returns the text content of the table cell. |
setContentAlignment(contentAlignment) | TableCell | Sets the ContentAlignment of the text in the table cell. |
TableCellRange
Methods
Method | Return type | Brief description |
---|---|---|
getTableCells() | TableCell[] | Returns the list of TableCell instances. |
TableColumn
Methods
Method | Return type | Brief description |
---|---|---|
getCell(cellIndex) | TableCell | Returns the cell at the specified index. |
getIndex() | Integer | Returns the 0-based index of the column. |
getNumCells() | Integer | Returns the number of cells in this column. |
getParentTable() | Table | Returns the table containing the current column. |
getWidth() | Number | Returns the width of the column in points. |
remove() | void | Removes the table column. |
TableRow
Methods
Method | Return type | Brief description |
---|---|---|
getCell(cellIndex) | TableCell | Returns the cell at the specified index. |
getIndex() | Integer | Returns the 0-based index of the row. |
getMinimumHeight() | Number | Returns the minimum height of the row in points. |
getNumCells() | Integer | Returns the number of cells in this row. |
getParentTable() | Table | Returns the table containing the current row. |
remove() | void | Removes the table row. |
TextBaselineOffset
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | An text baseline offset that is not supported. |
NONE | Enum | The text is not vertically offset. |
SUPERSCRIPT | Enum | The text is vertically offset upwards. |
SUBSCRIPT | Enum | The text is vertically offset downwards. |
TextDirection
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A text direction that is not supported. |
LEFT_TO_RIGHT | Enum | The text goes from left to right. |
RIGHT_TO_LEFT | Enum | The text goes from right to left. |
TextRange
Methods
Method | Return type | Brief description |
---|---|---|
appendParagraph(text) | Paragraph | Appends a paragraph at the end of the text range. |
appendRange(textRange) | TextRange | Appends a copy of the provided text range to the end of the current text range. |
appendRange(textRange, matchSourceFormatting) | TextRange | Appends a copy of the provided text range to the end of the current text range. |
appendText(text) | TextRange | Appends text at the end of the text range. |
asRenderedString() | String | Returns the rendered text bounded by this range of the associated shape or table cell in a format appropriate to display to end users. |
asString() | String | Returns the raw text bounded by this range of the associated shape or table cell. |
clear() | void | Clears the text bounded by this range. |
clear(startOffset, endOffset) | void | Clears the text bounded by the start and end offsets in the range. |
find(pattern) | TextRange[] | Returns all the ranges matching the search pattern in the current text range. |
find(pattern, startOffset) | TextRange[] | Returns all the ranges matching the search pattern in the current text range starting from the start offset. |
getAutoTexts() | AutoText[] | Returns the auto texts within the current text range. |
getEndIndex() | Integer | Returns the exclusive, 0-based index for the last character in this range. |
getLength() | Integer | Returns the number of characters in this range. |
getLinks() | TextRange[] | Returns a collection of text ranges that correspond to all Link s within the current
text range or overlapping the current text range. |
getListParagraphs() | Paragraph[] | Returns the paragraphs in lists that overlap the current text range. |
getListStyle() | ListStyle | Returns the ListStyle of the current text range. |
getParagraphStyle() | ParagraphStyle | Returns the ParagraphStyle of the current text range. |
getParagraphs() | Paragraph[] | Returns the paragraphs that overlap the current text range. |
getRange(startOffset, endOffset) | TextRange | Returns a new TextRange covering part of the range from which it is derived. |
getRuns() | TextRange[] | Returns the text runs that overlap the current text range. |
getStartIndex() | Integer | Returns the inclusive, 0-based index for the first character in this range. |
getTextStyle() | TextStyle | Returns the text style of the range, or null if the range is empty. |
insertParagraph(startOffset, text) | Paragraph | Inserts a paragraph at the start offset. |
insertRange(startOffset, textRange) | TextRange | Inserts a copy of the provided text range at the start offset. |
insertRange(startOffset, textRange, matchSourceFormatting) | TextRange | Inserts a copy of the provided text range at the start offset. |
insertText(startOffset, text) | TextRange | Inserts text at the start offset. |
isEmpty() | Boolean | Returns true if there are no characters in this range, and returns false
otherwise. |
replaceAllText(findText, replaceText) | Integer | Replaces all instances of text matching find text with replace text. |
replaceAllText(findText, replaceText, matchCase) | Integer | Replaces all instances of text matching find text with replace text. |
select() | void | Selects only the TextRange in the active presentation and removes any previous
selection. |
setText(newText) | TextRange | Sets the text bounded by this range of the associated shape or table cell. |
TextStyle
Methods
Method | Return type | Brief description |
---|---|---|
getBackgroundColor() | Color | Returns the background color of the text, or null if there are multiple styles on the
text. |
getBaselineOffset() | TextBaselineOffset | Returns the vertical offset of text from its normal position, or null if there are
multiple styles on the text. |
getFontFamily() | String | Returns the font family of the text, or null if there are multiple styles on the text. |
getFontSize() | Number | Returns the font size of the text in points, or null if there are multiple styles on
the text. |
getFontWeight() | Integer | Returns the font weight of the text, or null if there are multiple styles on the text. |
getForegroundColor() | Color | Returns the foreground color of the text, or null if there are multiple styles on the
text. |
getLink() | Link | Returns the Link on the text, or null if there is no link or if the link is on
part of the text or if there are multiple links. |
hasLink() | Boolean | Returns true if there is link on the text, false if not, or null if the
link is on part of the text or there are multiple links. |
isBackgroundTransparent() | Boolean | Returns true if the background of the text is transparent, false if not, or
null if there are multiple styles on the text. |
isBold() | Boolean | Returns true if the text is rendered as bold, false if not, or null if
there are multiple styles on the text. |
isItalic() | Boolean | Returns true if the text is italicized, false if not, or null if there
are multiple styles on the text. |
isSmallCaps() | Boolean | Returns true if the text is in small capital letters, false if not, or null if there are multiple styles on the text. |
isStrikethrough() | Boolean | Returns true if the text is struck through, false if not, or null if
there are multiple styles on the text. |
isUnderline() | Boolean | Returns true if the text is underlined, false if not, or null if there
are multiple styles on the text. |
removeLink() | TextStyle | Removes a Link . |
setBackgroundColor(color) | TextStyle | Sets the background color of the text. |
setBackgroundColor(red, green, blue) | TextStyle | Sets the background color of the text to the given RGB values from 0 to 255. |
setBackgroundColor(hexColor) | TextStyle | Sets the background color of the text to the given hex color string. |
setBackgroundColor(color) | TextStyle | Sets the background color of the text to the given ThemeColorType . |
setBackgroundColorTransparent() | TextStyle | Sets the background color of the text to transparent. |
setBaselineOffset(offset) | TextStyle | Sets the vertical offset of the text relative to its normal position. |
setBold(bold) | TextStyle | Sets whether the text should be rendered as bold. |
setFontFamily(fontFamily) | TextStyle | Sets the font family of the text . |
setFontFamilyAndWeight(fontFamily, fontWeight) | TextStyle | Sets the font family and weight of the text. |
setFontSize(fontSize) | TextStyle | Sets the font size of the text, in points. |
setForegroundColor(foregroundColor) | TextStyle | Sets the foreground color of the text. |
setForegroundColor(red, green, blue) | TextStyle | Sets the foreground color of the text to the given RGB values from 0 to 255. |
setForegroundColor(hexColor) | TextStyle | Sets the foreground color of the text to the given hex color string. |
setForegroundColor(color) | TextStyle | Sets the foreground color of the text to the given ThemeColorType . |
setItalic(italic) | TextStyle | Sets the whether the text is italicized. |
setLinkSlide(slideIndex) | TextStyle | Sets a Link to the given Slide using the zero-based index of the slide. |
setLinkSlide(slide) | TextStyle | Sets a Link to the given Slide , the link is set by the given slide ID. |
setLinkSlide(slidePosition) | TextStyle | Sets a Link to the given Slide using the relative position of the slide. |
setLinkUrl(url) | TextStyle | Sets a Link to the given non-empty URL string. |
setSmallCaps(smallCaps) | TextStyle | Sets whether the text is rendered in small capital letters. |
setStrikethrough(strikethrough) | TextStyle | Sets whether the text is struck through. |
setUnderline(underline) | TextStyle | Sets whether the text is underlined. |
ThemeColor
Methods
Method | Return type | Brief description |
---|---|---|
getColorType() | ColorType | Get the type of this color. |
getThemeColorType() | ThemeColorType | Get the theme color type of this color. |
ThemeColorType
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | Represents a theme color that is not supported. |
DARK1 | Enum | Represents the first dark color. |
LIGHT1 | Enum | Represents the first light color. |
DARK2 | Enum | Represents the second dark color. |
LIGHT2 | Enum | Represents the second light color. |
ACCENT1 | Enum | Represents the first accent color. |
ACCENT2 | Enum | Represents the second accent color. |
ACCENT3 | Enum | Represents the third accent color. |
ACCENT4 | Enum | Represents the fourth accent color. |
ACCENT5 | Enum | Represents the fifth accent color. |
ACCENT6 | Enum | Represents the sixth accent color. |
HYPERLINK | Enum | Represents the color to use for hyperlinks. |
FOLLOWED_HYPERLINK | Enum | Represents the color to use for visited hyperlinks. |
Video
Methods
Method | Return type | Brief description |
---|---|---|
alignOnPage(alignmentPosition) | Video | Aligns the element to the specified alignment position on the page. |
bringForward() | Video | Brings the page element forward on the page by one element. |
bringToFront() | Video | Brings the page element to the front of the page. |
duplicate() | PageElement | Duplicates the page element. |
getBorder() | Border | Returns the Border of the video. |
getConnectionSites() | ConnectionSite[] | Returns the list of ConnectionSite s on the page element, or an empty list if the page
element does not have any connection sites. |
getDescription() | String | Returns the page element's alt text description. |
getHeight() | Number | Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
getInherentHeight() | Number | Returns the element's inherent height in points. |
getInherentWidth() | Number | Returns the element's inherent width in points. |
getLeft() | Number | Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
getObjectId() | String | Returns the unique ID for this object. |
getPageElementType() | PageElementType | Returns the page element's type, represented as a PageElementType enum. |
getParentGroup() | Group | Returns the group this page element belongs to, or null if the element is not in a
group. |
getParentPage() | Page | Returns the page this page element is on. |
getRotation() | Number | Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation. |
getSource() | VideoSourceType | Gets the video source. |
getThumbnailUrl() | String | Gets an URL to the video thumbnail. |
getTitle() | String | Returns the page element's alt text title. |
getTop() | Number | Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
getTransform() | AffineTransform | Returns the page element's transform. |
getUrl() | String | Gets an URL to the video. |
getVideoId() | String | Gets the video source's unique identifier for this video. |
getWidth() | Number | Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
preconcatenateTransform(transform) | Video | Preconcatenates the provided transform to the existing transform of the page element. |
remove() | void | Removes the page element. |
scaleHeight(ratio) | Video | Scales the element's height by the specified ratio. |
scaleWidth(ratio) | Video | Scales the element's width by the specified ratio. |
select() | void | Selects only the PageElement in the active presentation and removes any previous
selection. |
select(replace) | void | Selects the PageElement in the active presentation. |
sendBackward() | Video | Sends the page element backward on the page by one element. |
sendToBack() | Video | Sends the page element to the back of the page. |
setDescription(description) | Video | Sets the page element's alt text description. |
setHeight(height) | Video | Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
setLeft(left) | Video | Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
setRotation(angle) | Video | Sets the element's clockwise rotation angle around its center in degrees. |
setTitle(title) | Video | Sets the page element's alt text title. |
setTop(top) | Video | Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
setTransform(transform) | Video | Sets the transform of the page element with the provided transform. |
setWidth(width) | Video | Sets the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
VideoSourceType
Properties
Property | Type | Description |
---|---|---|
UNSUPPORTED | Enum | A video source type that is not supported. |
YOUTUBE | Enum | YouTube video. |
WordArt
Methods
Method | Return type | Brief description |
---|---|---|
alignOnPage(alignmentPosition) | WordArt | Aligns the element to the specified alignment position on the page. |
bringForward() | WordArt | Brings the page element forward on the page by one element. |
bringToFront() | WordArt | Brings the page element to the front of the page. |
duplicate() | PageElement | Duplicates the page element. |
getConnectionSites() | ConnectionSite[] | Returns the list of ConnectionSite s on the page element, or an empty list if the page
element does not have any connection sites. |
getDescription() | String | Returns the page element's alt text description. |
getHeight() | Number | Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
getInherentHeight() | Number | Returns the element's inherent height in points. |
getInherentWidth() | Number | Returns the element's inherent width in points. |
getLeft() | Number | Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
getLink() | Link | Returns the Link or null if there is no link. |
getObjectId() | String | Returns the unique ID for this object. |
getPageElementType() | PageElementType | Returns the page element's type, represented as a PageElementType enum. |
getParentGroup() | Group | Returns the group this page element belongs to, or null if the element is not in a
group. |
getParentPage() | Page | Returns the page this page element is on. |
getRenderedText() | String | Gets the text that is rendered as word art. |
getRotation() | Number | Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation. |
getTitle() | String | Returns the page element's alt text title. |
getTop() | Number | Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
getTransform() | AffineTransform | Returns the page element's transform. |
getWidth() | Number | Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation. |
preconcatenateTransform(transform) | WordArt | Preconcatenates the provided transform to the existing transform of the page element. |
remove() | void | Removes the page element. |
removeLink() | void | Removes a Link . |
scaleHeight(ratio) | WordArt | Scales the element's height by the specified ratio. |
scaleWidth(ratio) | WordArt | Scales the element's width by the specified ratio. |
select() | void | Selects only the PageElement in the active presentation and removes any previous
selection. |
select(replace) | void | Selects the PageElement in the active presentation. |
sendBackward() | WordArt | Sends the page element backward on the page by one element. |
sendToBack() | WordArt | Sends the page element to the back of the page. |
setDescription(description) | WordArt | Sets the page element's alt text description. |
setHeight(height) | WordArt | Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation. |
setLeft(left) | WordArt | Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation. |
setLinkSlide(slideIndex) | Link | Sets a Link to the given Slide using the zero-based index of the slide. |
setLinkSlide(slide) | Link | Sets a Link to the given Slide , the link is set by the given slide ID. |
setLinkSlide(slidePosition) | Link | Sets a Link to the given Slide using the relative position of the slide. |
setLinkUrl(url) | Link | Sets a Link to the given non-empty URL string. |
setRotation(angle) | WordArt | Sets the element's clockwise rotation angle around its center in degrees. |
setTitle(title) | WordArt | Sets the page element's alt text title. |
setTop(top) | WordArt | Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation. |
setTransform(transform) | WordArt | Sets the transform of the page element with the provided transform. |
setWidth(width) | WordArt | Sets the element's width in points, which is the width of the element's bounding box when the element has no rotation. |