Class Group

Grupo

Uma coleção de PageElements unida como uma única unidade.

Métodos

MétodoTipo de retornoBreve descrição
alignOnPage(alignmentPosition)GroupAlinha o elemento à posição de alinhamento especificada na página.
bringForward()GroupTraz o elemento de página para a frente na página por um elemento.
bringToFront()GroupTraz o elemento de página para a frente da página.
duplicate()PageElementDuplica o elemento de página.
getChildren()PageElement[]Recebe o conjunto de elementos de página no grupo.
getConnectionSites()ConnectionSite[]Retorna a lista de ConnectionSites no elemento de página ou uma lista vazia se o elemento da página não tiver sites de conexão.
getDescription()StringRetorna a descrição do texto alternativo do elemento de página.
getHeight()NumberRecebe a altura do elemento em pontos, que é a altura da caixa delimitadora do elemento quando ele não tem rotação.
getInherentHeight()NumberRetorna a altura inerente do elemento em pontos.
getInherentWidth()NumberRetorna a largura inerente do elemento em pontos.
getLeft()NumberRetorna a posição horizontal do elemento em pontos, medida a partir do canto superior esquerdo da página, quando o elemento não tem rotação.
getObjectId()StringRetorna o ID exclusivo deste objeto.
getPageElementType()PageElementTypeRetorna o tipo do elemento de página, representado como um tipo enumerado PageElementType.
getParentGroup()GroupRetorna o grupo a que o elemento de página pertence ou null se o elemento não estiver em um grupo.
getParentPage()PageRetorna a página em que o elemento está.
getRotation()NumberRetorna o ângulo de rotação no sentido horário em torno do centro do elemento em graus, em que zero grau significa que não há rotação.
getTitle()StringRetorna o título do texto alternativo do elemento de página.
getTop()NumberRecebe a posição vertical do elemento em pontos, medida a partir do canto superior esquerdo da página quando o elemento não tem rotação.
getTransform()AffineTransformRecebe a transformação do elemento de página.
getWidth()NumberRetorna a largura do elemento em pontos, que é a largura da caixa delimitadora do elemento quando o elemento não tem rotação.
preconcatenateTransform(transform)GroupPré-concatena a transformação fornecida à transformação existente do elemento de página.
remove()voidRemove o elemento de página.
scaleHeight(ratio)GroupDimensiona a altura do elemento pela proporção especificada.
scaleWidth(ratio)GroupDimensiona a largura do elemento pela proporção especificada.
select()voidSeleciona apenas o PageElement na apresentação ativa e remove qualquer seleção anterior.
select(replace)voidSeleciona o PageElement na apresentação ativa.
sendBackward()GroupEnvia o elemento de página para trás na página por um elemento.
sendToBack()GroupEnvia o elemento da página para a parte de trás da página.
setDescription(description)GroupDefine a descrição do texto alternativo do elemento de página.
setHeight(height)GroupDefine a altura do elemento em pontos, que é a altura da caixa delimitadora do elemento quando ele não tem rotação.
setLeft(left)GroupDefine a posição horizontal do elemento em pontos, medida no canto superior esquerdo da página quando o elemento não tem rotação.
setRotation(angle)GroupDefine o ângulo de rotação do elemento no sentido horário em torno do centro, em graus.
setTitle(title)GroupDefine o título do texto alternativo do elemento da página.
setTop(top)GroupDefine a posição vertical do elemento em pontos, medida a partir do canto superior esquerdo da página quando o elemento não tem rotação.
setTransform(transform)GroupDefine a transformação do elemento de página com a transformação fornecida.
setWidth(width)GroupDefine a largura do elemento em pontos, que é a largura da caixa delimitadora do elemento quando o elemento não tem rotação.
ungroup()voidDesagrupa os elementos do grupo.

Documentação detalhada

alignOnPage(alignmentPosition)

Alinha o elemento à posição de alinhamento especificada na página.

Parâmetros

NomeTipoDescrição
alignmentPositionAlignmentPositionA posição à qual esse elemento de página será alinhado.

Devolução

Group: elemento de página para encadeamento.


bringForward()

Traz o elemento de página para a frente na página por um elemento.

O elemento de página não pode estar em um grupo.

Devolução

Group: elemento de página para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

bringToFront()

Traz o elemento de página para a frente da página.

O elemento de página não pode estar em um grupo.

Devolução

Group: elemento de página para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

duplicate()

Duplica o elemento de página.

O elemento de página duplicada é colocado na mesma página, na mesma posição que o original.

Devolução

PageElement: a nova cópia deste elemento de página.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getChildren()

Recebe o conjunto de elementos de página no grupo. O tamanho mínimo de um grupo é 2.

Devolução

PageElement[]: a lista de elementos de página nesse grupo.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getConnectionSites()

Retorna a lista de ConnectionSites no elemento de página ou uma lista vazia se o elemento da página não tiver sites de conexão.

Devolução

ConnectionSite[]: a lista de sites de conexão, que pode ficar vazia se esse elemento não tiver sites de conexão.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getDescription()

