Class Table

Table

A PageElement representing a table.

Methods

Method Return type Brief description
Table Aligns the element to the specified alignment position on the page.
TableColumn Appends a new column to the right of the last column of the table.
TableRow Appends a new row below the last row of the table.
Table Brings the page element forward on the page by one element.
Table Brings the page element to the front of the page.
PageElement Duplicates the page element.
TableCell Returns the specified cell in the table.
TableColumn Returns the specified column in the table.
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.
String Returns the page element's alt text description.
Number Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
Number Returns the element's inherent height in points.
Number Returns the element's inherent width in points.
Number Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation.
Integer Returns the number of columns in the table.
Integer Returns the number of rows in the table.
String Returns the unique ID for this object.
PageElementType Returns the page element's type, represented as a PageElementType enum.
Group Returns the group this page element belongs to, or null if the element is not in a group.
Page Returns the page this page element is on.
Number Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation.
TableRow Returns the specified row in the table.
String Returns the page element's alt text title.
Number Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation.
AffineTransform Returns the page element's transform.
Number Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation.
TableColumn Inserts a new column at the specified index of the table.
TableRow Inserts a new row at the specified index of the table.
Table Preconcatenates the provided transform to the existing transform of the page element.
void Removes the page element.
Table Scales the element's height by the specified ratio.
Table Scales the element's width by the specified ratio.
void Selects only the PageElement in the active presentation and removes any previous selection.
void Selects the PageElement in the active presentation.
Table Sends the page element backward on the page by one element.
Table Sends the page element to the back of the page.
Table Sets the page element's alt text description.
Table Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
Table Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation.
Table Sets the element's clockwise rotation angle around its center in degrees.
Table Sets the page element's alt text title.
Table Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation.
Table Sets the transform of the page element with the provided transform.
Table Sets the element's width in points, which is the width of the element's bounding box when the element has no rotation.

Detailed documentation

alignOnPage(alignmentPosition)

Aligns the element to the specified alignment position on the page.

Parameters

Name Type Description
alignmentPosition
AlignmentPosition The position to align this page element to on the page.

Return

Table — This page element, for chaining.


appendColumn()

Appends a new column to the right of the last column of the table.

Return

TableColumn — The new appended column.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

appendRow()

Appends a new row below the last row of the table.

Return

TableRow — The new appended row.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

bringForward()

Brings the page element forward on the page by one element.

The page element must not be in a group.

Return

Table — This page element, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

bringToFront()

Brings the page element to the front of the page.

The page element must not be in a group.

Return

Table — This page element, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

duplicate()

Duplicates the page element.

The duplicate page element is placed on the same page at the same position as the original.

Return

PageElement — The new duplicate of this page element.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getCell(rowIndex, columnIndex)

Returns the specified cell in the table.

Parameters

Name Type Description
rowIndex
Integer The row index of the cell to retrieve.
columnIndex
Integer The column index of the cell to retrieve.

Return

TableCell — The table cell retrieved.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getColumn(columnIndex)

Returns the specified column in the table.

Parameters

Name Type Description
columnIndex
Integer The 0-based column index.

Return

TableColumn — The table column retrieved.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getConnectionSites()

Returns the list of ConnectionSite s on the page element, or an empty list if the page element does not have any connection sites.

Return

ConnectionSite[] — The connection sites list, which may be empty if this element has no connection sites.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getDescription()

Returns the page element's alt text description. The description is combined with the title to display and read alt text.

Return

String — The page element's alt text description.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getHeight()

Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation.

This method isn't compatible with all page elements. To learn which page elements aren't compatible with this method, refer to the sizing and positioning limitations .

Return

Number — The page element's inherent height in points, or null if the page element does not have a height.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getInherentHeight()

Returns the element's inherent height in points.

The page element's transform is relative to its inherent size. Use the inherent size in conjunction with the element's transform to determine the element's final visual appearance.

Return

Number — The page element's inherent height in points, or null if the page element does not have a height.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getInherentWidth()

Returns the element's inherent width in points.

The page element's transform is relative to its inherent size. Use the inherent size in conjunction with the element's transform to determine the element's final visual appearance.

Return

Number — The page element's inherent width in points, or null if the page element does not have a width.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getLeft()

Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation.

Return

Number — This element's horizontal position in points, from the upper-left corner of the page.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getNumColumns()

Returns the number of columns in the table.

Return

Integer — The number fo columns in this table.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getNumRows()

Returns the number of rows in the table.

Return

Integer — The number of rows in this table.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getObjectId()

Returns the unique ID for this object. Object IDs used by pages and page elements share the same namespace.

Return

String — The unique ID for this object.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getPageElementType()

Returns the page element's type, represented as a PageElementType enum.

