Class Line

Line

A PageElement representing a line.

Methods

MethodReturn typeBrief description
alignOnPage(alignmentPosition)LineAligns the element to the specified alignment position on the page.
duplicate()PageElementDuplicates the page element.
getDashStyle()DashStyleGets the DashStyle of the line.
getDescription()StringGets the page element's description.
getEnd()PointReturns the end point of the line, measured from the upper left corner of the page.
getEndArrow()ArrowStyleGets the ArrowStyle of the arrow at the end of the line.
getHeight()NumberGets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
getInherentHeight()NumberGets the element's inherent height in points.
getInherentWidth()NumberGets the element's inherent width in points.
getLeft()NumberGets the element's horizontal position in points, measured from the upper left corner of the page when the element has no rotation.
getLineFill()LineFillGets the LineFill of the line.
getLineType()LineTypeGets the LineType of the line.
getLink()LinkReturns the Link or null if there is no link.
getObjectId()StringGets the unique ID for this object.
getPageElementType()PageElementTypeGets the page element's type, represented as a PageElementType enum.
getParentGroup()GroupGets the group this page element is in, or null if the element is not in a group.
getParentPage()PageGets the page this page element is on.
getRotation()NumberGets the element's clockwise rotation angle around its center in degrees, where 0 degrees means no rotation.
getStart()PointReturns the start point of the line, measured from the upper left corner of the page.
getStartArrow()ArrowStyleGets the ArrowStyle of the arrow at the beginning of the line.
getTitle()StringGets the page element's title.
getTop()NumberGets the element's vertical position in points, measured from the upper left corner of the page when the element has no rotation.
getTransform()AffineTransformGets the page element's transform.
getWeight()NumberGets the thickness of the line in points.
getWidth()NumberGets the element's width in points, which is the width of the element's bounding box when the element has no rotation.
preconcatenateTransform(transform)LinePreconcatenates the provided transform to the existing transform of the page element.
remove()voidRemoves the page element.
removeLink()voidRemoves a Link.
scaleHeight(ratio)LineScales the element's height by the specified ratio.
scaleWidth(ratio)LineScales the element's width by the specified ratio.
select()voidSelects only the PageElement in the active presentation and removes any previous selection.
select(replace)voidSelects the PageElement in the active presentation.
setDashStyle(style)LineSets the DashStyle of the line.
setEnd(left, top)LineSets the position of the end point of the line.
setEnd(point)LineSets the position of the end point of the line.
setEndArrow(style)LineSets the ArrowStyle of the arrow at the end of the line.
setHeight(height)LineSets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
setLeft(left)LineSets the element's horizontal position in points, measured from the upper left corner of the page when the element has no rotation.
setLinkSlide(slideIndex)LinkSets a Link to the given Slide using the zero-based index of the slide.
setLinkSlide(slide)LinkSets a Link to the given Slide, the link is set by the given slide ID.
setLinkSlide(slidePosition)LinkSets a Link to the given Slide using the relative position of the slide.
setLinkUrl(url)LinkSets a Link to the given non-empty URL string.
setRotation(angle)LineSets the element's clockwise rotation angle around its center in degrees.
setStart(left, top)LineSets the position of the start point of the line.
setStart(point)LineSets the position of the start point of the line.
setStartArrow(style)LineSets the ArrowStyle of the arrow at the beginning of the line.
setTop(top)LineSets the element's vertical position in points, measured from the upper left corner of the page when the element has no rotation.
setTransform(transform)LineSets the transform of the page element with the provided transform.
setWeight(points)LineSets the thickness of the line in points.
setWidth(width)LineSets 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

NameTypeDescription
alignmentPositionAlignmentPosition

Return

Line


duplicate()

Duplicates the page element.

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

Return

PageElement


getDashStyle()

Gets the DashStyle of the line.

Return

DashStyle


getDescription()

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

Return

String — the page element's description.


getEnd()

Returns the end point of the line, measured from the upper left corner of the page.

Return

Point


getEndArrow()

Gets the ArrowStyle of the arrow at the end of the line.

Return

ArrowStyle


getHeight()

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

Return

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


getInherentHeight()

Gets 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.


getInherentWidth()

Gets 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.


getLeft()

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

Return

Number


getLineFill()

Gets the LineFill of the line.

Return

LineFill


getLineType()

Gets the LineType of the line.

Return

LineType


getLink()

Returns the Link or null if there is no link.

 var link = shape.getLink();
 if (link != null) {
   Logger.log('Shape has a link of type: ' + link.getLinkType());
 }
 

Return

Link


getObjectId()

Gets 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.


getPageElementType()

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

Return

PageElementType — the page element's type.


getParentGroup()

Gets the group this page element is in, or null if the element is not in a group.

Return

Group


getParentPage()

Gets the page this page element is on.

Return

Page


getRotation()

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

Return

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


getStart()

Returns the start point of the line, measured from the upper left corner of the page.

Return

Point


getStartArrow()

Gets the ArrowStyle of the arrow at the beginning of the line.

Return

ArrowStyle


getTitle()

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

Return

String — the page element's title.


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


getTransform()

Gets 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.


getWeight()

Gets the thickness of the line in points.

Return

Number


getWidth()

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

Return

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


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

NameTypeDescription
transformAffineTransform

Return

Line


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 Shape is removed on a master or layout, any empty inheriting shapes are also removed.


removeLink()

Removes a Link.

 shape.removeLink();
 

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.

Parameters

NameTypeDescription
ratioNumber

Return

Line


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.

Parameters

NameTypeDescription
ratioNumber

Return

Line


select()

Selects only the PageElement in the active presentation and removes any previous selection. This is 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();
 

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.

The select(true) selects only the PageElement and removes any previous selection. This also sets the parent Page of the PageElement as the current page selection.

select(false) should be used 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 select(false):
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

NameTypeDescription
replaceBooleanif true, the selection replaces any previous selection, otherwise the selection is added to any previous selection.

setDashStyle(style)

Sets the DashStyle of the line.

Parameters

NameTypeDescription
styleDashStyle

Return

Line


setEnd(left, top)

Sets the position of the end point of the line.

The line path may be adjusted after the position changes.

Parameters

NameTypeDescription
leftNumberThe horizontal position of the end point of the line, measured in points from the upper left corner of the page.
topNumberThe vertical position of the end point of the line, measured in points from the upper left corner of the page.

Return

Line


setEnd(point)

Sets the position of the end point of the line.

The line path may be adjusted after the position changes.

Parameters

NameTypeDescription
pointPointThe end point of the line, whose position is measured from the upper left corner of the page.

Return

Line


setEndArrow(style)

Sets the ArrowStyle of the arrow at the end of the line.

Parameters

NameTypeDescription
styleArrowStyle

Return

Line


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.

Parameters

NameTypeDescription
heightNumber

Return

Line


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

NameTypeDescription
leftNumber

Return

Line


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.
 shape.setLinkSlide(0);
 

Parameters

NameTypeDescription
slideIndexIntegerThe zero-based index to the slide.

Return

Link — the Link that was set


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.
 var slide = presentation.getSlides()[0];
 shape.setLinkSlide(slide);
 

Parameters

NameTypeDescription
slideSlideThe Slide to be linked.

Return

Link — the Link that was set


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.
 shape.setLinkSlide(SlideApp.SlidePosition.FIRST_SLIDE);
 

Parameters

NameTypeDescription
slidePositionSlidePositionThe relative SlidePosition.

Return

Link — the Link that was set


setLinkUrl(url)

Sets a Link to the given non-empty URL string.

 // Set a link to the URL.
 shape.setLinkUrl("https://slides.google.com");
 

Parameters

NameTypeDescription
urlStringThe URL string.

Return

Link — the Link that was set


setRotation(angle)

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

Parameters

NameTypeDescription
angleNumber

Return

Line


setStart(left, top)

Sets the position of the start point of the line.

The line path may be adjusted after the position changes.

Parameters

NameTypeDescription
leftNumberThe horizontal position of the start point of the line, measured in points from the upper left corner of the page.
topNumberThe vertical position of the start point of the line, measured in points from the upper left corner of the page.

Return

Line


setStart(point)

Sets the position of the start point of the line.

The line path may be adjusted after the position changes.

Parameters

NameTypeDescription
pointPointThe start point of the line, whose position is measured from the upper left corner of the page.

Return

Line


setStartArrow(style)

Sets the ArrowStyle of the arrow at the beginning of the line.

Parameters

NameTypeDescription
styleArrowStyle

Return

Line


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

NameTypeDescription
topNumber

Return

Line


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 visual appearance of page elements, see getTransform().

Parameters

NameTypeDescription
transformAffineTransform

Return

Line


setWeight(points)

Sets the thickness of the line in points.

Parameters

NameTypeDescription
pointsNumber

Return

Line


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.

Parameters

NameTypeDescription
widthNumber

Return

Line

Send feedback about...

Apps Script
Apps Script