Retorna a descrição do texto alternativo do elemento de página. A descrição é combinada com o título para mostrar e ler o texto alternativo.

Devolução

String: a descrição do texto alternativo do elemento da página.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getHeight()

Recebe a altura do elemento em pontos, que é a altura da caixa delimitadora do elemento quando ele não tem rotação.

Esse método não é compatível com todos os elementos da página. Para saber quais elementos da página não são compatíveis com esse método, consulte as limitações de dimensionamento e posicionamento.

Devolução

Number: a altura inerente do elemento de página em pontos, ou null se o elemento de página não tiver uma altura.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getInherentHeight()

Retorna a altura inerente do elemento em pontos.

A transformação do elemento de página é relativa ao tamanho inerente dele. Use o tamanho inerente em conjunto com a transformação do elemento para determinar a aparência final dele.

Devolução

Number: a altura inerente do elemento de página em pontos, ou null se o elemento de página não tiver uma altura.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getInherentWidth()

Retorna a largura inerente do elemento em pontos.

A transformação do elemento de página é relativa ao tamanho inerente dele. Use o tamanho inerente em conjunto com a transformação do elemento para determinar a aparência final dele.

Devolução

Number: a largura inerente do elemento de página em pontos, ou null se o elemento de página não tem uma largura.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getLeft()

Retorna a posição horizontal do elemento em pontos, medida a partir do canto superior esquerdo da página, quando o elemento não tem rotação.

Devolução

Number: é a posição horizontal do elemento em pontos, a partir do canto superior esquerdo da página.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getObjectId()

Retorna o ID exclusivo deste objeto. Os IDs de objeto usados por páginas e elementos de página compartilham o mesmo namespace.

Devolução

String: o ID exclusivo do objeto.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getPageElementType()

Retorna o tipo do elemento de página, representado como um tipo enumerado PageElementType.

Devolução

PageElementType: o tipo do elemento de página.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getParentGroup()

Retorna o grupo a que o elemento de página pertence ou null se o elemento não estiver em um grupo.

Devolução

Group: o grupo a que o elemento de página pertence ou null.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getParentPage()

Retorna a página em que o elemento está.

Devolução

Page: a página em que o elemento reside.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getRotation()

Retorna o ângulo de rotação no sentido horário em torno do centro do elemento em graus, em que zero grau significa que não há rotação.

Devolução

Number: o ângulo de rotação em graus entre 0 (inclusivo) e 360 (exclusivo).

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getTitle()

Retorna o título do texto alternativo do elemento de página. O título é combinado com a descrição para mostrar e ler o texto alternativo.

Devolução

String: o título do texto alternativo do elemento da página.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getTop()

Recebe a posição vertical do elemento em pontos, medida a partir do canto superior esquerdo da página quando o elemento não tem rotação.

Devolução

Number: é a posição vertical do elemento em pontos, a partir do canto superior esquerdo da página.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getTransform()

Recebe a transformação do elemento de página.

A transformação inicial de um Group recém-criado é sempre a transformação de identidade: parâmetros de escala 1,0 e parâmetros de distorção e conversão 0,0.

Devolução

AffineTransform: a transformação do elemento de página.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getWidth()

Retorna a largura do elemento em pontos, que é a largura da caixa delimitadora do elemento quando o elemento não tem rotação.

Esse método não é compatível com todos os elementos da página. Para saber quais elementos da página não são compatíveis com esse método, consulte as limitações de dimensionamento e posicionamento.

Devolução

Number: a largura inerente do elemento de página em pontos, ou null se o elemento de página não tem uma largura.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

preconcatenateTransform(transform)

Pré-concatena a transformação fornecida à transformação existente do elemento de página.

newTransform = argument * existingTransform

Por exemplo, para mover os elementos de uma página 36 pontos para a esquerda:

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

Também é possível substituir a transformação do elemento de página por setTransform(transform).

Parâmetros

NomeTipoDescrição
transformAffineTransformA transformação a ser pré-concatenizada na transformação desse elemento de página.

Devolução

Group: elemento de página para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

remove()

Remove o elemento de página.

Se, após uma operação de remoção, uma Group contiver apenas um ou nenhum elemento de página, o próprio grupo também será removido.

Se um marcador PageElement for removido em um mestre ou layout, todos os marcadores herdados vazios também serão removidos.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

scaleHeight(ratio)

Dimensiona a altura do elemento pela proporção especificada. A altura do elemento é a altura da caixa delimitadora quando o elemento não tem rotação.

Esse método não é compatível com todos os elementos da página. Para saber quais elementos da página não são compatíveis com esse método, consulte as limitações de dimensionamento e posicionamento.

Parâmetros

NomeTipoDescrição
ratioNumberA proporção pela qual a altura deste elemento da página será dimensionada.

Devolução

Group: elemento de página para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

scaleWidth(ratio)

Dimensiona a largura do elemento pela proporção especificada. A largura do elemento é a largura da caixa delimitadora quando o elemento não tem rotação.

Esse método não é compatível com todos os elementos da página. Para saber quais elementos da página não são compatíveis com esse método, consulte as limitações de dimensionamento e posicionamento.