Return

PageElementType — The page element's type.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getParentGroup()

Returns the group this page element belongs to, or null if the element is not in a group.

Return

Group — The group this page element belongs to, or null .

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getParentPage()

Returns the page this page element is on.

Return

Page — The page this element resides on.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getRotation()

Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation.

Return

Number — The rotation angle in degrees between 0 (inclusive) and 360 (exclusive).

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getRow(rowIndex)

Returns the specified row in the table.

Parameters

Name Type Description
rowIndex
Integer The index of the row to retrieve.

Return

TableRow — The table row retrieved.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getTitle()

Returns the page element's alt text title. The title is combined with the description to display and read alt text.

Return

String — The page element's alt text title.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getTop()

Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation.

Return

Number — This element's vertical position in points, from the upper-left corner of the page.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getTransform()

Returns the page element's transform.

The visual appearance of the page element is determined by its absolute transform. To compute the absolute transform, preconcatenate a page element's transform with the transforms of all of its parent groups. If the page element is not in a group, its absolute transform is the same as the value in this field.

Return

AffineTransform — The page element's transform.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getWidth()

Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation.

This method isn't compatible with all page elements. To learn which page elements aren't compatible with this method, refer to the sizing and positioning limitations .

Return

Number — The page element's inherent width in points, or null if the page element does not have a width.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

insertColumn(index)

Inserts a new column at the specified index of the table.

If all the cells in the column to the left of the specified index are merged with other columns, the new column is inserted to the right of the common columns spanned by these cells.

Parameters

Name Type Description
index
Integer The index at which to insert a new column.

Return

TableColumn — The new inserted column.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

insertRow(index)

Inserts a new row at the specified index of the table.

If all the cells in the row above the specified index are merged with other rows, the new row is inserted below the common rows spanned by these cells.

Parameters

Name Type Description
index
Integer The index at which to insert a new row.

Return

TableRow — The new inserted row.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

preconcatenateTransform(transform)

Preconcatenates the provided transform to the existing transform of the page element.

newTransform = argument * existingTransform

For example, to move a page elements 36 points to the left:

element.preconcatenateTransform(SlidesApp.newAffineTransformBuilder()
    .setTranslateX(-36.0)
    .build());

You can also replace the page element's transform with setTransform(transform) .

Parameters

Name Type Description
transform
AffineTransform The transform to preconcatenate onto this page element's transform.

Return

Table — This page element, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

remove()

Removes the page element.

If after a remove operation, a Group contains only one or no page elements, the group itself is also removed.

If a placeholder PageElement is removed on a master or layout, any empty inheriting placeholders are also removed.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

scaleHeight(ratio)

Scales the element's height by the specified ratio. The element's height is the height of its bounding box when the element has no rotation.

This method isn't compatible with all page elements. To learn which page elements aren't compatible with this method, refer to the sizing and positioning limitations .

Parameters

Name Type Description
ratio
Number The ratio to scale this page element's height by.

Return

Table — This page element, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

scaleWidth(ratio)

Scales the element's width by the specified ratio. The element's width is the width of its bounding box when the element has no rotation.

This method isn't compatible with all page elements. To learn which page elements aren't compatible with this method, refer to the sizing and positioning limitations .

Parameters

Name Type Description
ratio
Number The ratio to scale this page element's width by.

Return

Table — This page element, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

select()

Selects only the PageElement in the active presentation and removes any previous selection. This is the same as calling select(replace) with true .

A script can only access the selection of the user who is running the script, and only if the script is bound to the presentation.

This sets the parent Page of the PageElement as the current page selection .

 var 
  
 slide 
  
 = 
  
 SlidesApp 
 . 
 getActivePresentation 
 () 
 . 
 getSlides 
 ()[ 
 0 
 ]; 
 var 
  
 pageElement 
  
 = 
  
 slide 
 . 
 getPageElements 
 ()[ 
 0 
 ]; 
 // 
  
 Only 
  
 select 
  
 this 
  
 page 
  
 element 
  
 and 
  
 replace 
  
 any 
  
 previous 
  
 selection 
 . 
 pageElement 
 . 
 select 
 (); 

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

select(replace)

Selects the PageElement in the active presentation.

A script can only access the selection of the user who is running the script, and only if the script is bound to the presentation.

Pass true to this method to select only the PageElement and remove any previous selection. This also sets the parent Page of the PageElement as the current page selection .

Pass false to select multiple PageElement objects. The PageElement objects must be in the same Page .

The following conditions must be met while selecting a page element using a false parameter:

  1. The parent Page of the PageElement object must be the current page selection .
  2. There should not be multiple Page objects selected.

