A PageElement
representing a 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. |
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
Line
— This page element, for chaining.
bringForward()
Brings the page element forward on the page by one element.
The page element must not be in a group.
Return
Line
— 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
Line
— 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
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
getDashStyle()
Gets the DashStyle
of the line.
Return
DashStyle
— The style of the dashing used with this line.
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
getEnd()
Returns the end point of the line, measured from the upper-left corner of the page.
Return
Point
— The ending point of the line.
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
getEndArrow()
Gets the ArrowStyle
of the arrow at the end of the line.
Return
ArrowStyle
— The style of the arrow at the end of this line.
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
getEndConnection()
Returns the connection at the end of the line, or null
if there is no connection.
Return
ConnectionSite
— The connection at the end of the line.
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
getLineCategory()
Gets the LineCategory
of the line.
Return
LineCategory
— The line category.
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
getLineFill()
getLineType()
getLink()
Returns the Link
or null
if there is no link.
const shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0]; const link = shape.getLink(); if (link != null) { Logger.log(`Shape has a link of type: ${link.getLinkType()}`); }
Return
Link
— The Link
or null
if there is no link.
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
getStart()
Returns the start point of the line, measured from the upper-left corner of the page.
Return
Point
— The starting point of the line.
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
getStartArrow()
Gets the ArrowStyle
of the arrow at the beginning of the line.
Return
ArrowStyle
— The style of the arrow at the beginning of this line.
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
getStartConnection()
Returns the connection at the beginning of the line, or null
if there is no connection.
Return
ConnectionSite
— The connection at the beginning of the line.
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
getWeight()
Returns the thickness of the line in points.
Return
Number
— The thickness of the line in points.
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
isConnector()
Returns true
if the line is a connector, or false
if not.
Connector is a type of line that is used to connect connections sites on applicable page elements. Each end of the connector can be connected to at most one connection site.
Return
Boolean
— True
if the line is a connector, or false
if not.
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:
const element = SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0]; 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
Line
— 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
removeLink()
Removes a Link
.
const slides = SlidesApp.getActivePresentation().getSlides(); slides[1].getShapes()[0].removeLink();
reroute()
Reroutes the start and end of the line to the closest two connection sites on the connected page elements. The start and end of the line must be connected to different page elements.
Return
Line
— The line.
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
Line
— 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
Line
— 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
.
const slide = SlidesApp.getActivePresentation().getSlides()[0]; const 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:
- The parent
Page
of thePageElement
object must be thecurrent page selection
. - 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.
const 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. const pageElements = slide.getPageElements(); for (let 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
Line
— 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
Line
— 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
setDashStyle(style)
Sets the DashStyle
of the line.
Parameters
Name | Type | Description |
---|---|---|
style | DashStyle | The style of the dashing to set for this line. |
Return
Line
— This line, 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". const 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
Line
— 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
setEnd(left, top)
Sets the position of the end point of the line.
The line path may be adjusted after the position changes.
Parameters
Name | Type | Description |
---|---|---|
left | Number | The horizontal position of the end point of the line, measured in points from the upper left corner of the page. |
top | Number | The vertical position of the end point of the line, measured in points from the upper left corner of the page. |
Return
Line
— This line, 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
setEnd(point)
Sets the position of the end point of the line.
The line path may be adjusted after the position changes.
Parameters
Name | Type | Description |
---|---|---|
point | Point | The end point of the line, whose position is measured from the upper left corner of the page. |
Return
Line
— This line, 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
setEndArrow(style)
Sets the ArrowStyle
of the arrow at the end of the line.
Parameters
Name | Type | Description |
---|---|---|
style | ArrowStyle | The style to set. |
Return
Line
— This line, 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
setEndConnection(connectionSite)
Sets the connection at the end of the line. It moves the end of the line to the specified connection site while keeping the other end intact.
Parameters
Name | Type | Description |
---|---|---|
connectionSite | ConnectionSite | The connection site the end connection is updated to, or null if
removing the end connection. |
Return
Line
— The line.
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
Line
— 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
Line
— 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
setLineCategory(lineCategory)
Sets the LineCategory
of the line.
You can only set the category on connectors
. The connector may be
rerouted after changing its category.
Parameters
Name | Type | Description |
---|---|---|
lineCategory | LineCategory | The line category to set. |
Return
Line
— The line.
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
setLinkSlide(slideIndex)
Sets a Link
to the given Slide
using the zero-based index of the slide.
// Set a link to the first slide of the presentation. const slides = SlidesApp.getActivePresentation().getSlides(); const shape = slides[1].getShapes()[0]; const link = shape.setLinkSlide(0);
Parameters
Name | Type | Description |
---|---|---|
slideIndex | Integer | The zero-based index to the slide. |
Return
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
setLinkSlide(slide)
Sets a Link
to the given Slide
, the link is set by the given slide ID.
// Set a link to the first slide of the presentation. const slides = SlidesApp.getActivePresentation().getSlides(); const shape = slides[1].getShapes()[0]; const link = shape.setLinkSlide(slides[0]);
Parameters
Name | Type | Description |
---|---|---|
slide | Slide | The Slide to be linked. |
Return
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
setLinkSlide(slidePosition)
Sets a Link
to the given Slide
using the relative position of the slide.
// Set a link to the first slide of the presentation. const slides = SlidesApp.getActivePresentation().getSlides(); const shape = slides[1].getShapes()[0]; const link = shape.setLinkSlide(SlidesApp.SlidePosition.FIRST_SLIDE);
Parameters
Name | Type | Description |
---|---|---|
slidePosition | SlidePosition | The relative SlidePosition . |
Return
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
setLinkUrl(url)
Sets a Link
to the given non-empty URL string.
// Set a link to the URL. const slides = SlidesApp.getActivePresentation().getSlides(); const shape = slides[1].getShapes()[0]; const link = shape.setLinkUrl('https://slides.google.com');
Parameters
Name | Type | Description |
---|---|---|
url | String | The URL string. |
Return
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
Line
— 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
setStart(left, top)
Sets the position of the start point of the line.
The line path may be adjusted after the position changes.
Parameters
Name | Type | Description |
---|---|---|
left | Number | The horizontal position of the start point of the line, measured in points from the upper left corner of the page. |
top | Number | The vertical position of the start point of the line, measured in points from the upper left corner of the page. |
Return
Line
— This line, 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
setStart(point)
Sets the position of the start point of the line.
The line path may be adjusted after the position changes.
Parameters
Name | Type | Description |
---|---|---|
point | Point | The start point of the line, whose position is measured from the upper left corner of the page. |
Return
Line
— This line, 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
setStartArrow(style)
Sets the ArrowStyle
of the arrow at the beginning of the line.
Parameters
Name | Type | Description |
---|---|---|
style | ArrowStyle | The new arrow style to set. |
Return
Line
— This line, 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
setStartConnection(connectionSite)
Sets the connection at the beginning of the line. It moves the start of the line to the specified connection site while keeping the other end intact.
Parameters
Name | Type | Description |
---|---|---|
connectionSite | ConnectionSite | The connection site the start connection is updated to, or null
if removing the start connection. |
Return
Line
— The line.
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". const 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
Line
— 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
Line
— 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
Line
— 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
setWeight(points)
Sets the thickness of the line in points.
Parameters
Name | Type | Description |
---|---|---|
points | Number | The new thickness of the line in points. |
Return
Line
— This line, 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
Line
— 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