Parâmetros

NomeTipoDescrição
ratioNumberA proporção de acordo com o dimensionamento da largura deste elemento de página.

Devolução

Group: elemento de página para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

select()

Seleciona apenas o PageElement na apresentação ativa e remove qualquer seleção anterior. Isso é o mesmo que chamar select(replace) com true.

Um script só poderá acessar a seleção do usuário que está executando o script e somente se ele estiver vinculado à apresentação.

Isso define o Page pai da PageElement como o current page selection.

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

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

select(replace)

Seleciona o PageElement na apresentação ativa.

Um script só poderá acessar a seleção do usuário que está executando o script e somente se ele estiver vinculado à apresentação.

Transmita true a esse método para selecionar apenas o PageElement e remover qualquer seleção anterior. Isso também define o Page pai do PageElement como o current page selection.

Transmita false para selecionar vários objetos PageElement. Os objetos PageElement precisam estar no mesmo Page.

As seguintes condições precisam ser atendidas ao selecionar um elemento de página usando um parâmetro false:

  1. O Page pai do objeto PageElement precisa ser o current page selection.
  2. Não pode haver vários objetos Page selecionados.

Para garantir que esse seja o caso, a abordagem recomendada é selecionar a Page mãe primeiro usando Page.selectAsCurrentPage() e, em seguida, selecionar os elementos dessa página.

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

Parâmetros

NomeTipoDescrição
replaceBooleanSe for true, a seleção substituirá qualquer seleção anterior. Caso contrário, a seleção será adicionada a qualquer seleção anterior.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

sendBackward()

Envia o elemento de página para trás na página por um elemento.

O elemento de página não pode estar em um grupo.

Devolução

Group: elemento de página para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

sendToBack()

Envia o elemento da página para a parte de trás da página.

O elemento de página não pode estar em um grupo.

Devolução

Group: elemento de página para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setDescription(description)

Define a descrição do texto alternativo do elemento de página.

O método não tem suporte para elementos Group.

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

Parâmetros

NomeTipoDescrição
descriptionStringA string para definir a descrição do texto alternativo.

Devolução

Group: este elemento de página.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setHeight(height)

Define a altura do elemento em pontos, que é a altura da caixa delimitadora do elemento quando ele não tem rotação.

Esse método não é compatível com todos os elementos da página. Para saber quais elementos da página não são compatíveis com esse método, consulte as limitações de dimensionamento e posicionamento.

Parâmetros

NomeTipoDescrição
heightNumberA nova altura desse elemento de página a ser definida, em pontos.

Devolução

Group: elemento de página para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setLeft(left)

Define a posição horizontal do elemento em pontos, medida no canto superior esquerdo da página quando o elemento não tem rotação.

Parâmetros

NomeTipoDescrição
leftNumberA nova posição horizontal a ser definida, em pontos.

Devolução

Group: elemento de página para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setRotation(angle)

Define o ângulo de rotação do elemento no sentido horário em torno do centro, em graus.

Esse método não é compatível com todos os elementos da página. Para saber quais elementos da página não são compatíveis com esse método, consulte as limitações de dimensionamento e posicionamento.

Parâmetros

NomeTipoDescrição
angleNumberO novo ângulo de rotação no sentido horário a ser definido, em graus.

Devolução

Group: elemento de página para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setTitle(title)

Define o título do texto alternativo do elemento da página.

O método não tem suporte para elementos Group.

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

Parâmetros

NomeTipoDescrição
titleStringA string para definir o título do texto alternativo.

Devolução

Group: este elemento de página.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setTop(top)

Define a posição vertical do elemento em pontos, medida a partir do canto superior esquerdo da página quando o elemento não tem rotação.

Parâmetros

NomeTipoDescrição
topNumberA nova posição vertical a ser definida, em pontos.

Devolução

Group: elemento de página para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setTransform(transform)

Define a transformação do elemento de página com a transformação fornecida.

Atualizar a transformação de um grupo altera a transformação absoluta dos elementos da página desse grupo, o que pode alterar a aparência visual deles.

Atualizar a transformação de um elemento de página que está em um grupo altera somente a transformação desse elemento de página. Isso não afeta as transformações do grupo ou de outros elementos de página do grupo.

Para detalhes sobre como as transformações afetam a aparência visual dos elementos da página, consulte getTransform().

Parâmetros

NomeTipoDescrição
transformAffineTransformA transformação definida para esse elemento de página.

Devolução

Group: este elemento, para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

setWidth(width)

Define a largura do elemento em pontos, que é a largura da caixa delimitadora do elemento quando o elemento não tem rotação.

Esse método não é compatível com todos os elementos da página. Para saber quais elementos da página não são compatíveis com esse método, consulte as limitações de dimensionamento e posicionamento.

Parâmetros

NomeTipoDescrição
widthNumberA nova largura desse elemento de página a ser definida, em pontos.

Devolução

Group: elemento de página para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

ungroup()

Desagrupa os elementos do grupo.

O grupo será removido.

Grupos dentro de outros grupos não podem ser desagrupados.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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