To make sure that’s the case the preferred approach is to select the parent Page first using Page.selectAsCurrentPage() and then select the page elements in that page.

 var 
  
 slide 
  
 = 
  
 SlidesApp 
 . 
 getActivePresentation 
 (). 
 getSlides 
 () 
 [ 
 0 
 ] 
 ; 
 // 
  
 First 
  
 select 
  
 the 
  
 slide 
  
 page 
 , 
  
 as 
  
 the 
  
 current 
  
 page 
  
 selection 
 . 
 slide 
 . 
 selectAsCurrentPage 
 (); 
 // 
  
 Then 
  
 select 
  
 all 
  
 the 
  
 page 
  
 elements 
  
 in 
  
 the 
  
 selected 
  
 slide 
  
 page 
 . 
 var 
  
 pageElements 
  
 = 
  
 slide 
 . 
 getPageElements 
 (); 
 for 
  
 ( 
 var 
  
 i 
  
 = 
  
 0 
 ; 
  
 i 
 < 
 pageElements 
 . 
 length 
 ; 
  
 i 
 ++ 
 ) 
  
 { 
  
 pageElements 
 [ 
 i 
 ] 
 . 
 select 
 ( 
 false 
 ); 
 } 

Parameters

Name Type Description
replace
Boolean If true , the selection replaces any previous selection; otherwise the selection is added to any previous selection.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

sendBackward()

Sends the page element backward on the page by one element.

The page element must not be in a group.

Return

Table — This page element, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

sendToBack()

Sends the page element to the back of the page.

The page element must not be in a group.

Return

Table — This page element, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setDescription(description)

Sets the page element's alt text description.

The method is not supported for Group elements.

 // 
  
 Set 
  
 the 
  
 first 
  
 page 
  
 element 
 's alt text description to "new alt text description". 
 var 
  
 pageElement 
  
 = 
  
 SlidesApp 
 . 
 getActivePresentation 
 () 
 . 
 getSlides 
 ()[ 
 0 
 ] 
 . 
 getPageElements 
 ()[ 
 0 
 ]; 
 pageElement 
 . 
 setDescription 
 ( 
 'new alt text description' 
 ); 
 Logger 
 . 
 log 
 ( 
 pageElement 
 . 
 getDescription 
 ()); 

Parameters

Name Type Description
description
String The string to set the alt text description to.

Return

Table — This page element.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setHeight(height)

Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation.

This method isn't compatible with all page elements. To learn which page elements aren't compatible with this method, refer to the sizing and positioning limitations .

Parameters

Name Type Description
height
Number The new height of this page element to set, in points.

Return

Table — This page element, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setLeft(left)

Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation.

Parameters

Name Type Description
left
Number The new horizontal position to set, in points.

Return

Table — This page element, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setRotation(angle)

Sets the element's clockwise rotation angle around its center in degrees.

This method isn't compatible with all page elements. To learn which page elements aren't compatible with this method, refer to the sizing and positioning limitations .

Parameters

Name Type Description
angle
Number The new clockwise rotation angle to set, in degrees.

Return

Table — This page element, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setTitle(title)

Sets the page element's alt text title.

The method is not supported for Group elements.

 // 
  
 Set 
  
 the 
  
 first 
  
 page 
  
 element 
 's alt text title to "new alt text title". 
 var 
  
 pageElement 
  
 = 
  
 SlidesApp 
 . 
 getActivePresentation 
 () 
 . 
 getSlides 
 ()[ 
 0 
 ] 
 . 
 getPageElements 
 ()[ 
 0 
 ]; 
 pageElement 
 . 
 setTitle 
 ( 
 'new alt text title' 
 ); 
 Logger 
 . 
 log 
 ( 
 pageElement 
 . 
 getTitle 
 ()); 

Parameters

Name Type Description
title
String The string to set the alt text title to.

Return

Table — This page element.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setTop(top)

Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation.

Parameters

Name Type Description
top
Number The new vertical position to set, in points.

Return

Table — This page element, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setTransform(transform)

Sets the transform of the page element with the provided transform.

Updating the transform of a group changes the absolute transform of the page elements in that group, which can change their visual appearance.

Updating the transform of a page element that is in a group only changes the transform of that page element; it doesn't affect the transforms of the group or other page elements in the group.

For details on how transforms impact the visual appearance of page elements, see getTransform() .

Parameters

Name Type Description
transform
AffineTransform The transform that is set for this page element.

Return

Table — This element, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setWidth(width)

Sets the element's width in points, which is the width of the element's bounding box when the element has no rotation.

This method isn't compatible with all page elements. To learn which page elements aren't compatible with this method, refer to the sizing and positioning limitations .

Parameters

Name Type Description
width
Number The new width of this page element to set, in points.

Return

Table — This page element, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations