Эта служба позволяет сценариям создавать, получать доступ и изменять файлы Google Slides. См. также документацию Google Slides для получения более подробной информации об основных функциях сервиса Slides.
Классы
| Имя | Краткое описание |
|---|---|
AffineTransform | Матрица 3x3, используемая для преобразования координат источника (x1, y1) в координаты пункта назначения (x2, y2) в соответствии с умножением матрицы: |
AffineTransformBuilder | Построитель объектов AffineTransform . |
AlignmentPosition | Позиция выравнивания для применения. |
ArrowStyle | Виды начальной и конечной форм, с помощью которых можно визуализировать линейную геометрию. |
AutoText | Элемент текста, который динамически заменяется содержимым, которое может меняться со временем, например номер слайда. |
AutoTextType | Типы автотекста. |
Autofit | Описывает параметры автоподбора фигуры. |
AutofitType | Типы автоподбора. |
Border | Описывает границу вокруг элемента. |
CellMergeState | Состояния слияния ячеек таблицы. |
Color | Непрозрачный цвет |
ColorScheme | Цветовая схема определяет сопоставление элементов ThemeColorType с фактическими цветами, используемыми для их отображения. |
ConnectionSite | Сайт подключения на PageElement , который может подключаться к connector . |
ContentAlignment | Выравнивание содержимого для Shape или TableCell . |
DashStyle | Типы штрихов, с помощью которых можно отобразить линейную геометрию. |
Fill | Описывает фон элемента страницы |
FillType | Виды заливки. |
Group | Коллекция PageElement , объединенных в единое целое. |
Image | PageElement представляющий изображение. |
Layout | Макет в презентации. |
Line | PageElement , представляющий линию. |
LineCategory | Категория линии. |
LineFill | Описывает заливку линии или контура |
LineFillType | Виды заполнения строки. |
LineType | Типы линий. |
Link | Гипертекстовая ссылка. |
LinkType | Типы Link . |
List | Список в тексте. |
ListPreset | Предустановленные шаблоны глифов для списков в тексте. |
ListStyle | Стиль списка для диапазона текста. |
Master | Мастер в презентации. |
NotesMaster | Мастер заметок в презентации. |
NotesPage | Страница заметок в презентации. |
Page | Страница в презентации. |
PageBackground | Описывает фон страницы |
PageBackgroundType | Виды фонов страниц. |
PageElement | Визуальный элемент, отображаемый на странице. |
PageElementRange | Коллекция из одного или нескольких экземпляров PageElement . |
PageElementType | Тип элемента страницы. |
PageRange | Коллекция из одного или нескольких экземпляров Page . |
PageType | Типы страниц. |
Paragraph | Сегмент текста, заканчивающийся символом новой строки. |
ParagraphAlignment | Типы выравнивания текста для абзаца. |
ParagraphStyle | Стили текста, которые применяются ко всем абзацам. |
PictureFill | Заливка, которая визуализирует изображение, растянутое до размеров контейнера. |
PlaceholderType | Типы заполнителей. |
Point | Точка, представляющая местоположение. |
PredefinedLayout | Предустановленные макеты. |
Presentation | Презентация. |
Selection | Выбор пользователя в активной презентации. |
SelectionType | Тип Selection . |
Shape | PageElement , представляющий общую фигуру, не имеющую более конкретной классификации. |
ShapeType | Типы фигур. |
SheetsChart | Элемент PageElement , представляющий связанную диаграмму, встроенную из Google Sheets. |
SheetsChartEmbedType | Тип встраивания диаграммы Sheets. |
Slide | Слайд в презентации. |
SlideLinkingMode | Режим ссылок между слайдами. |
SlidePosition | Относительное положение Slide . |
SlidesApp | Создает и открывает Presentations , которые можно редактировать. |
SolidFill | Заливка сплошным цветом. |
SpacingMode | Различные режимы межабзацевого интервала. |
Table | PageElement представляющий таблицу. |
TableCell | Ячейка в таблице. |
TableCellRange | Коллекция из одного или нескольких экземпляров TableCell . |
TableColumn | Столбец в таблице. |
TableRow | Строка в таблице. |
TextBaselineOffset | Смещение текста по вертикали относительно его нормального положения. |
TextDirection | Текст направлений может втекать. |
TextRange | Сегмент текстового содержимого Shape или TableCell . |
TextStyle | Стиль текста. |
ThemeColor | Цвет, который относится к записи в ColorScheme страницы. |
ThemeColorType | Название записи в цветовой схеме страницы. |
Video | PageElement , представляющий видео. |
VideoSourceType | Типы источника видео. |
WordArt | PageElement представляющий искусство слова. |
AffineTransform
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
getScaleX() | Number | Получает элемент масштабирования координаты X. |
getScaleY() | Number | Получает элемент масштабирования координаты Y. |
getShearX() | Number | Получает элемент сдвига по координате X. |
getShearY() | Number | Получает элемент сдвига по координате Y. |
getTranslateX() | Number | Получает элемент перевода координаты X в точках. |
getTranslateY() | Number | Получает элемент перевода координаты Y в точках. |
toBuilder() | AffineTransformBuilder | Возвращает новый AffineTransformBuilder на основе этого преобразования. |
AffineTransformBuilder
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
build() | AffineTransform | Создает объект AffineTransform , инициализированный элементами, установленными в построителе. |
setScaleX(scaleX) | AffineTransformBuilder | Задает элемент масштабирования координаты X и возвращает построитель. |
setScaleY(scaleY) | AffineTransformBuilder | Задает элемент масштабирования координаты Y и возвращает построитель. |
setShearX(shearX) | AffineTransformBuilder | Задает элемент сдвига по координате X и возвращает построитель. |
setShearY(shearY) | AffineTransformBuilder | Задает элемент сдвига по координате Y и возвращает построитель. |
setTranslateX(translateX) | AffineTransformBuilder | Задает элемент перевода координаты X в точках и возвращает построитель. |
setTranslateY(translateY) | AffineTransformBuilder | Задает элемент перевода координаты Y в точках и возвращает построитель. |
AlignmentPosition
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
CENTER | Enum | Выровнять по центру. |
HORIZONTAL_CENTER | Enum | Выровняйте по центру по горизонтали. |
VERTICAL_CENTER | Enum | Выровняйте по вертикальному центру. |
ArrowStyle
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
UNSUPPORTED | Enum | Неподдерживаемый стиль стрелки. |
NONE | Enum | Нет стрелки. |
STEALTH_ARROW | Enum | Стрелка с зазубренной спинкой. |
FILL_ARROW | Enum | Заполненная стрелка. |
FILL_CIRCLE | Enum | Заполненный круг. |
FILL_SQUARE | Enum | Заполненный квадрат. |
FILL_DIAMOND | Enum | Заполненный алмаз. |
OPEN_ARROW | Enum | Полая стрелка. |
OPEN_CIRCLE | Enum | Полый круг. |
OPEN_SQUARE | Enum | Полый квадрат. |
OPEN_DIAMOND | Enum | Полый бриллиант. |
AutoText
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
getAutoTextType() | AutoTextType | Возвращает тип автотекста. |
getIndex() | Integer | Возвращает индекс автотекста. |
getRange() | TextRange | Возвращает TextRange , охватывающий автоматический текст. |
AutoTextType
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
UNSUPPORTED | Enum | Тип автотекста, который не поддерживается. |
SLIDE_NUMBER | Enum | Номер слайда. |
Autofit
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
disableAutofit() | Autofit | Устанавливает для AutofitType фигуры значение AutofitType.NONE . |
getAutofitType() | AutofitType | Получает AutofitType фигуры. |
getFontScale() | Number | Получает масштаб шрифта, применяемый к фигуре. |
getLineSpacingReduction() | Number | Получает уменьшение межстрочного интервала, применяемое к фигуре. |
AutofitType
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
UNSUPPORTED | Enum | Тип автоподбора, который не поддерживается. |
NONE | Enum | Автоподгонка не применяется. |
TEXT_AUTOFIT | Enum | Уменьшает текст при переполнении. |
SHAPE_AUTOFIT | Enum | Изменяет размер фигуры в соответствии с текстом. |
Border
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
getDashStyle() | DashStyle | Получает DashStyle границы. |
getLineFill() | LineFill | Получает LineFill границы. |
getWeight() | Number | Получает толщину границы в пунктах. |
isVisible() | Boolean | Получает, видна ли граница или нет. |
setDashStyle(style) | Border | Устанавливает DashStyle границы. |
setTransparent() | Border | Делает границу прозрачной. |
setWeight(points) | Border | Устанавливает толщину границы в пунктах. |
CellMergeState
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
NORMAL | Enum | Ячейка не объединена. |
HEAD | Enum | Ячейка объединена и является головной (т.е. |
MERGED | Enum | Ячейка объединена, но не является головной (т.е. |
Color
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
asRgbColor() | RgbColor | Преобразует этот цвет в RgbColor . |
asThemeColor() | ThemeColor | Преобразует этот цвет в ThemeColor . |
getColorType() | ColorType | Получите тип этого цвета. |
ColorScheme
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
getConcreteColor(theme) | Color | Возвращает конкретный Color , связанный с ThemeColorType в этой цветовой схеме. |
getThemeColors() | ThemeColorType[] | Возвращает список всех возможных типов цветов темы в цветовой схеме. |
setConcreteColor(type, color) | ColorScheme | Задает конкретный цвет, связанный с ThemeColorType в этой цветовой схеме, равным заданному цвету. |
setConcreteColor(type, red, green, blue) | ColorScheme | Задает конкретный цвет, связанный с ThemeColorType в этой цветовой схеме, равным заданному цвету в формате RGB. |
setConcreteColor(type, hexColor) | ColorScheme | Задает конкретный цвет, связанный с ThemeColorType в этой цветовой схеме, равным заданному цвету в шестнадцатеричном формате. |
ConnectionSite
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
getIndex() | Integer | Возвращает индекс сайта подключения. |
getPageElement() | PageElement | Возвращает PageElement , на котором находится сайт подключения. |
ContentAlignment
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
UNSUPPORTED | Enum | Неподдерживаемое выравнивание содержимого. |
TOP | Enum | Выравнивает содержимое по верхнему краю держателя содержимого. |
MIDDLE | Enum | Выравнивает содержимое по середине держателя содержимого. |
BOTTOM | Enum | Выравнивает содержимое по нижнему краю держателя содержимого. |
DashStyle
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
UNSUPPORTED | Enum | Стиль тире, который не поддерживается. |
SOLID | Enum | Сплошная линия. |
DOT | Enum | Пунктирная линия. |
DASH | Enum | Пунктир. |
DASH_DOT | Enum | Чередование тире и точки. |
LONG_DASH | Enum | Линия с крупными штрихами. |
LONG_DASH_DOT | Enum | Чередование больших тире и точек. |
Fill
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
getSolidFill() | SolidFill | Получите сплошную заливку этого фона или null , если тип заливки не FillType.SOLID . |
getType() | FillType | Получите тип этой заливки. |
isVisible() | Boolean | Виден ли фон. |
setSolidFill(color) | void | Устанавливает сплошную заливку на заданный Color . |
setSolidFill(color, alpha) | void | Устанавливает для сплошной заливки заданные значения альфы и Color . |
setSolidFill(red, green, blue) | void | Устанавливает сплошную заливку на заданные значения RGB. |
setSolidFill(red, green, blue, alpha) | void | Устанавливает сплошную заливку на заданные значения альфа-канала и RGB. |
setSolidFill(hexString) | void | Устанавливает сплошную заливку на заданную шестнадцатеричную цветовую строку. |
setSolidFill(hexString, alpha) | void | Устанавливает сплошную заливку для заданной альфа- и шестнадцатеричной цветовой строки. |
setSolidFill(color) | void | Устанавливает сплошную заливку на заданный ThemeColorType . |
setSolidFill(color, alpha) | void | Устанавливает сплошную заливку на заданный альфа-канал и ThemeColorType . |
setTransparent() | void | Делает фон прозрачным. |
FillType
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
UNSUPPORTED | Enum | Неподдерживаемый тип заполнения. |
NONE | Enum | Нет заливки, поэтому фон прозрачен. |
SOLID | Enum | Заливка сплошным цветом. |
Group
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
alignOnPage(alignmentPosition) | Group | Выравнивает элемент по указанной позиции выравнивания на странице. |
bringForward() | Group | Перемещает элемент страницы вперед на один элемент. |
bringToFront() | Group | Выводит элемент страницы на передний план страницы. |
duplicate() | PageElement | Дублирует элемент страницы. |
getChildren() | PageElement[] | Получает коллекцию элементов страницы в группе. |
getConnectionSites() | ConnectionSite[] | Возвращает список ConnectionSite в элементе страницы или пустой список, если элемент страницы не имеет сайтов подключения. |
getDescription() | String | Возвращает описание альтернативного текста элемента страницы. |
getHeight() | Number | Получает высоту элемента в пунктах, которая является высотой ограничивающей рамки элемента, когда элемент не имеет поворота. |
getInherentHeight() | Number | Возвращает внутреннюю высоту элемента в пунктах. |
getInherentWidth() | Number | Возвращает внутреннюю ширину элемента в пунктах. |
getLeft() | Number | Возвращает горизонтальное положение элемента в точках, измеренное от левого верхнего угла страницы, когда элемент не имеет поворота. |
getObjectId() | String | Возвращает уникальный идентификатор для этого объекта. |
getPageElementType() | PageElementType | Возвращает тип элемента страницы, представленный в виде перечисления PageElementType . |
getParentGroup() | Group | Возвращает группу, к которой принадлежит этот элемент страницы, или null если элемент не находится в группе. |
getParentPage() | Page | Возвращает страницу, на которой находится этот элемент страницы. |
getRotation() | Number | Возвращает угол поворота элемента по часовой стрелке вокруг его центра в градусах, где ноль градусов означает отсутствие вращения. |
getTitle() | String | Возвращает заголовок альтернативного текста элемента страницы. |
getTop() | Number | Получает положение элемента по вертикали в точках, измеренное от левого верхнего угла страницы, когда элемент не имеет поворота. |
getTransform() | AffineTransform | Получает преобразование элемента страницы. |
getWidth() | Number | Возвращает ширину элемента в пунктах, которая является шириной ограничивающей рамки элемента, когда элемент не имеет поворота. |
preconcatenateTransform(transform) | Group | Предварительно объединяет предоставленное преобразование с существующим преобразованием элемента страницы. |
remove() | void | Удаляет элемент страницы. |
scaleHeight(ratio) | Group | Масштабирует высоту элемента в указанном соотношении. |
scaleWidth(ratio) | Group | Масштабирует ширину элемента в указанном соотношении. |
select() | void | Выбирает только PageElement в активной презентации и удаляет любой предыдущий выбор. |
select(replace) | void | Выбирает PageElement в активной презентации. |
sendBackward() | Group | Отправляет элемент страницы назад на один элемент. |
sendToBack() | Group | Отправляет элемент страницы в конец страницы. |
setDescription(description) | Group | Устанавливает описание замещающего текста элемента страницы. |
setHeight(height) | Group | Устанавливает высоту элемента в пунктах, которая является высотой ограничивающей рамки элемента, когда элемент не имеет поворота. |
setLeft(left) | Group | Устанавливает горизонтальное положение элемента в пунктах, измеряемое от верхнего левого угла страницы, когда элемент не имеет поворота. |
setRotation(angle) | Group | Задает угол поворота элемента по часовой стрелке вокруг его центра в градусах. |
setTitle(title) | Group | Устанавливает заголовок альтернативного текста элемента страницы. |
setTop(top) | Group | Задает положение элемента по вертикали в пунктах, измеряемое от левого верхнего угла страницы, когда элемент не имеет поворота. |
setTransform(transform) | Group | Задает преобразование элемента страницы с предоставленным преобразованием. |
setWidth(width) | Group | Устанавливает ширину элемента в пунктах, которая является шириной ограничивающей рамки элемента, когда элемент не имеет поворота. |
ungroup() | void | Разгруппирует элементы группы. |
Image
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
alignOnPage(alignmentPosition) | Image | Выравнивает элемент по указанной позиции выравнивания на странице. |
bringForward() | Image | Перемещает элемент страницы вперед на один элемент. |
bringToFront() | Image | Выводит элемент страницы на передний план страницы. |
duplicate() | PageElement | Дублирует элемент страницы. |
getAs(contentType) | Blob | Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента. |
getBlob() | Blob | Верните данные внутри этого изображения в виде большого двоичного объекта. |
getBorder() | Border | Возвращает Border изображения. |
getConnectionSites() | ConnectionSite[] | Возвращает список ConnectionSite в элементе страницы или пустой список, если элемент страницы не имеет сайтов подключения. |
getContentUrl() | String | Получает URL-адрес изображения. |
getDescription() | String | Возвращает описание альтернативного текста элемента страницы. |
getHeight() | Number | Получает высоту элемента в пунктах, которая является высотой ограничивающей рамки элемента, когда элемент не имеет поворота. |
getInherentHeight() | Number | Возвращает внутреннюю высоту элемента в пунктах. |
getInherentWidth() | Number | Возвращает внутреннюю ширину элемента в пунктах. |
getLeft() | Number | Возвращает горизонтальное положение элемента в точках, измеренное от левого верхнего угла страницы, когда элемент не имеет поворота. |
getLink() | Link | Возвращает Link или null если ссылки нет. |
getObjectId() | String | Возвращает уникальный идентификатор для этого объекта. |
getPageElementType() | PageElementType | Возвращает тип элемента страницы, представленный в виде перечисления PageElementType . |
getParentGroup() | Group | Возвращает группу, к которой принадлежит этот элемент страницы, или null если элемент не находится в группе. |
getParentPage() | Page | Возвращает страницу, на которой находится этот элемент страницы. |
getParentPlaceholder() | PageElement | Возвращает элемент родительской страницы заполнителя. |
getPlaceholderIndex() | Integer | Возвращает индекс изображения-заполнителя. |
getPlaceholderType() | PlaceholderType | Возвращает тип заполнителя изображения или PlaceholderType.NONE , если фигура не является заполнителем. |
getRotation() | Number | Возвращает угол поворота элемента по часовой стрелке вокруг его центра в градусах, где ноль градусов означает отсутствие вращения. |
getSourceUrl() | String | Получает URL-адрес источника изображения, если он доступен. |
getTitle() | String | Возвращает заголовок альтернативного текста элемента страницы. |
getTop() | Number | Получает положение элемента по вертикали в точках, измеренное от левого верхнего угла страницы, когда элемент не имеет поворота. |
getTransform() | AffineTransform | Возвращает преобразование элемента страницы. |
getWidth() | Number | Возвращает ширину элемента в пунктах, которая является шириной ограничивающей рамки элемента, когда элемент не имеет поворота. |
preconcatenateTransform(transform) | Image | Предварительно объединяет предоставленное преобразование с существующим преобразованием элемента страницы. |
remove() | void | Удаляет элемент страницы. |
removeLink() | void | Удаляет Link . |
replace(blobSource) | Image | Заменяет это изображение изображением, описанным объектом BlobSource . |
replace(blobSource, crop) | Image | Заменяет это изображение изображением, описанным объектом Image , при необходимости обрезая изображение по размеру. |
replace(imageUrl) | Image | Заменяет это изображение другим изображением, загруженным с указанного URL-адреса. |
replace(imageUrl, crop) | Image | Заменяет это изображение другим изображением, загруженным с предоставленного URL-адреса, при необходимости обрезая изображение по размеру. |
scaleHeight(ratio) | Image | Масштабирует высоту элемента в указанном соотношении. |
scaleWidth(ratio) | Image | Масштабирует ширину элемента в указанном соотношении. |
select() | void | Выбирает только PageElement в активной презентации и удаляет любой предыдущий выбор. |
select(replace) | void | Выбирает PageElement в активной презентации. |
sendBackward() | Image | Отправляет элемент страницы назад на один элемент. |
sendToBack() | Image | Отправляет элемент страницы в конец страницы. |
setDescription(description) | Image | Устанавливает описание замещающего текста элемента страницы. |
setHeight(height) | Image | Устанавливает высоту элемента в пунктах, которая является высотой ограничивающей рамки элемента, когда элемент не имеет поворота. |
setLeft(left) | Image | Устанавливает горизонтальное положение элемента в пунктах, измеряемое от верхнего левого угла страницы, когда элемент не имеет поворота. |
setLinkSlide(slideIndex) | Link | Устанавливает Link на данный Slide , используя отсчитываемый от нуля индекс слайда. |
setLinkSlide(slide) | Link | Устанавливает Link на данный Slide , ссылка устанавливается по заданному идентификатору слайда. |
setLinkSlide(slidePosition) | Link | Устанавливает Link на данный Slide , используя относительное положение слайда. |
setLinkUrl(url) | Link | Устанавливает Link на заданную непустую строку URL. |
setRotation(angle) | Image | Задает угол поворота элемента по часовой стрелке вокруг его центра в градусах. |
setTitle(title) | Image | Устанавливает заголовок альтернативного текста элемента страницы. |
setTop(top) | Image | Задает положение элемента по вертикали в пунктах, измеряемое от левого верхнего угла страницы, когда элемент не имеет поворота. |
setTransform(transform) | Image | Задает преобразование элемента страницы с предоставленным преобразованием. |
setWidth(width) | Image | Устанавливает ширину элемента в пунктах, которая является шириной ограничивающей рамки элемента, когда элемент не имеет поворота. |
Layout
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
getBackground() | PageBackground | Получает фон страницы. |
getColorScheme() | ColorScheme | Получает ColorScheme , связанную со страницей. |
getGroups() | Group[] | Возвращает список объектов Group на странице. |
getImages() | Image[] | Возвращает список объектов Image на странице. |
getLayoutName() | String | Получает имя макета. |
getLines() | Line[] | Возвращает список объектов Line на странице. |
getMaster() | Master | Получает образец, на котором основан макет. |
getObjectId() | String | Получает уникальный идентификатор страницы. |
getPageElementById(id) | PageElement | Возвращает PageElement на странице с заданным идентификатором или null , если таковой не существует. |
getPageElements() | PageElement[] | Возвращает список объектов PageElement , отображаемых на странице. |
getPageType() | PageType | Получает тип страницы. |
getPlaceholder(placeholderType) | PageElement | Возвращает объект-заполнитель PageElement для указанного PlaceholderType или null , если соответствующий заполнитель отсутствует. |
getPlaceholder(placeholderType, placeholderIndex) | PageElement | Возвращает объект PageElement заполнителя для указанного PlaceholderType и индекса заполнителя или null , если заполнитель отсутствует. |
getPlaceholders() | PageElement[] | Возвращает список объектов-заполнителей PageElement на странице. |
getShapes() | Shape[] | Возвращает список объектов Shape на странице. |
getSheetsCharts() | SheetsChart[] | Возвращает список объектов SheetsChart на странице. |
getTables() | Table[] | Возвращает список объектов Table на странице. |
getVideos() | Video[] | Возвращает список объектов Video на странице. |
getWordArts() | WordArt[] | Возвращает список объектов WordArt на странице. |
group(pageElements) | Group | Группирует все указанные элементы страницы. |
insertGroup(group) | Group | Вставляет копию предоставленной Group на страницу. |
insertImage(blobSource) | Image | Вставляет изображение в верхнем левом углу страницы с размером по умолчанию из указанного большого двоичного объекта изображения. |
insertImage(blobSource, left, top, width, height) | Image | Вставляет изображение на страницу с указанным положением и размером из указанного большого двоичного объекта изображения. |
insertImage(image) | Image | Вставляет копию предоставленного Image на страницу. |
insertImage(imageUrl) | Image | Вставляет изображение в верхний левый угол страницы с размером по умолчанию из указанного URL-адреса. |
insertImage(imageUrl, left, top, width, height) | Image | Вставляет изображение на страницу с указанным положением и размером из предоставленного URL-адреса. |
insertLine(line) | Line | Вставляет копию предоставленной Line на страницу. |
insertLine(lineCategory, startConnectionSite, endConnectionSite) | Line | Вставляет на страницу линию, соединяющую два connection sites . |
insertLine(lineCategory, startLeft, startTop, endLeft, endTop) | Line | Вставляет строку на страницу. |
insertPageElement(pageElement) | PageElement | Вставляет копию предоставленного PageElement на страницу. |
insertShape(shape) | Shape | Вставляет копию предоставленной Shape на страницу. |
insertShape(shapeType) | Shape | Вставляет фигуру на страницу. |
insertShape(shapeType, left, top, width, height) | Shape | Вставляет фигуру на страницу. |
insertSheetsChart(sourceChart) | SheetsChart | Вставляет диаграмму Google Sheets на страницу. |
insertSheetsChart(sourceChart, left, top, width, height) | SheetsChart | Вставляет диаграмму Google Sheets на страницу с указанным положением и размером. |
insertSheetsChart(sheetsChart) | SheetsChart | Вставляет копию предоставленного SheetsChart на страницу. |
insertSheetsChartAsImage(sourceChart) | Image | Вставляет диаграмму Google Sheets в виде Image на страницу. |
insertSheetsChartAsImage(sourceChart, left, top, width, height) | Image | Вставляет диаграмму Google Sheets в виде Image на страницу с указанным положением и размером. |
insertTable(numRows, numColumns) | Table | Вставляет таблицу на страницу. |
insertTable(numRows, numColumns, left, top, width, height) | Table | Вставляет таблицу на страницу с указанным положением и размером. |
insertTable(table) | Table | Вставляет копию предоставленной Table на страницу. |
insertTextBox(text) | Shape | Вставляет Shape текстового поля, содержащую предоставленную строку, на страницу. |
insertTextBox(text, left, top, width, height) | Shape | Вставляет Shape текстового поля, содержащую предоставленную строку, на страницу. |
insertVideo(videoUrl) | Video | Вставляет видео в верхний левый угол страницы с размером по умолчанию. |
insertVideo(videoUrl, left, top, width, height) | Video | Вставляет видео на страницу с указанным положением и размером. |
insertVideo(video) | Video | Вставляет копию предоставленного Video на страницу. |
insertWordArt(wordArt) | WordArt | Вставляет копию предоставленного объекта WordArt на страницу. |
remove() | void | Удаляет страницу. |
replaceAllText(findText, replaceText) | Integer | Заменяет все вхождения текста, совпадающего с поисковым текстом, на замещающий текст. |
replaceAllText(findText, replaceText, matchCase) | Integer | Заменяет все вхождения текста, совпадающего с поисковым текстом, на замещающий текст. |
selectAsCurrentPage() | void | Выбирает Page в активной презентации в качестве current page selection и удаляет любой предыдущий выбор. |
Line
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
alignOnPage(alignmentPosition) | Line | Выравнивает элемент по указанной позиции выравнивания на странице. |
bringForward() | Line | Перемещает элемент страницы вперед на один элемент. |
bringToFront() | Line | Выводит элемент страницы на передний план страницы. |
duplicate() | PageElement | Дублирует элемент страницы. |
getConnectionSites() | ConnectionSite[] | Возвращает список ConnectionSite в элементе страницы или пустой список, если элемент страницы не имеет сайтов подключения. |
getDashStyle() | DashStyle | Получает DashStyle строки. |
getDescription() | String | Возвращает описание альтернативного текста элемента страницы. |
getEnd() | Point | Возвращает конечную точку линии, измеренную от левого верхнего угла страницы. |
getEndArrow() | ArrowStyle | Получает ArrowStyle стрелки в конце строки. |
getEndConnection() | ConnectionSite | Возвращает соединение в конце строки или null , если соединения нет. |
getHeight() | Number | Получает высоту элемента в пунктах, которая является высотой ограничивающей рамки элемента, когда элемент не имеет поворота. |
getInherentHeight() | Number | Возвращает внутреннюю высоту элемента в пунктах. |
getInherentWidth() | Number | Возвращает внутреннюю ширину элемента в пунктах. |
getLeft() | Number | Возвращает горизонтальное положение элемента в точках, измеренное от левого верхнего угла страницы, когда элемент не имеет поворота. |
getLineCategory() | LineCategory | Получает LineCategory линии. |
getLineFill() | LineFill | Получает LineFill строки. |
getLineType() | LineType | Получает LineType линии. |
getLink() | Link | Возвращает Link или null если ссылки нет. |
getObjectId() | String | Возвращает уникальный идентификатор для этого объекта. |
getPageElementType() | PageElementType | Возвращает тип элемента страницы, представленный в виде перечисления PageElementType . |
getParentGroup() | Group | Возвращает группу, к которой принадлежит этот элемент страницы, или null если элемент не находится в группе. |
getParentPage() | Page | Возвращает страницу, на которой находится этот элемент страницы. |
getRotation() | Number | Возвращает угол поворота элемента по часовой стрелке вокруг его центра в градусах, где ноль градусов означает отсутствие вращения. |
getStart() | Point | Возвращает начальную точку линии, измеренную от левого верхнего угла страницы. |
getStartArrow() | ArrowStyle | Получает ArrowStyle стрелки в начале строки. |
getStartConnection() | ConnectionSite | Возвращает соединение в начале строки или null , если соединения нет. |
getTitle() | String | Возвращает заголовок альтернативного текста элемента страницы. |
getTop() | Number | Получает положение элемента по вертикали в точках, измеренное от левого верхнего угла страницы, когда элемент не имеет поворота. |
getTransform() | AffineTransform | Возвращает преобразование элемента страницы. |
getWeight() | Number | Возвращает толщину линии в пунктах. |
getWidth() | Number | Возвращает ширину элемента в пунктах, которая является шириной ограничивающей рамки элемента, когда элемент не имеет поворота. |
isConnector() | Boolean | Возвращает true если линия является соединителем, или false , если нет. |
preconcatenateTransform(transform) | Line | Предварительно объединяет предоставленное преобразование с существующим преобразованием элемента страницы. |
remove() | void | Удаляет элемент страницы. |
removeLink() | void | Удаляет Link . |
reroute() | Line | Перенаправляет начало и конец линии к двум ближайшим местам соединения на связанных элементах страницы. |
scaleHeight(ratio) | Line | Масштабирует высоту элемента в указанном соотношении. |
scaleWidth(ratio) | Line | Масштабирует ширину элемента в указанном соотношении. |
select() | void | Выбирает только PageElement в активной презентации и удаляет любой предыдущий выбор. |
select(replace) | void | Выбирает PageElement в активной презентации. |
sendBackward() | Line | Отправляет элемент страницы назад на один элемент. |
sendToBack() | Line | Отправляет элемент страницы в конец страницы. |
setDashStyle(style) | Line | Устанавливает DashStyle линии. |
setDescription(description) | Line | Устанавливает описание замещающего текста элемента страницы. |
setEnd(left, top) | Line | Устанавливает положение конечной точки линии. |
setEnd(point) | Line | Устанавливает положение конечной точки линии. |
setEndArrow(style) | Line | Задает ArrowStyle стрелки в конце строки. |
setEndConnection(connectionSite) | Line | Устанавливает соединение в конце линии. |
setHeight(height) | Line | Устанавливает высоту элемента в пунктах, которая является высотой ограничивающей рамки элемента, когда элемент не имеет поворота. |
setLeft(left) | Line | Устанавливает горизонтальное положение элемента в пунктах, измеряемое от верхнего левого угла страницы, когда элемент не имеет поворота. |
setLineCategory(lineCategory) | Line | Устанавливает LineCategory линии. |
setLinkSlide(slideIndex) | Link | Устанавливает Link на данный Slide , используя отсчитываемый от нуля индекс слайда. |
setLinkSlide(slide) | Link | Устанавливает Link на данный Slide , ссылка устанавливается по заданному идентификатору слайда. |
setLinkSlide(slidePosition) | Link | Устанавливает Link на данный Slide , используя относительное положение слайда. |
setLinkUrl(url) | Link | Устанавливает Link на заданную непустую строку URL. |
setRotation(angle) | Line | Задает угол поворота элемента по часовой стрелке вокруг его центра в градусах. |
setStart(left, top) | Line | Устанавливает положение начальной точки линии. |
setStart(point) | Line | Устанавливает положение начальной точки линии. |
setStartArrow(style) | Line | Задает ArrowStyle стрелки в начале строки. |
setStartConnection(connectionSite) | Line | Устанавливает соединение в начале строки. |
setTitle(title) | Line | Устанавливает заголовок альтернативного текста элемента страницы. |
setTop(top) | Line | Задает положение элемента по вертикали в пунктах, измеряемое от левого верхнего угла страницы, когда элемент не имеет поворота. |
setTransform(transform) | Line | Задает преобразование элемента страницы с предоставленным преобразованием. |
setWeight(points) | Line | Устанавливает толщину линии в пунктах. |
setWidth(width) | Line | Устанавливает ширину элемента в пунктах, которая является шириной ограничивающей рамки элемента, когда элемент не имеет поворота. |
LineCategory
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
UNSUPPORTED | Enum | Категория линии, которая не поддерживается. |
STRAIGHT | Enum | Прямые разъемы, включая прямой разъем 1. |
BENT | Enum | Согнутые разъемы, в том числе изогнутые разъемы со 2 по 5. |
CURVED | Enum | Изогнутые соединители, в том числе изогнутые соединители со 2 по 5. |
LineFill
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
getFillType() | LineFillType | Получает тип заливки строки. |
getSolidFill() | SolidFill | Получает сплошную заливку линии или null , если тип заливки не LineFillType.SOLID . |
setSolidFill(color) | void | Устанавливает сплошную заливку на заданный Color . |
setSolidFill(color, alpha) | void | Устанавливает для сплошной заливки заданные значения альфы и Color . |
setSolidFill(red, green, blue) | void | Устанавливает сплошную заливку на заданные значения RGB. |
setSolidFill(red, green, blue, alpha) | void | Устанавливает сплошную заливку на заданные значения альфа-канала и RGB. |
setSolidFill(hexString) | void | Устанавливает сплошную заливку на заданную шестнадцатеричную цветовую строку. |
setSolidFill(hexString, alpha) | void | Устанавливает сплошную заливку для заданной альфа- и шестнадцатеричной цветовой строки. |
setSolidFill(color) | void | Устанавливает сплошную заливку на заданный ThemeColorType . |
setSolidFill(color, alpha) | void | Устанавливает сплошную заливку на заданный альфа-канал и ThemeColorType . |
LineFillType
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
UNSUPPORTED | Enum | Тип заполнения строки, который не поддерживается. |
NONE | Enum | Нет заливки, поэтому линия или контур прозрачны. |
SOLID | Enum | Заливка сплошным цветом. |
LineType
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
UNSUPPORTED | Enum | Тип линии, который не поддерживается. |
STRAIGHT_CONNECTOR_1 | Enum | Соединитель прямой 1 форма. |
BENT_CONNECTOR_2 | Enum | Согнутый разъем 2 форма. |
BENT_CONNECTOR_3 | Enum | Согнутый разъем 3 форма. |
BENT_CONNECTOR_4 | Enum | Согнутый соединитель 4 формы. |
BENT_CONNECTOR_5 | Enum | Согнутый разъем 5 формы. |
CURVED_CONNECTOR_2 | Enum | Изогнутый соединитель 2 формы. |
CURVED_CONNECTOR_3 | Enum | Изогнутый соединитель 3 формы. |
CURVED_CONNECTOR_4 | Enum | Изогнутый соединитель 4 формы. |
CURVED_CONNECTOR_5 | Enum | Изогнутый соединитель 5 форма. |
STRAIGHT_LINE | Enum | Прямая линия. |
Link
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
getLinkType() | LinkType | Возвращает LinkType . |
getLinkedSlide() | Slide | Возвращает связанный Slide для типов ссылок, отличных от URL, если он существует. |
getSlideId() | String | Возвращает идентификатор связанного Slide или null если LinkType не равен LinkType.SLIDE_ID . |
getSlideIndex() | Integer | Возвращает отсчитываемый от нуля индекс связанного Slide или null , если LinkType не равен LinkType.SLIDE_INDEX . |
getSlidePosition() | SlidePosition | Возвращает SlidePosition связанного Slide или null , если LinkType не равен LinkType.SLIDE_POSITION . |
getUrl() | String | Возвращает URL-адрес внешней веб-страницы или null , если LinkType не равен LinkType.URL . |
LinkType
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
UNSUPPORTED | Enum | Неподдерживаемый тип ссылки. |
URL | Enum | Ссылка на внешнюю веб-страницу. |
SLIDE_POSITION | Enum | Ссылка на определенный слайд в этой презентации, указанная по его положению. |
SLIDE_ID | Enum | Ссылка на определенный слайд в этой презентации, адресованная по его идентификатору. |
SLIDE_INDEX | Enum | Ссылка на определенный слайд в этой презентации, адресованная индексом, начинающимся с нуля. |
List
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
getListId() | String | Возвращает идентификатор списка. |
getListParagraphs() | Paragraph[] | Возвращает все Paragraphs в списке. |
ListPreset
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
DISC_CIRCLE_SQUARE | Enum | Список с глифами DISC, CIRCLE и SQUARE для первых 3 уровней вложенности списка. |
DIAMONDX_ARROW3D_SQUARE | Enum | Список с глифами `DIAMONDX`, `ARROW3D` и `SQUARE` для первых 3 уровней вложенности списка. |
CHECKBOX | Enum | Список с символами CHECKBOX для всех уровней вложенности списка. |
ARROW_DIAMOND_DISC | Enum | Список с глифами «СТРЕЛКА», «АЛМАЗ» и «ДИСК» для первых 3 уровней вложенности списка. |
STAR_CIRCLE_SQUARE | Enum | Список с глифами «ЗВЕЗДА», «КРУГ» и «КВАДРАТ» для первых 3 уровней вложенности списка. |
ARROW3D_CIRCLE_SQUARE | Enum | Список с глифами `ARROW3D`, `CIRCLE` и `SQUARE` для первых 3 уровней вложенности списка. |
LEFTTRIANGLE_DIAMOND_DISC | Enum | Список с глифами `LEFTTRANGLE`, `DIAMOND` и `DISC` для первых 3 уровней вложенности списка. |
DIAMONDX_HOLLOWDIAMOND_SQUARE | Enum | Список с глифами `DIAMONDX`, `HOLLOWDIAMOND` и `SQUARE` для первых 3 уровней вложенности списка. |
DIAMOND_CIRCLE_SQUARE | Enum | Список с глифами «АЛМАЗ», «КРУГ» и «КВАДРАТ» для первых 3 уровней вложенности списка. |
DIGIT_ALPHA_ROMAN | Enum | Список с глифами `DIGIT`, `ALPHA` и `ROMAN` для первых 3 уровней вложенности списка, за которыми следуют точки. |
DIGIT_ALPHA_ROMAN_PARENS | Enum | Список с символами `DIGIT`, `ALPHA` и `ROMAN` для первых 3 уровней вложенности списка, за которыми следуют круглые скобки. |
DIGIT_NESTED | Enum | Список с глифами `DIGIT`, разделенными точками, где каждый уровень вложенности использует глиф предыдущего уровня в качестве префикса. |
UPPERALPHA_ALPHA_ROMAN | Enum | Список с глифами `UPPERALPHA`, `ALPHA` и `ROMAN` для первых 3 уровней вложенности списка, за которыми следуют точки. |
UPPERROMAN_UPPERALPHA_DIGIT | Enum | Список с глифами `UPPERROMAN`, `UPPERALPHA` и `DIGIT` для первых 3 уровней вложенности списка, за которыми следуют точки. |
ZERODIGIT_ALPHA_ROMAN | Enum | Список с глифами `ZERODIGIT`, `ALPHA` и `ROMAN` для первых 3 уровней вложенности списка, за которыми следуют точки. |
ListStyle
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
applyListPreset(listPreset) | ListStyle | Применяет указанный ListPreset ко всем абзацам, которые перекрываются с текстом. |
getGlyph() | String | Возвращает визуализированный глиф для текста. |
getList() | List | Возвращает List , в котором находится текст, или null если ни один из текстов не находится в списке, или часть текста находится в списке, или текст находится в нескольких списках. |
getNestingLevel() | Integer | Возвращает уровень вложенности текста, отсчитываемый от 0. |
isInList() | Boolean | Возвращает true если текст находится только в одном списке, false , если ни один из текстов не находится в списке, и null , если только часть текста находится в списке или если текст находится в нескольких списках. |
removeFromList() | ListStyle | Удаляет абзацы, которые перекрываются с текстом, из любых списков. |
Master
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
getBackground() | PageBackground | Получает фон страницы. |
getColorScheme() | ColorScheme | Получает ColorScheme , связанную со страницей. |
getGroups() | Group[] | Возвращает список объектов Group на странице. |
getImages() | Image[] | Возвращает список объектов Image на странице. |
getLayouts() | Layout[] | Получает макеты этого мастера. |
getLines() | Line[] | Возвращает список объектов Line на странице. |
getObjectId() | String | Получает уникальный идентификатор страницы. |
getPageElementById(id) | PageElement | Возвращает PageElement на странице с заданным идентификатором или null , если таковой не существует. |
getPageElements() | PageElement[] | Возвращает список объектов PageElement , отображаемых на странице. |
getPageType() | PageType | Получает тип страницы. |
getPlaceholder(placeholderType) | PageElement | Возвращает объект-заполнитель PageElement для указанного PlaceholderType или null , если соответствующий заполнитель отсутствует. |
getPlaceholder(placeholderType, placeholderIndex) | PageElement | Возвращает объект PageElement заполнителя для указанного PlaceholderType и индекса заполнителя или null , если заполнитель отсутствует. |
getPlaceholders() | PageElement[] | Возвращает список объектов-заполнителей PageElement на странице. |
getShapes() | Shape[] | Возвращает список объектов Shape на странице. |
getSheetsCharts() | SheetsChart[] | Возвращает список объектов SheetsChart на странице. |
getTables() | Table[] | Возвращает список объектов Table на странице. |
getVideos() | Video[] | Возвращает список объектов Video на странице. |
getWordArts() | WordArt[] | Возвращает список объектов WordArt на странице. |
group(pageElements) | Group | Группирует все указанные элементы страницы. |
insertGroup(group) | Group | Вставляет копию предоставленной Group на страницу. |
insertImage(blobSource) | Image | Вставляет изображение в верхнем левом углу страницы с размером по умолчанию из указанного большого двоичного объекта изображения. |
insertImage(blobSource, left, top, width, height) | Image | Вставляет изображение на страницу с указанным положением и размером из указанного большого двоичного объекта изображения. |
insertImage(image) | Image | Вставляет копию предоставленного Image на страницу. |
insertImage(imageUrl) | Image | Вставляет изображение в верхний левый угол страницы с размером по умолчанию из указанного URL-адреса. |
insertImage(imageUrl, left, top, width, height) | Image | Вставляет изображение на страницу с указанным положением и размером из предоставленного URL-адреса. |
insertLine(line) | Line | Вставляет копию предоставленной Line на страницу. |
insertLine(lineCategory, startConnectionSite, endConnectionSite) | Line | Вставляет на страницу линию, соединяющую два connection sites . |
insertLine(lineCategory, startLeft, startTop, endLeft, endTop) | Line | Вставляет строку на страницу. |
insertPageElement(pageElement) | PageElement | Вставляет копию предоставленного PageElement на страницу. |
insertShape(shape) | Shape | Вставляет копию предоставленной Shape на страницу. |
insertShape(shapeType) | Shape | Вставляет фигуру на страницу. |
insertShape(shapeType, left, top, width, height) | Shape | Вставляет фигуру на страницу. |
insertSheetsChart(sourceChart) | SheetsChart | Вставляет диаграмму Google Sheets на страницу. |
insertSheetsChart(sourceChart, left, top, width, height) | SheetsChart | Вставляет диаграмму Google Sheets на страницу с указанным положением и размером. |
insertSheetsChart(sheetsChart) | SheetsChart | Вставляет копию предоставленного SheetsChart на страницу. |
insertSheetsChartAsImage(sourceChart) | Image | Вставляет диаграмму Google Sheets в виде Image на страницу. |
insertSheetsChartAsImage(sourceChart, left, top, width, height) | Image | Вставляет диаграмму Google Sheets в виде Image на страницу с указанным положением и размером. |
insertTable(numRows, numColumns) | Table | Вставляет таблицу на страницу. |
insertTable(numRows, numColumns, left, top, width, height) | Table | Вставляет таблицу на страницу с указанным положением и размером. |
insertTable(table) | Table | Вставляет копию предоставленной Table на страницу. |
insertTextBox(text) | Shape | Вставляет Shape текстового поля, содержащую предоставленную строку, на страницу. |
insertTextBox(text, left, top, width, height) | Shape | Вставляет Shape текстового поля, содержащую предоставленную строку, на страницу. |
insertVideo(videoUrl) | Video | Вставляет видео в верхний левый угол страницы с размером по умолчанию. |
insertVideo(videoUrl, left, top, width, height) | Video | Вставляет видео на страницу с указанным положением и размером. |
insertVideo(video) | Video | Вставляет копию предоставленного Video на страницу. |
insertWordArt(wordArt) | WordArt | Вставляет копию предоставленного объекта WordArt на страницу. |
remove() | void | Удаляет страницу. |
replaceAllText(findText, replaceText) | Integer | Заменяет все вхождения текста, совпадающего с поисковым текстом, на замещающий текст. |
replaceAllText(findText, replaceText, matchCase) | Integer | Заменяет все вхождения текста, совпадающего с поисковым текстом, на замещающий текст. |
selectAsCurrentPage() | void | Выбирает Page в активной презентации в качестве current page selection и удаляет любой предыдущий выбор. |
NotesMaster
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
getGroups() | Group[] | Возвращает список объектов Group на странице. |
getImages() | Image[] | Возвращает список объектов Image на странице. |
getLines() | Line[] | Возвращает список объектов Line на странице. |
getObjectId() | String | Получает уникальный идентификатор страницы. |
getPageElementById(id) | PageElement | Возвращает PageElement на странице с заданным идентификатором или null , если таковой не существует. |
getPageElements() | PageElement[] | Возвращает список объектов PageElement , отображаемых на странице. |
getPlaceholder(placeholderType) | PageElement | Возвращает объект-заполнитель PageElement для указанного PlaceholderType или null , если соответствующий заполнитель отсутствует. |
getPlaceholder(placeholderType, placeholderIndex) | PageElement | Возвращает объект PageElement заполнителя для указанного PlaceholderType и индекса заполнителя или null , если заполнитель отсутствует. |
getPlaceholders() | PageElement[] | Возвращает список объектов-заполнителей PageElement на странице. |
getShapes() | Shape[] | Возвращает список объектов Shape на странице. |
getSheetsCharts() | SheetsChart[] | Возвращает список объектов SheetsChart на странице. |
getTables() | Table[] | Возвращает список объектов Table на странице. |
getVideos() | Video[] | Возвращает список объектов Video на странице. |
getWordArts() | WordArt[] | Возвращает список объектов WordArt на странице. |
NotesPage
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
getGroups() | Group[] | Возвращает список объектов Group на странице. |
getImages() | Image[] | Возвращает список объектов Image на странице. |
getLines() | Line[] | Возвращает список объектов Line на странице. |
getObjectId() | String | Получает уникальный идентификатор страницы. |
getPageElementById(id) | PageElement | Возвращает PageElement на странице с заданным идентификатором или null , если таковой не существует. |
getPageElements() | PageElement[] | Возвращает список объектов PageElement , отображаемых на странице. |
getPlaceholder(placeholderType) | PageElement | Возвращает объект-заполнитель PageElement для указанного PlaceholderType или null , если соответствующий заполнитель отсутствует. |
getPlaceholder(placeholderType, placeholderIndex) | PageElement | Возвращает объект PageElement заполнителя для указанного PlaceholderType и индекса заполнителя или null , если заполнитель отсутствует. |
getPlaceholders() | PageElement[] | Возвращает список объектов-заполнителей PageElement на странице. |
getShapes() | Shape[] | Возвращает список объектов Shape на странице. |
getSheetsCharts() | SheetsChart[] | Возвращает список объектов SheetsChart на странице. |
getSpeakerNotesShape() | Shape | Получает фигуру, содержащую заметки докладчика на странице. |
getTables() | Table[] | Возвращает список объектов Table на странице. |
getVideos() | Video[] | Возвращает список объектов Video на странице. |
getWordArts() | WordArt[] | Возвращает список объектов WordArt на странице. |
replaceAllText(findText, replaceText) | Integer | Заменяет все вхождения текста, совпадающего с поисковым текстом, на замещающий текст. |
replaceAllText(findText, replaceText, matchCase) | Integer | Заменяет все вхождения текста, совпадающего с поисковым текстом, на замещающий текст. |
Page
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
asLayout() | Layout | Возвращает страницу в виде макета. |
asMaster() | Master | Возвращает страницу как мастер. |
asSlide() | Slide | Возвращает страницу в виде слайда. |
getBackground() | PageBackground | Получает фон страницы. |
getColorScheme() | ColorScheme | Получает ColorScheme , связанную со страницей. |
getGroups() | Group[] | Возвращает список объектов Group на странице. |
getImages() | Image[] | Возвращает список объектов Image на странице. |
getLines() | Line[] | Возвращает список объектов Line на странице. |
getObjectId() | String | Получает уникальный идентификатор страницы. |
getPageElementById(id) | PageElement | Возвращает PageElement на странице с заданным идентификатором или null , если таковой не существует. |
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. |
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. |
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. |
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() | |