Class Group

Group

Uma coleção de PageElements unidas 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()GroupAvança o elemento da página em um elemento.
bringToFront()GroupTraz o elemento da página para a frente.
duplicate()PageElementDuplica o elemento da página.
getChildren()PageElement[]Recebe a coleção de elementos da página no grupo.
getConnectionSites()ConnectionSite[]Retorna a lista de ConnectionSites no elemento da página ou uma lista vazia se o elemento não tiver sites de conexão.
getDescription()StringRetorna a descrição do texto alternativo do elemento da página.
getHeight()Number|nullRecebe a altura do elemento em pontos, que é a altura da caixa delimitadora do elemento quando ele não tem rotação.
getInherentHeight()Number|nullRetorna a altura inerente do elemento em pontos.
getInherentWidth()Number|nullRetorna a largura inerente do elemento em pontos.
getLeft()NumberRetorna a posição horizontal do elemento em pontos, medida do canto superior esquerdo da página quando o elemento não está girado.
getObjectId()StringRetorna o ID exclusivo deste objeto.
getPageElementType()PageElementTypeRetorna o tipo do elemento da página, representado como uma enumeração PageElementType.
getParentGroup()Group|nullRetorna o grupo a que este elemento de página pertence ou null se o elemento não estiver em um grupo.
getParentPage()PageRetorna a página em que este elemento está.
getRotation()NumberRetorna o ângulo de rotação no sentido horário do elemento em torno do centro, em graus. Zero grau significa que não há rotação.
getTitle()StringRetorna o título do texto alternativo do elemento da página.
getTop()NumberRecebe a posição vertical do elemento em pontos, medida do canto superior esquerdo da página quando o elemento não está girado.
getTransform()AffineTransformRecebe a transformação do elemento da página.
getWidth()Number|nullRetorna a largura do elemento em pontos, que é a largura da caixa delimitadora do elemento quando ele não tem rotação.
preconcatenateTransform(transform)GroupPré-concatena a transformação fornecida à transformação atual do elemento da página.
remove()voidRemove o elemento da 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 da página para trás em um elemento.
sendToBack()GroupEnvia o elemento da página para o fundo dela.
setDescription(description)GroupDefine a descrição do texto alternativo do elemento da 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 do canto superior esquerdo da página quando o elemento não tem rotação.
setRotation(angle)GroupDefine o ângulo de rotação no sentido horário do elemento 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 do canto superior esquerdo da página quando o elemento não está girado.
setTransform(transform)GroupDefine a transformação do elemento da 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 ele 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 para alinhar esse elemento da página.

Retornar

Group: este elemento de página, para encadeamento.


bringForward()

Avança o elemento da página em um elemento.

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

Retornar

Group: este elemento de página, para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 da página para a frente.

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

Retornar

Group: este elemento de página, para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 da página.

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

Retornar

PageElement: o novo duplicado desse elemento da página.

Autorização

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

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

getChildren()

Recebe a coleção de elementos da página no grupo. O tamanho mínimo de um grupo é 2.

Retornar

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

Autorização

Os scripts que usam esse método exigem 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 da página ou uma lista vazia se o elemento não tiver sites de conexão.

Retornar

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

Autorização

Os scripts que usam esse método exigem 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 da página. A descrição é combinada com o título para mostrar e ler o texto alternativo.

Retornar

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

Autorização

Os scripts que usam esse método exigem 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.

Retornar

Number|null: 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 exigem 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 da página é relativa ao tamanho inerente dele. Use o tamanho inerente em conjunto com a transformação do elemento para determinar a aparência visual final dele.

Retornar

Number|null: 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 exigem 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 da página é relativa ao tamanho inerente dele. Use o tamanho inerente em conjunto com a transformação do elemento para determinar a aparência visual final dele.

Retornar

Number|null: a largura inerente do elemento da página em pontos ou null se o elemento da página não tiver uma largura.

Autorização

Os scripts que usam esse método exigem 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 do canto superior esquerdo da página quando o elemento não está girado.

Retornar

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

Autorização

Os scripts que usam esse método exigem 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 objetos usados por páginas e elementos de página compartilham o mesmo namespace.

Retornar

String: o ID exclusivo deste objeto.

Autorização

Os scripts que usam esse método exigem 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 da página, representado como uma enumeração PageElementType.

Retornar

PageElementType: o tipo do elemento da página.

Autorização

Os scripts que usam esse método exigem 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 este elemento de página pertence ou null se o elemento não estiver em um grupo.

Retornar

Group|null: o grupo a que esse elemento da página pertence ou null.

Autorização

Os scripts que usam esse método exigem 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 este elemento está.

Retornar

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

Autorização

Os scripts que usam esse método exigem 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 do elemento em torno do centro, em graus. Zero grau significa que não há rotação.

Retornar

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

Autorização

Os scripts que usam esse método exigem 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 da página. O título é combinado com a descrição para mostrar e ler o texto alternativo.

Retornar

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

Autorização

Os scripts que usam esse método exigem 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 do canto superior esquerdo da página quando o elemento não está girado.

Retornar

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

Autorização

Os scripts que usam esse método exigem 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 da 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 cisalhamento e translação 0,0.

Retornar

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

Autorização

Os scripts que usam esse método exigem 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 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.

Retornar

Number|null: a largura inerente do elemento da página em pontos ou null se o elemento da página não tiver uma largura.

Autorização

Os scripts que usam esse método exigem 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 atual do elemento da página.

newTransform = argument * existingTransform;

Por exemplo, para mover um elemento da página 36 pontos para a esquerda:

const element = SlidesApp.getActivePresentation().getSlides()[0].getPageElements()[0];
element.preconcatenateTransform(
    SlidesApp.newAffineTransformBuilder().setTranslateX(-36.0).build(),
);

Você também pode substituir a transformação do elemento da página por setTransform(transform).

Parâmetros

NomeTipoDescrição
transformAffineTransformA transformação a ser pré-concatenada na transformação deste elemento da página.

Retornar

Group: este elemento de página, para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 da página.

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

Se um marcador de posição PageElement for removido de um modelo ou layout, todos os marcadores de posição vazios que herdam dele também serão removidos.

Autorização

Os scripts que usam esse método exigem 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 para dimensionar a altura desse elemento da página.

Retornar

Group: este elemento de página, para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 para dimensionar a largura desse elemento da página.

Retornar

Group: este elemento de página, para encadeamento.

Autorização

Os scripts que usam esse método exigem 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ó pode acessar a seleção do usuário que o está executando e apenas se ele estiver vinculado à apresentação.

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

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

Autorização

Os scripts que usam esse método exigem 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ó pode acessar a seleção do usuário que o está executando e apenas se ele estiver vinculado à apresentação.

Transmita true para 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 da página usando um parâmetro false:

  1. O Page principal 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 preferida é selecionar primeiro o Page pai usando Page.selectAsCurrentPage() e depois selecionar os elementos da página.

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

Parâmetros

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

Autorização

Os scripts que usam esse método exigem 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 da página para trás em um elemento.

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

Retornar

Group: este elemento de página, para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 o fundo dela.

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

Retornar

Group: este elemento de página, para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 da página.

O método não é compatível com elementos Group.

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

Parâmetros

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

Retornar

Group: este elemento da página.

Autorização

Os scripts que usam esse método exigem 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 a ser definida para esse elemento da página, em pontos.

Retornar

Group: este elemento de página, para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 do 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.

Retornar

Group: este elemento de página, para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 no sentido horário do elemento 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.

Retornar

Group: este elemento de página, para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 é compatível com elementos Group.

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

Parâmetros

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

Retornar

Group: este elemento da página.

Autorização

Os scripts que usam esse método exigem 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 do canto superior esquerdo da página quando o elemento não está girado.

Parâmetros

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

Retornar

Group: este elemento de página, para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 da página com a transformação fornecida.

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

Atualizar a transformação de um elemento de página que está em um grupo só muda a transformação desse elemento. Não afeta as transformações do grupo ou de outros elementos de página nele.

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 este elemento da página.

Retornar

Group: este elemento, para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 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
widthNumberA nova largura do elemento da página a ser definida, em pontos.

Retornar

Group: este elemento de página, para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 em si é removido.

Não é possível desagrupar grupos dentro de outros grupos.

Autorização

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

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