Spreadsheet Service

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
Planilha

Esse serviço permite que os scripts criem, acessem e modifiquem arquivos do Planilhas Google. Consulte também o guia para armazenar dados em planilhas.

Às vezes, as operações da planilha são agrupadas para melhorar o desempenho, como ao fazer várias chamadas para um método. Se você quiser garantir que todas as alterações pendentes sejam feitas imediatamente, por exemplo, para mostrar informações aos usuários enquanto um script está em execução, chame SpreadsheetApp.flush().

Classes

NomeBreve descrição
AutoFillSeriesUma enumeração dos tipos de série usados para calcular os valores preenchidos automaticamente.
BandingAcesse e modifique faixas, os padrões de cores aplicados a linhas ou colunas de um intervalo.
BandingThemeUma enumeração de temas de faixas.
BigQueryDataSourceSpecAcesse a especificação atual da fonte de dados do BigQuery.
BigQueryDataSourceSpecBuilderO builder de BigQueryDataSourceSpecBuilder.
BooleanConditionAcesse condições booleanas em ConditionalFormatRules.
BooleanCriteriaUma enumeração que representa os critérios booleanos que podem ser usados no formato condicional ou filtro.
BorderStyleEstilos que podem ser definidos em um intervalo usando Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style).
CellImageRepresenta uma imagem a ser adicionada a uma célula.
CellImageBuilderBuilder para a classe CellImage.
ColorUma representação de uma cor.
ColorBuilderO builder de ColorBuilder.
ConditionalFormatRuleAcessar regras de formatação condicional
ConditionalFormatRuleBuilderBuilder para regras de formatação condicional.
ContainerInfoAcessar a posição do gráfico em uma página
CopyPasteTypeUma enumeração de possíveis tipos de colagem especiais.
DataExecutionErrorCodeUma enumeração dos códigos de erro de execução de dados.
DataExecutionStateUma enumeração dos estados de execução de dados.
DataExecutionStatusO status de execução dos dados.
DataSourceAcesse e modifique a fonte de dados existente.
DataSourceChartAcesse e modifique um gráfico da fonte de dados em uso.
DataSourceColumnAcesse e modifique uma coluna de fonte de dados.
DataSourceFormulaAcesse e modifique fórmulas de fonte de dados existentes.
DataSourceParameterAcesse os parâmetros atuais da fonte de dados.
DataSourceParameterTypeUma enumeração dos tipos de parâmetros da fonte de dados.
DataSourcePivotTableAcessar e modificar a tabela dinâmica de fonte de dados existente
DataSourceRefreshScheduleAcessar e modificar uma programação de atualização
DataSourceRefreshScheduleFrequencyAcesse a programação da atualização, que especifica com que frequência e quando atualizá-la.
DataSourceRefreshScopeUma enumeração dos escopos das atualizações
DataSourceSheetAcesse e modifique a página de fonte de dados existente.
DataSourceSheetFilterAcesse e modifique um filtro da página de fonte de dados.
DataSourceSpecAcesse as configurações gerais de uma especificação de fonte de dados existente.
DataSourceSpecBuilderO builder de DataSourceSpec.
DataSourceTableAcesse e modifique a tabela de fonte de dados existente.
DataSourceTableColumnAcesse e modifique uma coluna existente em uma DataSourceTable.
DataSourceTableFilterAcesse e modifique um filtro da tabela de fonte de dados.
DataSourceTypeUma enumeração dos tipos de fonte de dados.
DataValidationAcessar regras de validação de dados.
DataValidationBuilderBuilder para regras de validação de dados.
DataValidationCriteriaUma enumeração que representa os critérios de validação de dados que podem ser definidos em um intervalo.
DateTimeGroupingRuleAcesse uma regra de agrupamento de data e hora.
DateTimeGroupingRuleTypeOs tipos de regra de agrupamento de data e hora.
DeveloperMetadataAcessar e modificar metadados do desenvolvedor
DeveloperMetadataFinderPesquise os metadados do desenvolvedor em uma planilha.
DeveloperMetadataLocationAcessar informações de local dos metadados do desenvolvedor.
DeveloperMetadataLocationTypeUma enumeração dos tipos de local dos metadados do desenvolvedor.
DeveloperMetadataVisibilityUma enumeração dos tipos de visibilidade dos metadados do desenvolvedor.
DimensionUma enumeração das possíveis rotas que os dados podem armazenar em uma planilha.
DirectionUma enumeração que representa as possíveis rotas que uma pessoa pode mover em uma planilha usando as teclas de seta.
DrawingRepresenta um desenho sobre uma página de uma planilha.
EmbeddedAreaChartBuilderCriador de gráficos de área.
EmbeddedBarChartBuilderCriador de gráficos de barras.
EmbeddedChartRepresenta um gráfico que foi incorporado a uma planilha.
EmbeddedChartBuilderBuilder usado para editar um EmbeddedChart.
EmbeddedColumnChartBuilderCriador de gráficos de colunas.
EmbeddedComboChartBuilderBuilder para gráficos de combinação.
EmbeddedHistogramChartBuilderBuilder para gráficos de histograma.
EmbeddedLineChartBuilderBuilder para gráficos de linhas.
EmbeddedPieChartBuilderCriador de gráficos de pizza.
EmbeddedScatterChartBuilderBuilder para gráficos de dispersão.
EmbeddedTableChartBuilderCriador de gráficos de tabela.
FilterUse esta classe para modificar os filtros atuais nas planilhas de Grid, o tipo padrão de planilha.
FilterCriteriaUse essa classe para ver informações ou copiar os critérios nos filtros atuais.
FilterCriteriaBuilderPara adicionar critérios a um filtro, faça o seguinte:
  1. Crie o criador de critérios usando SpreadsheetApp.newFilterCriteria().
  2. Adicione configurações ao builder usando os métodos dessa classe.
  3. Use build() para montar os critérios com as configurações especificadas.
FrequencyTypeUma enumeração dos tipos de frequência.
GradientConditionAcesse as condições do gradiente (cor) em ConditionalFormatRuleApis.
GroupAcesse e modifique grupos de planilhas.
GroupControlTogglePositionUma enumeração que representa as possíveis posições que um controle de grupo pode ter.
InterpolationTypeUma enumeração que representa as opções de interpolação para calcular um valor a ser usado em um GradientCondition em um ConditionalFormatRule.
NamedRangeCriar, acessar e modificar intervalos nomeados em uma planilha.
OverGridImageRepresenta uma imagem na grade de uma planilha.
PageProtectionAcesse e modifique páginas protegidas na versão antiga do Planilhas Google.
PivotFilterAcesse e modifique filtros da tabela dinâmica.
PivotGroupAcessar e modificar grupos de detalhamento de tabelas dinâmicas
PivotGroupLimitAcessar e modificar o limite do grupo de tabelas dinâmicas
PivotTableAcesse e modifique tabelas dinâmicas.
PivotTableSummarizeFunctionUma enumeração das funções que resumem os dados da tabela dinâmica.
PivotValueAcesse e modifique grupos de valores em tabelas dinâmicas.
PivotValueDisplayTypeUma enumeração de maneiras de exibir um valor dinâmico como uma função de outro valor.
ProtectionAcesse e modifique intervalos e páginas protegidos.
ProtectionTypeUma enumeração que representa as partes de uma planilha que podem ser protegidas contra edições.
RangeAcesse e modifique intervalos de planilhas.
RangeListUma coleção de uma ou mais instâncias de Range na mesma planilha
RecalculationIntervalUma enumeração que representa os possíveis intervalos usados no recálculo da planilha.
RelativeDateUma enumeração que representa as opções de data relativas para calcular um valor a ser usado na BooleanCriteria baseada em data.
RichTextValueUma string de texto estilizada usada para representar o texto da célula.
RichTextValueBuilderUm builder para valores de rich text.
SelectionAcessar a seleção ativa atual na página ativa.
SheetAcesse e modifique as planilhas.
SheetTypeOs diferentes tipos de página que podem existir em uma planilha.
SlicerRepresenta um slicer, usado para filtrar intervalos, gráficos e tabelas dinâmicas de forma não colaborativa.
SortOrderUma enumeração que representa a ordem de classificação.
SortSpecA especificação da classificação.
SpreadsheetAcesse e modifique arquivos do Planilhas Google.
SpreadsheetAppAcesse e crie arquivos do Planilhas Google.
SpreadsheetThemeAcesse e modifique temas existentes.
TextDirectionUma enumeração de rotas de texto.
TextFinderLocalize ou substitua texto em um intervalo, uma planilha ou uma planilha.
TextRotationAcesse as configurações de rotação de texto de uma célula.
TextStyleO estilo renderizado do texto em uma célula.
TextStyleBuilderUm builder para estilos de texto.
TextToColumnsDelimiterUma enumeração dos tipos de delimitadores predefinidos que podem dividir uma coluna de texto em várias colunas.
ThemeColorUma representação para uma cor de tema.
ThemeColorTypeUma enumeração que descreve várias entradas de cor compatíveis com temas.
ValueTypeUma enumeração dos tipos de valor retornados por Range.getValue() e Range.getValues() da classe "Range" do serviço da planilha.
WrapStrategyÉ uma enumeração das estratégias usadas para processar o wrapper de texto da célula.

AutoFillSeries

Propriedades

PropriedadeTipoDescrição
DEFAULT_SERIESEnumPadrão:
ALTERNATE_SERIESEnumO preenchimento automático com essa configuração faz com que as células vazias no intervalo expandido sejam preenchidas com cópias dos valores existentes.

Banding

Métodos

MétodoTipo de retornoBreve descrição
copyTo(range)BandingCopia a banda para outro intervalo.
getFirstColumnColorObject()ColorRetorna a primeira cor alternada da coluna nas faixas ou null se nenhuma cor estiver definida.
getFirstRowColorObject()ColorRetorna a primeira cor alternada da linha ou null se nenhuma cor for definida.
getFooterColumnColorObject()ColorRetorna a cor da última coluna no banding, ou null se nenhuma cor for definida.
getFooterRowColorObject()ColorRetorna a cor da última linha na faixa ou null se nenhuma cor for definida.
getHeaderColumnColorObject()ColorRetorna a cor da primeira coluna no banding, ou null se nenhuma cor for definida.
getHeaderRowColorObject()ColorRetorna a cor da linha do cabeçalho ou null se nenhuma cor for definida.
getRange()RangeRetorna o intervalo da banda.
getSecondColumnColorObject()ColorRetorna a segunda cor alternada da coluna na banda ou null se nenhuma cor for definida.
getSecondRowColorObject()ColorRetorna a segunda cor alternada da linha ou null se nenhuma cor for definida.
remove()voidRemove essa faixa.
setFirstColumnColor(color)BandingDefine a cor da primeira coluna alternada.
setFirstColumnColorObject(color)BandingDefine a primeira cor alternada da coluna nas faixas.
setFirstRowColor(color)BandingDefine a cor da primeira linha alternada.
setFirstRowColorObject(color)BandingDefine a primeira cor alternada da linha na faixa.
setFooterColumnColor(color)BandingDefine a cor da última coluna.
setFooterColumnColorObject(color)BandingDefine a cor da última coluna no banding.
setFooterRowColor(color)BandingDefine a cor da última linha.
setFooterRowColorObject(color)BandingDefine a cor da linha do rodapé na banda.
setHeaderColumnColor(color)BandingDefine a cor da coluna de cabeçalho.
setHeaderColumnColorObject(color)BandingDefine a cor da coluna de cabeçalho.
setHeaderRowColor(color)BandingDefine a cor da linha do cabeçalho.
setHeaderRowColorObject(color)BandingDefine a cor da linha do cabeçalho.
setRange(range)BandingDefine o intervalo para estas faixas.
setSecondColumnColor(color)BandingDefine a cor da segunda coluna alternada.
setSecondColumnColorObject(color)BandingDefine a segunda cor alternada da coluna nas faixas.
setSecondRowColor(color)BandingDefine a cor da segunda linha alternada.
setSecondRowColorObject(color)BandingDefine a segunda cor alternada na banda.

BandingTheme

Propriedades

PropriedadeTipoDescrição
LIGHT_GREYEnumUm tema de faixa cinza-claro.
CYANEnumUm tema de faixas ciano.
GREENEnumUm tema de faixa verde.
YELLOWEnumUm tema de faixa amarelo.
ORANGEEnumUm tema de faixas laranja.
BLUEEnumUm tema de faixa azul.
TEALEnumUm tema de faixas de verde-azulado.
GREYEnumUm tema de faixa cinza.
BROWNEnumUm tema de faixa marrom.
LIGHT_GREENEnumUm tema de faixa verde-claro.
INDIGOEnumUm tema de faixas de anil.
PINKEnumUm tema de faixas rosa.

BigQueryDataSourceSpec

Métodos

MétodoTipo de retornoBreve descrição
copy()DataSourceSpecBuilderCria um DataSourceSpecBuilder com base nas configurações da fonte de dados.
getDatasetId()StringRecebe o ID do conjunto de dados do BigQuery.
getParameters()DataSourceParameter[]Acessa os parâmetros da fonte de dados.
getProjectId()StringRecebe o ID do projeto de faturamento.
getRawQuery()StringRecebe a string de consulta bruta.
getTableId()StringRecebe o ID da tabela do BigQuery.
getTableProjectId()StringRecebe o ID do projeto do BigQuery para a tabela.
getType()DataSourceTypeAcessa o tipo da fonte de dados.

BigQueryDataSourceSpecBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()DataSourceSpecCria uma especificação de fonte de dados nas configurações do builder.
copy()DataSourceSpecBuilderCria um DataSourceSpecBuilder com base nas configurações da fonte de dados.
getDatasetId()StringRecebe o ID do conjunto de dados do BigQuery.
getParameters()DataSourceParameter[]Acessa os parâmetros da fonte de dados.
getProjectId()StringRecebe o ID do projeto de faturamento.
getRawQuery()StringRecebe a string de consulta bruta.
getTableId()StringRecebe o ID da tabela do BigQuery.
getTableProjectId()StringRecebe o ID do projeto do BigQuery para a tabela.
getType()DataSourceTypeAcessa o tipo da fonte de dados.
removeAllParameters()BigQueryDataSourceSpecBuilderRemove todos os parâmetros.
removeParameter(parameterName)BigQueryDataSourceSpecBuilderRemove o parâmetro especificado.
setDatasetId(datasetId)BigQueryDataSourceSpecBuilderDefine o ID do conjunto de dados do BigQuery.
setParameterFromCell(parameterName, sourceCell)BigQueryDataSourceSpecBuilderAdiciona um parâmetro ou, se houver, atualiza a célula de origem.
setProjectId(projectId)BigQueryDataSourceSpecBuilderDefine o ID do projeto de faturamento do BigQuery.
setRawQuery(rawQuery)BigQueryDataSourceSpecBuilderDefine a string de consulta bruta.
setTableId(tableId)BigQueryDataSourceSpecBuilderDefine o ID da tabela do BigQuery.
setTableProjectId(projectId)BigQueryDataSourceSpecBuilderDefine o ID do projeto do BigQuery para a tabela.

BooleanCondition

Métodos

MétodoTipo de retornoBreve descrição
getBackgroundObject()ColorRecebe a cor do plano de fundo dessa condição booleana.
getBold()BooleanRetornará true se essa condição booleana remover o negrito do texto e retornará false se a condição booleana remover o negrito do texto.
getCriteriaType()BooleanCriteriaRecebe o tipo de critérios da regra conforme definido no tipo enumerado BooleanCriteria.
getCriteriaValues()Object[]Recebe uma matriz de argumentos para os critérios da regra.
getFontColorObject()ColorRecebe a cor da fonte dessa condição booleana.
getItalic()BooleanRetornará true se essa condição booleana remover o itálico do texto e retornará false se a condição booleana remover o itálico do texto.
getStrikethrough()BooleanRetornará true se essa condição booleana remover o tachado do texto e retornará false se a condição booleana remover o tachado do texto.
getUnderline()BooleanRetornará true se essa condição booleana sublinha o texto e retorna false se a condição booleana remover o sublinhado do texto.

BooleanCriteria

Propriedades

PropriedadeTipoDescrição
CELL_EMPTYEnumOs critérios são atendidos quando uma célula está vazia.
CELL_NOT_EMPTYEnumOs critérios são atendidos quando uma célula não está vazia.
DATE_AFTEREnumOs critérios são atendidos quando uma data é posterior ao valor fornecido.
DATE_BEFOREEnumOs critérios são atendidos quando uma data é anterior ao valor informado.
DATE_EQUAL_TOEnumOs critérios são atendidos quando uma data é igual ao valor informado.
DATE_NOT_EQUAL_TOEnumOs critérios são atendidos quando uma data não é igual ao valor informado.
DATE_AFTER_RELATIVEEnumOs critérios são atendidos quando uma data é posterior ao valor de data relativo.
DATE_BEFORE_RELATIVEEnumOs critérios são atendidos quando uma data é anterior ao valor de data relativa.
DATE_EQUAL_TO_RELATIVEEnumOs critérios são atendidos quando uma data é igual ao valor de data relativo.
NUMBER_BETWEENEnumOs critérios são atendidos quando um número está entre os valores fornecidos.
NUMBER_EQUAL_TOEnumOs critérios são atendidos quando um número é igual ao valor informado.
NUMBER_GREATER_THANEnumOs critérios são atendidos quando um número maior que o valor informado.
NUMBER_GREATER_THAN_OR_EQUAL_TOEnumOs critérios são atendidos quando um número maior ou igual ao valor informado.
NUMBER_LESS_THANEnumOs critérios são atendidos quando um número é menor que o valor informado.
NUMBER_LESS_THAN_OR_EQUAL_TOEnumOs critérios são atendidos quando um número é menor ou igual ao valor informado.
NUMBER_NOT_BETWEENEnumOs critérios são atendidos quando um número que não está entre os valores fornecidos.
NUMBER_NOT_EQUAL_TOEnumOs critérios são atendidos quando um número que não é igual ao valor informado.
TEXT_CONTAINSEnumOs critérios são atendidos quando a entrada contém o valor informado.
TEXT_DOES_NOT_CONTAINEnumOs critérios são atendidos quando a entrada não contém o valor informado.
TEXT_EQUAL_TOEnumOs critérios são atendidos quando a entrada é igual ao valor informado.
TEXT_NOT_EQUAL_TOEnumOs critérios são atendidos quando a entrada não é igual ao valor informado.
TEXT_STARTS_WITHEnumOs critérios são atendidos quando a entrada começa com o valor informado.
TEXT_ENDS_WITHEnumOs critérios são atendidos quando a entrada termina com o valor informado.
CUSTOM_FORMULAEnumOs critérios são atendidos quando a entrada faz com que a fórmula especificada seja avaliada como true.

BorderStyle

Propriedades

PropriedadeTipoDescrição
DOTTEDEnumBordas de linha pontilhadas.
DASHEDEnumBordas da linha tracejada.
SOLIDEnumBordas de linha sólidas finas.
SOLID_MEDIUMEnumBordas de linha sólida média.
SOLID_THICKEnumBordas de linha sólidas espessas.
DOUBLEEnumDuas bordas de linhas sólidas.

CellImage

Propriedades

PropriedadeTipoDescrição
valueTypeValueTypeUm campo definido como ValueType.IMAGE, representando o tipo de valor da imagem.

Métodos

MétodoTipo de retornoBreve descrição
getAltTextDescription()StringRetorna a descrição de texto alternativo desta imagem.
getAltTextTitle()StringRetorna o título do texto alternativo desta imagem.
getContentUrl()StringRetorna um URL hospedado pelo Google para a imagem.
getUrl()StringRecebe o URL de origem da imagem. Retorna null se o URL não estiver disponível.
toBuilder()CellImageBuilderCria um builder que transforma uma imagem em um tipo de valor de imagem para que você possa colocá-la em uma célula.

CellImageBuilder

Propriedades

PropriedadeTipoDescrição
valueTypeValueTypeUm campo definido como ValueType.IMAGE, representando o tipo de valor da imagem.

Métodos

MétodoTipo de retornoBreve descrição
build()CellImageCria o tipo de valor da imagem necessário para adicionar uma imagem a uma célula.
getAltTextDescription()StringRetorna a descrição de texto alternativo desta imagem.
getAltTextTitle()StringRetorna o título do texto alternativo desta imagem.
getContentUrl()StringRetorna um URL hospedado pelo Google para a imagem.
getUrl()StringRecebe o URL de origem da imagem. Retorna null se o URL não estiver disponível.
setAltTextDescription(description)CellImageDefine a descrição do texto alternativo desta imagem.
setAltTextTitle(title)CellImageDefine o título do texto alternativo para esta imagem.
setSourceUrl(url)CellImageBuilderDefine o URL de origem da imagem.
toBuilder()CellImageBuilderCria um builder que transforma uma imagem em um tipo de valor de imagem para que você possa colocá-la em uma célula.

Color

Métodos

MétodoTipo de retornoBreve descrição
asRgbColor()RgbColorConverte esta cor em um RgbColor.
asThemeColor()ThemeColorConverte esta cor em um ThemeColor.
getColorType()ColorTypeDescubra o tipo dessa cor.

ColorBuilder

Métodos

MétodoTipo de retornoBreve descrição
asRgbColor()RgbColorConverte esta cor em um RgbColor.
asThemeColor()ThemeColorConverte esta cor em um ThemeColor.
build()ColorCria um objeto de cor a partir das configurações fornecidas ao builder.
getColorType()ColorTypeDescubra o tipo dessa cor.
setRgbColor(cssString)ColorBuilderDefine como RGB.
setThemeColor(themeColorType)ColorBuilderDefine como a cor do tema.

ConditionalFormatRule

Métodos

MétodoTipo de retornoBreve descrição
copy()ConditionalFormatRuleBuilderRetorna uma predefinição de criador de regras com as configurações desta regra.
getBooleanCondition()BooleanConditionRecupera as informações do BooleanCondition da regra se essa regra usar critérios de condição booleana.
getGradientCondition()GradientConditionRecupera as informações do GradientCondition da regra se essa regra usar critérios de condição de gradiente.
getRanges()Range[]Recupera os intervalos a que esta regra de formatação condicional é aplicada.

ConditionalFormatRuleBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()ConditionalFormatRuleCria uma regra de formato condicional nas configurações aplicadas ao builder.
copy()ConditionalFormatRuleBuilderRetorna uma predefinição de criador de regras com as configurações desta regra.
getBooleanCondition()BooleanConditionRecupera as informações do BooleanCondition da regra se essa regra usar critérios de condição booleana.
getGradientCondition()GradientConditionRecupera as informações do GradientCondition da regra se essa regra usar critérios de condição de gradiente.
getRanges()Range[]Recupera os intervalos a que esta regra de formatação condicional é aplicada.
setBackground(color)ConditionalFormatRuleBuilderDefine a cor do plano de fundo do formato da regra condicional de formato.
setBackgroundObject(color)ConditionalFormatRuleBuilderDefine a cor do plano de fundo do formato da regra condicional de formato.
setBold(bold)ConditionalFormatRuleBuilderDefine o negrito do texto da regra de formato condicional.
setFontColor(color)ConditionalFormatRuleBuilderDefine a cor da fonte para o formato da regra condicional de formato.
setFontColorObject(color)ConditionalFormatRuleBuilderDefine a cor da fonte para o formato da regra condicional de formato.
setGradientMaxpoint(color)ConditionalFormatRuleBuilderLimpa o valor máximo do gradiente da regra condicional de formato e usa o valor máximo nos intervalos da regra.
setGradientMaxpointObject(color)ConditionalFormatRuleBuilderLimpa o valor máximo do gradiente da regra condicional de formato e usa o valor máximo nos intervalos da regra.
setGradientMaxpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos de ponto máximo do gradiente da regra condicional do formato condicional.
setGradientMaxpointWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos de ponto máximo do gradiente da regra condicional do formato condicional.
setGradientMidpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos de ponto médio do gradiente da regra condicional de formato.
setGradientMidpointWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos de ponto médio do gradiente da regra condicional de formato.
setGradientMinpoint(color)ConditionalFormatRuleBuilderLimpa o valor de minpoint do gradiente condicional da regra e formata o valor mínimo nos intervalos dele.
setGradientMinpointObject(color)ConditionalFormatRuleBuilderLimpa o valor de minpoint do gradiente condicional da regra e formata o valor mínimo nos intervalos dele.
setGradientMinpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos de minpoint do gradiente condicional da regra de formato condicional.
setGradientMinpointWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos de minpoint do gradiente condicional da regra de formato condicional.
setItalic(italic)ConditionalFormatRuleBuilderDefine o itálico do texto da regra de formato condicional.
setRanges(ranges)ConditionalFormatRuleBuilderDefine um ou mais intervalos aos quais a regra de formato condicional é aplicada.
setStrikethrough(strikethrough)ConditionalFormatRuleBuilderDefine o tachado do texto para o formato da regra condicional de formato.
setUnderline(underline)ConditionalFormatRuleBuilderDefine o sublinhado do texto da regra de formato condicional.
whenCellEmpty()ConditionalFormatRuleBuilderDefine a regra de formato condicional para ser acionada quando a célula estiver vazia.
whenCellNotEmpty()ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando a célula não estiver vazia.
whenDateAfter(date)ConditionalFormatRuleBuilderDefine a regra de formato condicional para ser acionada quando uma data for posterior ao valor fornecido.
whenDateAfter(date)ConditionalFormatRuleBuilderDefine a regra de formato condicional para ser acionada quando uma data for posterior à data relativa especificada.
whenDateBefore(date)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando uma data for anterior à data especificada.
whenDateBefore(date)ConditionalFormatRuleBuilderDefine a regra de formato condicional para ser acionada quando uma data for anterior à data relativa especificada.
whenDateEqualTo(date)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando uma data for igual à data especificada.
whenDateEqualTo(date)ConditionalFormatRuleBuilderDefine a regra de formato condicional para ser acionada quando uma data for igual à data relativa fornecida.
whenFormulaSatisfied(formula)ConditionalFormatRuleBuilderDefine a regra de formato condicional que será acionada quando a fórmula especificada for avaliada como true.
whenNumberBetween(start, end)ConditionalFormatRuleBuilderDefine a regra de formato condicional para ser acionada quando um número estiver entre ou for um dos dois valores especificados.
whenNumberEqualTo(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando um número for igual ao valor informado.
whenNumberGreaterThan(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando um número for maior que o valor informado.
whenNumberGreaterThanOrEqualTo(number)ConditionalFormatRuleBuilderDefine a regra de formato condicional para ser acionada quando um número for maior ou igual ao valor informado.
whenNumberLessThan(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional condicional para ser acionada quando um número menor que o valor fornecido.
whenNumberLessThanOrEqualTo(number)ConditionalFormatRuleBuilderDefine a regra de formato condicional para ser acionada quando um número menor ou igual ao valor fornecido.
whenNumberNotBetween(start, end)ConditionalFormatRuleBuilderDefine a regra de formato condicional para ser acionada quando um número não ficar entre e não for dois dos dois valores especificados.
whenNumberNotEqualTo(number)ConditionalFormatRuleBuilderDefine a regra de formato condicional para ser acionada quando um número não for igual ao valor informado.
whenTextContains(text)ConditionalFormatRuleBuilderDefine a regra de formato condicional que será acionada quando a entrada contiver o valor informado.
whenTextDoesNotContain(text)ConditionalFormatRuleBuilderDefine a regra de formato condicional para ser acionada quando a entrada não contiver o valor especificado.
whenTextEndsWith(text)ConditionalFormatRuleBuilderDefine a regra de formato condicional que será acionada quando a entrada terminar com o valor informado.
whenTextEqualTo(text)ConditionalFormatRuleBuilderDefine a regra de formato condicional que será acionada quando a entrada for igual ao valor informado.
whenTextStartsWith(text)ConditionalFormatRuleBuilderDefine a regra de formato condicional que será acionada quando a entrada começar com o valor informado.
withCriteria(criteria, args)ConditionalFormatRuleBuilderDefine a regra de formato condicional para critérios definidos por valores de BooleanCriteria, normalmente baseados em criteria e arguments de uma regra existente.

ContainerInfo

Métodos

MétodoTipo de retornoBreve descrição
getAnchorColumn()IntegerO lado esquerdo do gráfico está ancorado nesta coluna.
getAnchorRow()IntegerA parte superior do gráfico está ancorada nesta linha.
getOffsetX()IntegerO canto superior esquerdo do gráfico está deslocado por vários pixels para se deslocar da coluna âncora.
getOffsetY()IntegerO canto superior esquerdo do gráfico está deslocado por vários pixels para se deslocar da linha de âncora.

CopyPasteType

Propriedades

PropriedadeTipoDescrição
PASTE_NORMALEnumColar valores, fórmulas, formatos e mesclas.
PASTE_NO_BORDERSEnumCole valores, fórmulas, formatos e mesclagens sem bordas.
PASTE_FORMATEnumCole apenas o formato e a validação dos dados.
PASTE_FORMULAEnumCole apenas as fórmulas.
PASTE_DATA_VALIDATIONEnumCole apenas a validação dos dados.
PASTE_VALUESEnumCole os valores SOMENTE sem formatos, fórmulas ou combinações.
PASTE_CONDITIONAL_FORMATTINGEnumCole apenas as regras de cores.
PASTE_COLUMN_WIDTHSEnumCole apenas a largura das colunas.

DataExecutionErrorCode

Propriedades

PropriedadeTipoDescrição
DATA_EXECUTION_ERROR_CODE_UNSUPPORTEDEnumUm código de erro de execução de dados que não é compatível com o Apps Script.
NONEEnumA execução dos dados não tem erros.
TIME_OUTEnumA execução dos dados expirou.
TOO_MANY_ROWSEnumA execução dos dados retorna mais linhas do que o limite.
TOO_MANY_COLUMNSEnumA execução dos dados retorna mais colunas do que o limite.
TOO_MANY_CELLSEnumA execução dos dados retorna mais células do que o limite.
ENGINEEnumErro do mecanismo de execução de dados.
PARAMETER_INVALIDEnumParâmetro de execução de dados inválido.
UNSUPPORTED_DATA_TYPEEnumA execução dos dados retorna um tipo de dado não compatível.
DUPLICATE_COLUMN_NAMESEnumA execução dos dados retorna nomes de colunas duplicados.
INTERRUPTEDEnumA execução dos dados é interrompida.
OTHEREnumOutros erros.
TOO_MANY_CHARS_PER_CELLEnumA execução dos dados retorna valores que excedem o máximo de caracteres permitidos em uma única célula.
DATA_NOT_FOUNDEnumO banco de dados referido pela fonte de dados não foi encontrado.
PERMISSION_DENIEDEnumO usuário não tem acesso ao banco de dados referido pela fonte de dados.

DataExecutionState

Propriedades

PropriedadeTipoDescrição
DATA_EXECUTION_STATE_UNSUPPORTEDEnumO estado de execução de dados não é compatível com o Apps Script.
RUNNINGEnumA execução dos dados foi iniciada e está em execução.
SUCCESSEnumA execução dos dados foi concluída.
ERROREnumA execução dos dados foi concluída e contém erros.
NOT_STARTEDEnumA execução dos dados não foi iniciada.

DataExecutionStatus

Métodos

MétodoTipo de retornoBreve descrição
getErrorCode()DataExecutionErrorCodeRecebe o código de erro da execução de dados.
getErrorMessage()StringRecebe a mensagem de erro da execução de dados.
getExecutionState()DataExecutionStateRecebe o estado da execução de dados.
getLastExecutionTime()DateRecebe o horário em que a última execução de dados foi concluída, independente do estado de execução.
getLastRefreshedTime()DateRecebe o horário em que os dados foram atualizados pela última vez.
isTruncated()BooleanRetornará true se os dados da última execução bem-sucedida estiverem truncados, ou false, caso contrário.

DataSource

Métodos

MétodoTipo de retornoBreve descrição
createCalculatedColumn(name, formula)DataSourceColumnCria uma coluna calculada.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableCria uma tabela dinâmica de fonte de dados com base nessa fonte de dados na primeira célula de uma nova página.
createDataSourceTableOnNewSheet()DataSourceTableCria uma tabela de fonte de dados com base na fonte de dados na primeira célula de uma nova página.
getCalculatedColumnByName(columnName)DataSourceColumnRetorna a coluna calculada na fonte de dados que corresponde ao nome da coluna.
getCalculatedColumns()DataSourceColumn[]Retorna todas as colunas calculadas na fonte de dados.
getColumns()DataSourceColumn[]Retorna todas as colunas da fonte de dados.
getDataSourceSheets()DataSourceSheet[]Retorna as planilhas de fonte de dados associadas a esta fonte.
getSpec()DataSourceSpecRecebe a especificação da fonte de dados.
refreshAllLinkedDataSourceObjects()voidAtualiza todos os objetos da fonte de dados vinculados a ela.
updateSpec(spec)DataSourceAtualiza a especificação da fonte de dados e atualiza os objetos da fonte vinculados a essa fonte com a nova especificação.
updateSpec(spec, refreshAllLinkedObjects)DataSourceAtualiza a especificação da fonte de dados e atualiza o data source sheets vinculado com a nova especificação.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidAguarda a conclusão de todas as execuções atuais dos objetos da fonte de dados vinculada, o que expira após o número de segundos informado.

DataSourceChart

Métodos

MétodoTipo de retornoBreve descrição
forceRefreshData()DataSourceChartAtualiza os dados deste objeto, independentemente do estado atual.
getDataSource()DataSourceAcessa a fonte de dados vinculada ao objeto.
getStatus()DataExecutionStatusAcessa o status de execução de dados do objeto.
refreshData()DataSourceChartAtualiza os dados do objeto.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda até que a execução atual seja concluída, expirando após o número de segundos informado.

DataSourceColumn

Métodos

MétodoTipo de retornoBreve descrição
getDataSource()DataSourceAcessa a fonte de dados associada à coluna da fonte de dados.
getFormula()StringAcessa a fórmula para a coluna de fonte de dados.
getName()StringRecebe o nome da coluna de fonte de dados.
hasArrayDependency()BooleanRetorna se a coluna tem uma dependência de matriz.
isCalculatedColumn()BooleanRetorna se a coluna é calculada.
remove()voidRemove a coluna da fonte de dados.
setFormula(formula)DataSourceColumnDefine a fórmula para a coluna da fonte de dados.
setName(name)DataSourceColumnDefine o nome da coluna de fonte de dados.

DataSourceFormula

Métodos

MétodoTipo de retornoBreve descrição
forceRefreshData()DataSourceFormulaAtualiza os dados deste objeto, independentemente do estado atual.
getAnchorCell()RangeRetorna a Range que representa a célula em que a fórmula da fonte de dados está ancorada.
getDataSource()DataSourceAcessa a fonte de dados vinculada ao objeto.
getDisplayValue()StringRetorna o valor de exibição da fórmula da fonte de dados.
getFormula()StringRetorna a fórmula dessa fonte de dados.
getStatus()DataExecutionStatusAcessa o status de execução de dados do objeto.
refreshData()DataSourceFormulaAtualiza os dados do objeto.
setFormula(formula)DataSourceFormulaAtualiza a fórmula.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda até que a execução atual seja concluída, expirando após o número de segundos informado.

DataSourceParameter

Métodos

MétodoTipo de retornoBreve descrição
getName()StringRecebe o nome do parâmetro.
getSourceCell()StringRecebe a célula de origem em que o parâmetro é avaliado, ou null se o tipo de parâmetro não for DataSourceParameterType.CELL.
getType()DataSourceParameterTypeRecebe o tipo de parâmetro.

DataSourceParameterType

Propriedades

PropriedadeTipoDescrição
DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTEDEnumUm tipo de parâmetro de fonte de dados que não é compatível com o Apps Script.
CELLEnumO valor da fonte de dados é calculado com base em uma célula.

DataSourcePivotTable

Métodos

MétodoTipo de retornoBreve descrição
addColumnGroup(columnName)PivotGroupAdiciona um novo grupo de colunas dinâmicas com base na coluna de fonte de dados especificada.
addFilter(columnName, filterCriteria)PivotFilterAdiciona um novo filtro com base na coluna de fonte de dados especificada com os critérios de filtro especificados.
addPivotValue(columnName, summarizeFunction)PivotValueAdiciona um novo valor dinâmico com base na coluna de fonte de dados especificada com a função de resumo especificada.
addRowGroup(columnName)PivotGroupAdiciona um novo grupo de linhas dinâmicas com base na coluna de fonte de dados especificada.
asPivotTable()PivotTableRetorna a tabela dinâmica de fonte de dados como um objeto normal da tabela dinâmica.
forceRefreshData()DataSourcePivotTableAtualiza os dados deste objeto, independentemente do estado atual.
getDataSource()DataSourceAcessa a fonte de dados vinculada ao objeto.
getStatus()DataExecutionStatusAcessa o status de execução de dados do objeto.
refreshData()DataSourcePivotTableAtualiza os dados do objeto.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda até que a execução atual seja concluída, expirando após o número de segundos informado.

DataSourceRefreshSchedule

Métodos

MétodoTipo de retornoBreve descrição
getFrequency()DataSourceRefreshScheduleFrequencyRecebe a frequência da programação de atualização, que especifica com que frequência e quando atualizar.
getScope()DataSourceRefreshScopeRecebe o escopo dessa programação de atualização.
getTimeIntervalOfNextRun()TimeIntervalRecebe o período da próxima execução dessa programação de atualização.
isEnabled()BooleanDetermina se esta programação de atualização está ativada.

DataSourceRefreshScheduleFrequency

Métodos

MétodoTipo de retornoBreve descrição
getDaysOfTheMonth()Integer[]Recebe os dias do mês como números (1 a 28) em que a fonte de dados será atualizada.
getDaysOfTheWeek()Weekday[]Recebe os dias da semana em que a fonte de dados será atualizada.
getFrequencyType()FrequencyTypeRecebe o tipo de frequência.
getStartHour()IntegerRecebe a hora de início (como um número de 0 a 23) do intervalo de tempo em que a programação de atualização é executada.

DataSourceRefreshScope

Propriedades

PropriedadeTipoDescrição
DATA_SOURCE_REFRESH_SCOPE_UNSUPPORTEDEnumO escopo de atualização da fonte de dados não é compatível.
ALL_DATA_SOURCESEnumA atualização se aplica a todas as fontes de dados na planilha.

DataSourceSheet

Métodos

MétodoTipo de retornoBreve descrição
addFilter(columnName, filterCriteria)DataSourceSheetAdiciona um filtro aplicado à planilha da fonte de dados.
asSheet()SheetRetorna a planilha de fonte de dados como um objeto normal da página.
autoResizeColumn(columnName)DataSourceSheetRedimensiona automaticamente a largura da coluna especificada.
autoResizeColumns(columnNames)DataSourceSheetRedimensiona automaticamente a largura das colunas especificadas.
forceRefreshData()DataSourceSheetAtualiza os dados deste objeto, independentemente do estado atual.
getColumnWidth(columnName)IntegerRetorna a largura da coluna especificada.
getDataSource()DataSourceAcessa a fonte de dados vinculada ao objeto.
getFilters()DataSourceSheetFilter[]Retorna todos os filtros aplicados à planilha da fonte de dados.
getSheetValues(columnName)Object[]Retorna todos os valores da página de fonte de dados para o nome da coluna fornecida.
getSheetValues(columnName, startRow, numRows)Object[]Retorna todos os valores da página de fonte de dados do nome da coluna fornecida, da linha inicial fornecida (base-1) até o numRows fornecido.
getSortSpecs()SortSpec[]Recebe todas as especificações de classificação na planilha da fonte de dados.
getStatus()DataExecutionStatusAcessa o status de execução de dados do objeto.
refreshData()DataSourceSheetAtualiza os dados do objeto.
removeFilters(columnName)DataSourceSheetRemove todos os filtros aplicados à coluna da página da fonte de dados.
removeSortSpec(columnName)DataSourceSheetRemove a especificação de classificação de uma coluna na página da fonte de dados.
setColumnWidth(columnName, width)DataSourceSheetDefine a largura da coluna especificada.
setColumnWidths(columnNames, width)DataSourceSheetDefine a largura das colunas especificadas.
setSortSpec(columnName, ascending)DataSourceSheetDefine a especificação de classificação em uma coluna na página da fonte de dados.
setSortSpec(columnName, sortOrder)DataSourceSheetDefine a especificação de classificação em uma coluna na página da fonte de dados.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda até que a execução atual seja concluída, expirando após o número de segundos informado.

DataSourceSheetFilter

Métodos

MétodoTipo de retornoBreve descrição
getDataSourceColumn()DataSourceColumnRetorna a coluna da fonte de dados à qual o filtro se aplica.
getDataSourceSheet()DataSourceSheetRetorna a DataSourceSheet a que este filtro pertence.
getFilterCriteria()FilterCriteriaRetorna os critérios de filtro para este filtro.
remove()voidRemove esse filtro do objeto da fonte de dados.
setFilterCriteria(filterCriteria)DataSourceSheetFilterDefine os critérios para este filtro.

DataSourceSpec

Métodos

MétodoTipo de retornoBreve descrição
asBigQuery()BigQueryDataSourceSpecRecebe a especificação para a fonte de dados do BigQuery.
copy()DataSourceSpecBuilderCria um DataSourceSpecBuilder com base nas configurações da fonte de dados.
getParameters()DataSourceParameter[]Acessa os parâmetros da fonte de dados.
getType()DataSourceTypeAcessa o tipo da fonte de dados.

DataSourceSpecBuilder

Métodos

MétodoTipo de retornoBreve descrição
asBigQuery()BigQueryDataSourceSpecBuilderRecebe o builder da fonte de dados do BigQuery.
build()DataSourceSpecCria uma especificação de fonte de dados nas configurações do builder.
copy()DataSourceSpecBuilderCria um DataSourceSpecBuilder com base nas configurações da fonte de dados.
getParameters()DataSourceParameter[]Acessa os parâmetros da fonte de dados.
getType()DataSourceTypeAcessa o tipo da fonte de dados.
removeAllParameters()DataSourceSpecBuilderRemove todos os parâmetros.
removeParameter(parameterName)DataSourceSpecBuilderRemove o parâmetro especificado.
setParameterFromCell(parameterName, sourceCell)DataSourceSpecBuilderAdiciona um parâmetro ou, se houver, atualiza a célula de origem.

DataSourceTable

Métodos

MétodoTipo de retornoBreve descrição
addColumns(columnNames)DataSourceTableAdiciona colunas à tabela de fonte de dados.
addFilter(columnName, filterCriteria)DataSourceTableAdiciona um filtro aplicado à tabela de fonte de dados.
addSortSpec(columnName, ascending)DataSourceTableAdiciona uma especificação de classificação em uma coluna na tabela de fonte de dados.
addSortSpec(columnName, sortOrder)DataSourceTableAdiciona uma especificação de classificação em uma coluna na tabela de fonte de dados.
forceRefreshData()DataSourceTableAtualiza os dados deste objeto, independentemente do estado atual.
getColumns()DataSourceTableColumn[]Recebe todas as colunas da fonte de dados adicionadas à tabela de fonte de dados.
getDataSource()DataSourceAcessa a fonte de dados vinculada ao objeto.
getFilters()DataSourceTableFilter[]Retorna todos os filtros aplicados à tabela de fonte de dados.
getRange()RangeRecebe o Range que essa tabela de fonte de dados abrange.
getRowLimit()IntegerRetorna o limite de linhas da tabela de fonte de dados.
getSortSpecs()SortSpec[]Recebe todas as especificações de classificação na tabela de fonte de dados.
getStatus()DataExecutionStatusAcessa o status de execução de dados do objeto.
isSyncingAllColumns()BooleanRetorna se a tabela da fonte de dados está sincronizando todas as colunas na fonte de dados associada.
refreshData()DataSourceTableAtualiza os dados do objeto.
removeAllColumns()DataSourceTableRemove todas as colunas na tabela de fonte de dados.
removeAllSortSpecs()DataSourceTableRemove todas as especificações de classificação na tabela de fonte de dados.
setRowLimit(rowLimit)DataSourceTableAtualiza o limite de linhas da tabela de fonte de dados.
syncAllColumns()DataSourceTableSincronizar todas as colunas atuais e futuras na fonte de dados associada com a tabela de fonte de dados.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda até que a execução atual seja concluída, expirando após o número de segundos informado.

DataSourceTableColumn

Métodos

MétodoTipo de retornoBreve descrição
getDataSourceColumn()DataSourceColumnRecebe a coluna de soma de dados.
remove()voidRemove a coluna do DataSourceTable.

DataSourceTableFilter

Métodos

MétodoTipo de retornoBreve descrição
getDataSourceColumn()DataSourceColumnRetorna a coluna da fonte de dados à qual o filtro se aplica.
getDataSourceTable()DataSourceTableRetorna a DataSourceTable a que este filtro pertence.
getFilterCriteria()FilterCriteriaRetorna os critérios de filtro para este filtro.
remove()voidRemove esse filtro do objeto da fonte de dados.
setFilterCriteria(filterCriteria)DataSourceTableFilterDefine os critérios para este filtro.

DataSourceType

Propriedades

PropriedadeTipoDescrição
DATA_SOURCE_TYPE_UNSUPPORTEDEnumUm tipo de fonte de dados que não é compatível com o Apps Script.
BIGQUERYEnumUma fonte de dados do BigQuery.

DataValidation

Métodos

MétodoTipo de retornoBreve descrição
copy()DataValidationBuilderCria um criador para uma regra de validação de dados com base nas configurações desta regra.
getAllowInvalid()BooleanRetornará true se a regra mostrar um aviso quando a entrada falhar na validação de dados ou false se a entrada for totalmente rejeitada.
getCriteriaType()DataValidationCriteriaRecebe o tipo de critérios da regra conforme definido no tipo enumerado DataValidationCriteria.
getCriteriaValues()Object[]Recebe uma matriz de argumentos para os critérios da regra.
getHelpText()StringRecebe o texto de ajuda da regra ou null se nenhum texto de ajuda for definido.

DataValidationBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()DataValidationCria uma regra de validação de dados com base nas configurações aplicadas ao builder.
copy()DataValidationBuilderCria um criador para uma regra de validação de dados com base nas configurações desta regra.
getAllowInvalid()BooleanRetornará true se a regra mostrar um aviso quando a entrada falhar na validação de dados ou false se a entrada for totalmente rejeitada.
getCriteriaType()DataValidationCriteriaRecebe o tipo de critérios da regra conforme definido no tipo enumerado DataValidationCriteria.
getCriteriaValues()Object[]Recebe uma matriz de argumentos para os critérios da regra.
getHelpText()StringRecebe o texto de ajuda da regra ou null se nenhum texto de ajuda for definido.
requireCheckbox()DataValidationBuilderDefine a regra de validação dos dados para exigir que a entrada seja um valor booleano. Esse valor é renderizado como uma caixa de seleção.
requireCheckbox(checkedValue)DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada seja o valor especificado ou em branco.
requireCheckbox(checkedValue, uncheckedValue)DataValidationBuilderDefine a regra de validação dos dados para exigir que a entrada seja um dos valores especificados.
requireDate()DataValidationBuilderDefine a regra de validação de dados para exigir uma data.
requireDateAfter(date)DataValidationBuilderDefine a regra de validação dos dados para exigir uma data após o valor informado.
requireDateBefore(date)DataValidationBuilderDefine a regra de validação de dados para exigir uma data antes do valor fornecido.
requireDateBetween(start, end)DataValidationBuilderDefinir a regra de validação dos dados para exigir uma data que esteja entre uma das duas datas especificadas ou que seja uma delas.
requireDateEqualTo(date)DataValidationBuilderDefine a regra de validação dos dados para exigir uma data igual ao valor informado.
requireDateNotBetween(start, end)DataValidationBuilderDefine a regra de validação dos dados para exigir uma data que não esteja entre as duas datas especificadas.
requireDateOnOrAfter(date)DataValidationBuilderDefine a regra de validação de dados para exigir uma data igual ou posterior ao valor fornecido.
requireDateOnOrBefore(date)DataValidationBuilderDefine a regra de validação de dados para exigir uma data igual ou anterior ao valor fornecido.
requireFormulaSatisfied(formula)DataValidationBuilderDefine a regra de validação dos dados que exige que a fórmula especificada seja avaliada como true.
requireNumberBetween(start, end)DataValidationBuilderDefinir a regra de validação dos dados para exigir um número que esteja entre ou seja um dos dois números especificados.
requireNumberEqualTo(number)DataValidationBuilderDefine a regra de validação dos dados para exigir um número igual ao valor informado.
requireNumberGreaterThan(number)DataValidationBuilderDefine a regra de validação dos dados para exigir um número maior que o valor informado.
requireNumberGreaterThanOrEqualTo(number)DataValidationBuilderDefine a regra de validação dos dados para exigir um número maior ou igual ao valor informado.
requireNumberLessThan(number)DataValidationBuilderDefine a regra de validação dos dados para exigir um número menor que o valor informado.
requireNumberLessThanOrEqualTo(number)DataValidationBuilderDefine a regra de validação dos dados para exigir um número menor ou igual ao valor informado.
requireNumberNotBetween(start, end)DataValidationBuilderDefinir a regra de validação dos dados para exigir um número que não esteja entre dois números especificados e não seja nenhum deles.
requireNumberNotEqualTo(number)DataValidationBuilderDefine a regra de validação dos dados para exigir um número diferente do valor fornecido.
requireTextContains(text)DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada contenha o valor informado.
requireTextDoesNotContain(text)DataValidationBuilderDefine a regra de validação dos dados para exigir que a entrada não contenha o valor informado.
requireTextEqualTo(text)DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada seja igual ao valor informado.
requireTextIsEmail()DataValidationBuilderDefine a regra de validação dos dados para exigir que a entrada esteja na forma de um endereço de e-mail.
requireTextIsUrl()DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada esteja na forma de um URL.
requireValueInList(values)DataValidationBuilderDefine a regra de validação dos dados para exigir que a entrada seja igual a um dos valores fornecidos.
requireValueInList(values, showDropdown)DataValidationBuilderDefine a regra de validação dos dados para exigir que a entrada seja igual a um dos valores fornecidos, com uma opção de ocultar o menu suspenso.
requireValueInRange(range)DataValidationBuilderDefine a regra de validação dos dados para exigir que a entrada seja igual a um valor no intervalo determinado.
requireValueInRange(range, showDropdown)DataValidationBuilderDefine a regra de validação dos dados para exigir que a entrada seja igual a um valor no intervalo especificado, com uma opção para ocultar o menu suspenso.
setAllowInvalid(allowInvalidData)DataValidationBuilderDefine se é necessário mostrar um aviso quando a entrada falhar na validação de dados ou se ela será rejeitada totalmente.
setHelpText(helpText)DataValidationBuilderDefine o texto de ajuda que aparece quando o usuário passa o cursor sobre a célula em que a validação de dados está definida.
withCriteria(criteria, args)DataValidationBuilderDefine a regra de validação de dados como critérios definidos por valores DataValidationCriteria, geralmente retirados do criteria e arguments de uma regra existente.

DataValidationCriteria

Propriedades

PropriedadeTipoDescrição
DATE_AFTEREnumRequer uma data posterior ao valor informado.
DATE_BEFOREEnumRequer uma data anterior ao valor informado.
DATE_BETWEENEnumRequer uma data entre os valores fornecidos.
DATE_EQUAL_TOEnumRequer uma data igual ao valor informado.
DATE_IS_VALID_DATEEnumRequer uma data.
DATE_NOT_BETWEENEnumRequer uma data que não esteja entre os valores fornecidos.
DATE_ON_OR_AFTEREnumExigir uma data que seja igual ou posterior ao valor fornecido.
DATE_ON_OR_BEFOREEnumRequer uma data que seja igual ou anterior ao valor fornecido.
NUMBER_BETWEENEnumRequer um número entre os valores fornecidos.
NUMBER_EQUAL_TOEnumRequer um número igual ao valor informado.
NUMBER_GREATER_THANEnumExige um número maior que o valor informado.
NUMBER_GREATER_THAN_OR_EQUAL_TOEnumRequer um número maior ou igual ao valor informado.
NUMBER_LESS_THANEnumRequer um número menor que o valor fornecido.
NUMBER_LESS_THAN_OR_EQUAL_TOEnumRequer um número menor ou igual ao valor informado.
NUMBER_NOT_BETWEENEnumRequer um número que não esteja entre os valores fornecidos.
NUMBER_NOT_EQUAL_TOEnumRequer um número diferente do valor informado.
TEXT_CONTAINSEnumRequer que a entrada contenha o valor informado.
TEXT_DOES_NOT_CONTAINEnumRequer que a entrada não contenha o valor informado.
TEXT_EQUAL_TOEnumRequer que a entrada seja igual ao valor informado.
TEXT_IS_VALID_EMAILEnumRequer que a entrada esteja na forma de um endereço de e-mail.
TEXT_IS_VALID_URLEnumRequer que a entrada seja na forma de um URL.
VALUE_IN_LISTEnumRequer que a entrada seja igual a um dos valores fornecidos.
VALUE_IN_RANGEEnumRequer que a entrada seja igual a um valor no intervalo especificado.
CUSTOM_FORMULAEnumRequer que a entrada faça com que a fórmula especificada seja avaliada como true.
CHECKBOXEnumRequer que a entrada seja um valor personalizado ou um booleano, renderizada como uma caixa de seleção.

DateTimeGroupingRule

Métodos

MétodoTipo de retornoBreve descrição
getRuleType()DateTimeGroupingRuleTypeRecebe o tipo da regra de agrupamento de data e hora.

DateTimeGroupingRuleType

Propriedades

PropriedadeTipoDescrição
UNSUPPORTEDEnumUm tipo de regra de agrupamento de data e hora não compatível.
SECONDEnumAgrupe a data-hora por segundo, de 0 a 59.
MINUTEEnumAgrupe data/hora por minuto, de 0 a 59.
HOUREnumAgrupe data-hora por hora usando um sistema de 24 horas, de 0 a 23.
HOUR_MINUTEEnumAgrupe a data e hora por minuto e minuto usando um sistema de 24 horas, por exemplo, 19:45.
HOUR_MINUTE_AMPMEnumAgrupe a data e hora por minuto e minuto usando um sistema de 12 horas, por exemplo, 7:45 PM.
DAY_OF_WEEKEnumAgrupe a data e hora por dia da semana, por exemplo, Sunday.
DAY_OF_YEAREnumAgrupe data e hora por dia do ano, de 1 a 366.
DAY_OF_MONTHEnumAgrupe data e hora por dia do mês, de 1 a 31.
DAY_MONTHEnumAgrupe data e hora por dia e mês, por exemplo, 22-Nov.
MONTHEnumAgrupe data/hora por mês, por exemplo, Nov.
QUARTEREnumAgrupe a data por trimestre, por exemplo, T1 (que representa janeiro a março).
YEAREnumGrupo por data e ano, por exemplo, 2008.
YEAR_MONTHEnumAgrupe a data e o ano por mês e mês, por exemplo, 2008-Nov.
YEAR_QUARTEREnumAgrupe a data e ano por ano e trimestre, por exemplo, 2008 Q4.
YEAR_MONTH_DAYEnumAgrupe data e hora por ano, mês e dia, por exemplo, 2008-11-22.

DeveloperMetadata

Métodos

MétodoTipo de retornoBreve descrição
getId()IntegerRetorna o ID exclusivo associado a esses metadados do desenvolvedor.
getKey()StringRetorna a chave associada a esses metadados do desenvolvedor.
getLocation()DeveloperMetadataLocationRetorna o local dos metadados deste desenvolvedor.
getValue()StringRetorna o valor associado aos metadados do desenvolvedor ou null se esses metadados não tiverem valor.
getVisibility()DeveloperMetadataVisibilityRetorna a visibilidade dos metadados do desenvolvedor.
moveToColumn(column)DeveloperMetadataMove os metadados do desenvolvedor para a coluna especificada.
moveToRow(row)DeveloperMetadataMove os metadados do desenvolvedor para a linha especificada.
moveToSheet(sheet)DeveloperMetadataMove os metadados do desenvolvedor para a planilha especificada.
moveToSpreadsheet()DeveloperMetadataMove os metadados do desenvolvedor para a planilha de nível superior.
remove()voidExclui esses metadados.
setKey(key)DeveloperMetadataDefine a chave desses metadados do desenvolvedor com o valor especificado.
setValue(value)DeveloperMetadataDefine o valor associado a esses metadados do desenvolvedor como o valor especificado.
setVisibility(visibility)DeveloperMetadataDefine a visibilidade dos metadados do desenvolvedor como a visibilidade especificada.

DeveloperMetadataFinder

Métodos

MétodoTipo de retornoBreve descrição
find()DeveloperMetadata[]Executa essa pesquisa e retorna os metadados correspondentes.
onIntersectingLocations()DeveloperMetadataFinderConfigura a pesquisa para considerar a interseção de locais com metadados.
withId(id)DeveloperMetadataFinderLimita essa pesquisa a considerar apenas metadados que correspondem ao ID especificado.
withKey(key)DeveloperMetadataFinderLimita essa pesquisa a considerar apenas os metadados que correspondem à chave especificada.
withLocationType(locationType)DeveloperMetadataFinderLimita essa pesquisa a considerar apenas metadados que correspondem ao tipo de local especificado.
withValue(value)DeveloperMetadataFinderLimita essa pesquisa a considerar apenas metadados que correspondem ao valor especificado.
withVisibility(visibility)DeveloperMetadataFinderLimita essa pesquisa a considerar apenas os metadados que correspondem à visibilidade especificada.

DeveloperMetadataLocation

Métodos

MétodoTipo de retornoBreve descrição
getColumn()RangeRetorna o Range para o local da coluna desses metadados, ou null se o tipo de local não for DeveloperMetadataLocationType.COLUMN.
getLocationType()DeveloperMetadataLocationTypeRecebe o tipo de local.
getRow()RangeRetorna o Range para o local da linha desses metadados ou null se o tipo de local não for DeveloperMetadataLocationType.ROW.
getSheet()SheetRetorna o local Sheet desses metadados, ou null se o tipo de local não for DeveloperMetadataLocationType.SHEET.
getSpreadsheet()SpreadsheetRetorna o local Spreadsheet desses metadados, ou null se o tipo de local não for DeveloperMetadataLocationType.SPREADSHEET.

DeveloperMetadataLocationType

Propriedades

PropriedadeTipoDescrição
SPREADSHEETEnumÉ o tipo de local dos metadados do desenvolvedor associados à planilha de nível superior.
SHEETEnumÉ o tipo de local dos metadados do desenvolvedor associados a uma página inteira.
ROWEnumO tipo de local para metadados do desenvolvedor associados a uma linha.
COLUMNEnumTipo de local dos metadados do desenvolvedor associados a uma coluna.

DeveloperMetadataVisibility

Propriedades

PropriedadeTipoDescrição
DOCUMENTEnumOs metadados visíveis ao documento podem ser acessados em qualquer projeto de desenvolvedor com acesso a ele.
PROJECTEnumOs metadados visíveis ao projeto só ficam visíveis e acessíveis para o projeto do desenvolvedor que criou os metadados.

Dimension

Propriedades

PropriedadeTipoDescrição
COLUMNSEnumA dimensão da coluna (vertical).
ROWSEnumA dimensão de linha (horizontal).

Direction

Propriedades

PropriedadeTipoDescrição
UPEnumA direção da diminuição dos índices de linha.
DOWNEnumA direção do aumento dos índices de linhas.
PREVIOUSEnumA direção da diminuição dos índices de coluna.
NEXTEnumA direção do aumento dos índices de colunas.

Drawing

Métodos

MétodoTipo de retornoBreve descrição
getContainerInfo()ContainerInfoRecebe informações sobre onde o desenho está posicionado na página.
getHeight()IntegerRetorna a altura real do desenho em pixels.
getOnAction()StringRetorna o nome da macro anexada a este desenho.
getSheet()SheetRetorna a página em que o desenho aparece.
getWidth()IntegerRetorna a largura real do desenho em pixels.
getZIndex()NumberRetorna o Z-index deste desenho.
remove()voidExclui este desenho da planilha.
setHeight(height)DrawingDefine a altura real do desenho em pixels.
setOnAction(macroName)DrawingAtribui uma função de macro a este desenho.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)DrawingDefine a posição em que o desenho aparece na página.
setWidth(width)DrawingDefine a largura real do desenho em pixels.
setZIndex(zIndex)DrawingDefine o Z-index deste desenho.

EmbeddedAreaChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que este builder modifica.
asAreaChart()EmbeddedAreaChartBuilderDefine o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderDefine o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderDefine o tipo de gráfico como ColumnChart e retorna um EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderDefine o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderDefine o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderDefine o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderDefine o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderDefine o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderDefine o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder.
build()EmbeddedChartCria o gráfico para refletir todas as alterações feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na página.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para este gráfico no momento.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
reverseCategories()EmbeddedAreaChartBuilderReverte o desenho da série no eixo do domínio.
setBackgroundColor(cssValue)EmbeddedAreaChartBuilderDefine a cor do plano de fundo do gráfico.
setChartType(type)EmbeddedChartBuilderAltera o tipo de gráfico.
setColors(cssValues)EmbeddedAreaChartBuilderDefine as cores das linhas no gráfico.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderDefine a estratégia a ser usada para linhas e colunas ocultas.
setLegendPosition(position)EmbeddedAreaChartBuilderDefine a posição da legenda em relação ao gráfico.
setLegendTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo de texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de combinação a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPointStyle(style)EmbeddedAreaChartBuilderDefine o estilo dos pontos na linha.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, alterando o local em que o gráfico aparece na página.
setRange(start, end)EmbeddedAreaChartBuilderDefine o intervalo do gráfico.
setStacked()EmbeddedAreaChartBuilderUsa linhas empilhadas, ou seja, os valores de linha e barra são empilhados (acumulados).
setTitle(chartTitle)EmbeddedAreaChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e as colunas do gráfico são transpostas.
setXAxisTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedAreaChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo de texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedAreaChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()EmbeddedAreaChartBuilderDeixa o eixo de intervalo em uma escala logarítmica (exige que todos os valores sejam positivos).

EmbeddedBarChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que este builder modifica.
asAreaChart()EmbeddedAreaChartBuilderDefine o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderDefine o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderDefine o tipo de gráfico como ColumnChart e retorna um EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderDefine o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderDefine o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderDefine o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderDefine o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderDefine o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderDefine o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder.
build()EmbeddedChartCria o gráfico para refletir todas as alterações feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na página.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para este gráfico no momento.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
reverseCategories()EmbeddedBarChartBuilderReverte o desenho da série no eixo do domínio.
reverseDirection()EmbeddedBarChartBuilderInverte a direção em que as barras crescem ao longo do eixo horizontal.
setBackgroundColor(cssValue)EmbeddedBarChartBuilderDefine a cor do plano de fundo do gráfico.
setChartType(type)EmbeddedChartBuilderAltera o tipo de gráfico.
setColors(cssValues)EmbeddedBarChartBuilderDefine as cores das linhas no gráfico.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderDefine a estratégia a ser usada para linhas e colunas ocultas.
setLegendPosition(position)EmbeddedBarChartBuilderDefine a posição da legenda em relação ao gráfico.
setLegendTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo de texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de combinação a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, alterando o local em que o gráfico aparece na página.
setRange(start, end)EmbeddedBarChartBuilderDefine o intervalo do gráfico.
setStacked()EmbeddedBarChartBuilderUsa linhas empilhadas, ou seja, os valores de linha e barra são empilhados (acumulados).
setTitle(chartTitle)EmbeddedBarChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e as colunas do gráfico são transpostas.
setXAxisTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedBarChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo de texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedBarChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()EmbeddedBarChartBuilderDeixa o eixo de intervalo em uma escala logarítmica (exige que todos os valores sejam positivos).

EmbeddedChart

Métodos

MétodoTipo de retornoBreve descrição
asDataSourceChart()DataSourceChartConverte em uma instância do gráfico de fonte de dados se o gráfico for de fonte de dados ou null, caso contrário.
getAs(contentType)BlobRetorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBlob()BlobRetorne os dados dentro desse objeto como um blob.
getChartId()IntegerRetorna um identificador estável exclusivo do gráfico que contém o gráfico ou null se o gráfico não estiver em uma planilha.
getContainerInfo()ContainerInfoRetorna informações sobre onde o gráfico está posicionado em uma página.
getHiddenDimensionStrategy()ChartHiddenDimensionStrategyRetorna a estratégia a ser usada para processar linhas e colunas ocultas.
getMergeStrategy()ChartMergeStrategyRetorna a estratégia de combinação usada quando há mais de um intervalo.
getNumHeaders()IntegerRetorna o número de linhas ou colunas no intervalo que são tratados como cabeçalhos.
getOptions()ChartOptionsRetorna as opções desse gráfico, como altura, cores e eixos.
getRanges()Range[]Retorna os intervalos que este gráfico usa como fonte de dados.
getTransposeRowsAndColumns()BooleanSe true, as linhas e colunas usadas para preencher o gráfico são alternadas.
modify()EmbeddedChartBuilderRetorna um EmbeddedChartBuilder que pode ser usado para modificar este gráfico.

EmbeddedChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que este builder modifica.
asAreaChart()EmbeddedAreaChartBuilderDefine o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderDefine o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderDefine o tipo de gráfico como ColumnChart e retorna um EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderDefine o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderDefine o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderDefine o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderDefine o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderDefine o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderDefine o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder.
build()EmbeddedChartCria o gráfico para refletir todas as alterações feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na página.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para este gráfico no momento.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
setChartType(type)EmbeddedChartBuilderAltera o tipo de gráfico.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderDefine a estratégia a ser usada para linhas e colunas ocultas.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de combinação a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, alterando o local em que o gráfico aparece na página.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e as colunas do gráfico são transpostas.

EmbeddedColumnChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que este builder modifica.
asAreaChart()EmbeddedAreaChartBuilderDefine o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderDefine o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderDefine o tipo de gráfico como ColumnChart e retorna um EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderDefine o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderDefine o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderDefine o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderDefine o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderDefine o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderDefine o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder.
build()EmbeddedChartCria o gráfico para refletir todas as alterações feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na página.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para este gráfico no momento.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
reverseCategories()EmbeddedColumnChartBuilderReverte o desenho da série no eixo do domínio.
setBackgroundColor(cssValue)EmbeddedColumnChartBuilderDefine a cor do plano de fundo do gráfico.
setChartType(type)EmbeddedChartBuilderAltera o tipo de gráfico.
setColors(cssValues)EmbeddedColumnChartBuilderDefine as cores das linhas no gráfico.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderDefine a estratégia a ser usada para linhas e colunas ocultas.
setLegendPosition(position)EmbeddedColumnChartBuilderDefine a posição da legenda em relação ao gráfico.
setLegendTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo de texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de combinação a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, alterando o local em que o gráfico aparece na página.
setRange(start, end)EmbeddedColumnChartBuilderDefine o intervalo do gráfico.
setStacked()EmbeddedColumnChartBuilderUsa linhas empilhadas, ou seja, os valores de linha e barra são empilhados (acumulados).
setTitle(chartTitle)EmbeddedColumnChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e as colunas do gráfico são transpostas.
setXAxisTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedColumnChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo de texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedColumnChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()EmbeddedColumnChartBuilderDeixa o eixo de intervalo em uma escala logarítmica (exige que todos os valores sejam positivos).

EmbeddedComboChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que este builder modifica.
asAreaChart()EmbeddedAreaChartBuilderDefine o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderDefine o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderDefine o tipo de gráfico como ColumnChart e retorna um EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderDefine o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderDefine o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderDefine o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderDefine o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderDefine o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderDefine o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder.
build()EmbeddedChartCria o gráfico para refletir todas as alterações feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na página.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para este gráfico no momento.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
reverseCategories()EmbeddedComboChartBuilderReverte o desenho da série no eixo do domínio.
setBackgroundColor(cssValue)EmbeddedComboChartBuilderDefine a cor do plano de fundo do gráfico.
setChartType(type)EmbeddedChartBuilderAltera o tipo de gráfico.
setColors(cssValues)EmbeddedComboChartBuilderDefine as cores das linhas no gráfico.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderDefine a estratégia a ser usada para linhas e colunas ocultas.
setLegendPosition(position)EmbeddedComboChartBuilderDefine a posição da legenda em relação ao gráfico.
setLegendTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo de texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de combinação a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, alterando o local em que o gráfico aparece na página.
setRange(start, end)EmbeddedComboChartBuilderDefine o intervalo do gráfico.
setStacked()EmbeddedComboChartBuilderUsa linhas empilhadas, ou seja, os valores de linha e barra são empilhados (acumulados).
setTitle(chartTitle)EmbeddedComboChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e as colunas do gráfico são transpostas.
setXAxisTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedComboChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo de texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedComboChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()EmbeddedComboChartBuilderDeixa o eixo de intervalo em uma escala logarítmica (exige que todos os valores sejam positivos).

EmbeddedHistogramChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que este builder modifica.
asAreaChart()EmbeddedAreaChartBuilderDefine o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderDefine o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderDefine o tipo de gráfico como ColumnChart e retorna um EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderDefine o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderDefine o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderDefine o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderDefine o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderDefine o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderDefine o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder.
build()EmbeddedChartCria o gráfico para refletir todas as alterações feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na página.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para este gráfico no momento.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
reverseCategories()EmbeddedHistogramChartBuilderReverte o desenho da série no eixo do domínio.
setBackgroundColor(cssValue)EmbeddedHistogramChartBuilderDefine a cor do plano de fundo do gráfico.
setChartType(type)EmbeddedChartBuilderAltera o tipo de gráfico.
setColors(cssValues)EmbeddedHistogramChartBuilderDefine as cores das linhas no gráfico.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderDefine a estratégia a ser usada para linhas e colunas ocultas.
setLegendPosition(position)EmbeddedHistogramChartBuilderDefine a posição da legenda em relação ao gráfico.
setLegendTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo de texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de combinação a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, alterando o local em que o gráfico aparece na página.
setRange(start, end)EmbeddedHistogramChartBuilderDefine o intervalo do gráfico.
setStacked()EmbeddedHistogramChartBuilderUsa linhas empilhadas, ou seja, os valores de linha e barra são empilhados (acumulados).
setTitle(chartTitle)EmbeddedHistogramChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e as colunas do gráfico são transpostas.
setXAxisTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedHistogramChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo de texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedHistogramChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()EmbeddedHistogramChartBuilderDeixa o eixo de intervalo em uma escala logarítmica (exige que todos os valores sejam positivos).

EmbeddedLineChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que este builder modifica.
asAreaChart()EmbeddedAreaChartBuilderDefine o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderDefine o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderDefine o tipo de gráfico como ColumnChart e retorna um EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderDefine o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderDefine o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderDefine o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderDefine o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderDefine o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderDefine o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder.
build()EmbeddedChartCria o gráfico para refletir todas as alterações feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na página.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para este gráfico no momento.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
reverseCategories()EmbeddedLineChartBuilderReverte o desenho da série no eixo do domínio.
setBackgroundColor(cssValue)EmbeddedLineChartBuilderDefine a cor do plano de fundo do gráfico.
setChartType(type)EmbeddedChartBuilderAltera o tipo de gráfico.
setColors(cssValues)EmbeddedLineChartBuilderDefine as cores das linhas no gráfico.
setCurveStyle(style)EmbeddedLineChartBuilderDefine o estilo a ser usado para curvas no gráfico.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderDefine a estratégia a ser usada para linhas e colunas ocultas.
setLegendPosition(position)EmbeddedLineChartBuilderDefine a posição da legenda em relação ao gráfico.
setLegendTextStyle(textStyle)EmbeddedLineChartBuilderDefine o estilo de texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de combinação a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPointStyle(style)EmbeddedLineChartBuilderDefine o estilo dos pontos na linha.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, alterando o local em que o gráfico aparece na página.
setRange(start, end)EmbeddedLineChartBuilderDefine o intervalo do gráfico.
setTitle(chartTitle)EmbeddedLineChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedLineChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e as colunas do gráfico são transpostas.
setXAxisTextStyle(textStyle)EmbeddedLineChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedLineChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedLineChartBuilderDefine o estilo de texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedLineChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedLineChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedLineChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()EmbeddedLineChartBuilderDeixa o eixo de intervalo em uma escala logarítmica (exige que todos os valores sejam positivos).

EmbeddedPieChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que este builder modifica.
asAreaChart()EmbeddedAreaChartBuilderDefine o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderDefine o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderDefine o tipo de gráfico como ColumnChart e retorna um EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderDefine o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderDefine o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderDefine o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderDefine o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderDefine o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderDefine o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder.
build()EmbeddedChartCria o gráfico para refletir todas as alterações feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na página.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para este gráfico no momento.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
reverseCategories()EmbeddedPieChartBuilderReverte o desenho da série no eixo do domínio.
set3D()EmbeddedPieChartBuilderDefine o gráfico como tridimensional.
setBackgroundColor(cssValue)EmbeddedPieChartBuilderDefine a cor do plano de fundo do gráfico.
setChartType(type)EmbeddedChartBuilderAltera o tipo de gráfico.
setColors(cssValues)EmbeddedPieChartBuilderDefine as cores das linhas no gráfico.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderDefine a estratégia a ser usada para linhas e colunas ocultas.
setLegendPosition(position)EmbeddedPieChartBuilderDefine a posição da legenda em relação ao gráfico.
setLegendTextStyle(textStyle)EmbeddedPieChartBuilderDefine o estilo de texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de combinação a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, alterando o local em que o gráfico aparece na página.
setTitle(chartTitle)EmbeddedPieChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedPieChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e as colunas do gráfico são transpostas.

EmbeddedScatterChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que este builder modifica.
asAreaChart()EmbeddedAreaChartBuilderDefine o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderDefine o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderDefine o tipo de gráfico como ColumnChart e retorna um EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderDefine o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderDefine o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderDefine o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderDefine o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderDefine o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderDefine o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder.
build()EmbeddedChartCria o gráfico para refletir todas as alterações feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na página.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para este gráfico no momento.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
setBackgroundColor(cssValue)EmbeddedScatterChartBuilderDefine a cor do plano de fundo do gráfico.
setChartType(type)EmbeddedChartBuilderAltera o tipo de gráfico.
setColors(cssValues)EmbeddedScatterChartBuilderDefine as cores das linhas no gráfico.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderDefine a estratégia a ser usada para linhas e colunas ocultas.
setLegendPosition(position)EmbeddedScatterChartBuilderDefine a posição da legenda em relação ao gráfico.
setLegendTextStyle(textStyle)EmbeddedScatterChartBuilderDefine o estilo de texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de combinação a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPointStyle(style)EmbeddedScatterChartBuilderDefine o estilo dos pontos na linha.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, alterando o local em que o gráfico aparece na página.
setTitle(chartTitle)EmbeddedScatterChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedScatterChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e as colunas do gráfico são transpostas.
setXAxisLogScale()EmbeddedScatterChartBuilderDeixa o eixo horizontal em uma escala logarítmica (exige que todos os valores sejam positivos).
setXAxisRange(start, end)EmbeddedScatterChartBuilderDefine o intervalo do eixo horizontal do gráfico.
setXAxisTextStyle(textStyle)EmbeddedScatterChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedScatterChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedScatterChartBuilderDefine o estilo de texto do título do eixo horizontal.
setYAxisLogScale()EmbeddedScatterChartBuilderDeixa o eixo vertical em uma escala logarítmica (exige que todos os valores sejam positivos).
setYAxisRange(start, end)EmbeddedScatterChartBuilderDefine o intervalo do eixo vertical do gráfico.
setYAxisTextStyle(textStyle)EmbeddedScatterChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedScatterChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedScatterChartBuilderDefine o estilo do texto do título do eixo vertical.

EmbeddedTableChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que este builder modifica.
asAreaChart()EmbeddedAreaChartBuilderDefine o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderDefine o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderDefine o tipo de gráfico como ColumnChart e retorna um EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderDefine o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderDefine o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderDefine o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderDefine o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderDefine o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderDefine o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder.
build()EmbeddedChartCria o gráfico para refletir todas as alterações feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
enablePaging(enablePaging)EmbeddedTableChartBuilderDefine se a paginação será ativada pelos dados.
enablePaging(pageSize)EmbeddedTableChartBuilderAtiva a paginação e define o número de linhas em cada página.
enablePaging(pageSize, startPage)EmbeddedTableChartBuilderAtiva a paginação, define o número de linhas em cada página e a primeira página de tabela a ser exibida (os números de página são baseados em zero).
enableRtlTable(rtlEnabled)EmbeddedTableChartBuilderAdiciona compatibilidade básica com idiomas da direita para a esquerda (como árabe ou hebraico) invertendo a ordem das colunas da tabela, de modo que a coluna zero seja a coluna mais à direita e a última coluna seja a mais à esquerda.
enableSorting(enableSorting)EmbeddedTableChartBuilderDefine se as colunas serão classificadas quando o usuário clicar no título de uma coluna.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na página.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para este gráfico no momento.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
setChartType(type)EmbeddedChartBuilderAltera o tipo de gráfico.
setFirstRowNumber(number)EmbeddedTableChartBuilderDefine o número da primeira linha na tabela de dados.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderDefine a estratégia a ser usada para linhas e colunas ocultas.
setInitialSortingAscending(column)EmbeddedTableChartBuilderDefine o índice da coluna em que a tabela precisa ser classificada inicialmente (crescente).
setInitialSortingDescending(column)EmbeddedTableChartBuilderDefine o índice da coluna em que a tabela precisa ser classificada inicialmente (decrescente).
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de combinação a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, alterando o local em que o gráfico aparece na página.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e as colunas do gráfico são transpostas.
showRowNumberColumn(showRowNumber)EmbeddedTableChartBuilderDefine se o número da linha deve ser exibido como a primeira coluna da tabela.
useAlternatingRowStyle(alternate)EmbeddedTableChartBuilderDefine se o estilo de cores alternadas é atribuído a linhas pares e ímpares de um gráfico de tabela.

Filter

Métodos

MétodoTipo de retornoBreve descrição
getColumnFilterCriteria(columnPosition)FilterCriteriaRecebe os critérios de filtro na coluna especificada ou null se a coluna não tiver critérios de filtro aplicados a ela.
getRange()RangeRecebe o intervalo ao qual este filtro se aplica.
remove()voidRemove este filtro.
removeColumnFilterCriteria(columnPosition)FilterRemove o critério de filtro da coluna especificada.
setColumnFilterCriteria(columnPosition, filterCriteria)FilterDefine os critérios de filtro na coluna especificada.
sort(columnPosition, ascending)FilterClassifica o intervalo filtrado pela coluna especificada, excluindo a primeira linha (a linha do cabeçalho) no intervalo ao qual este filtro se aplica.

FilterCriteria

Métodos

MétodoTipo de retornoBreve descrição
copy()FilterCriteriaBuilderCopia esse critério de filtro e cria um criador de critérios que pode ser aplicado a outro filtro.
getCriteriaType()BooleanCriteriaRetorna o tipo booleano dos critérios, como CELL_EMPTY.
getCriteriaValues()Object[]Retorna uma matriz de argumentos para critérios booleanos.
getHiddenValues()String[]Retorna os valores que o filtro oculta.
getVisibleBackgroundColor()ColorRetorna a cor de fundo usada como critério de filtro.
getVisibleForegroundColor()ColorRetorna a cor do primeiro plano usada como um critério do filtro.
getVisibleValues()String[]Retorna os valores exibidos pelo filtro da tabela dinâmica.

FilterCriteriaBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()FilterCriteriaCria os critérios de filtro usando as configurações adicionadas ao criador de critérios.
copy()FilterCriteriaBuilderCopia esse critério de filtro e cria um criador de critérios que pode ser aplicado a outro filtro.
getCriteriaType()BooleanCriteriaRetorna o tipo booleano dos critérios, como CELL_EMPTY.
getCriteriaValues()Object[]Retorna uma matriz de argumentos para critérios booleanos.
getHiddenValues()String[]Retorna os valores que o filtro oculta.
getVisibleBackgroundColor()ColorRetorna a cor de fundo usada como critério de filtro.
getVisibleForegroundColor()ColorRetorna a cor do primeiro plano usada como um critério do filtro.
getVisibleValues()String[]Retorna os valores exibidos pelo filtro da tabela dinâmica.
setHiddenValues(values)FilterCriteriaBuilderDefine os valores a serem ocultados.
setVisibleBackgroundColor(visibleBackgroundColor)FilterCriteriaBuilderDefine a cor do plano de fundo usada como critério de filtro.
setVisibleForegroundColor(visibleForegroundColor)FilterCriteriaBuilderDefine a cor do primeiro plano usada como critério do filtro.
setVisibleValues(values)FilterCriteriaBuilderDefine os valores a serem exibidos em uma tabela dinâmica.
whenCellEmpty()FilterCriteriaBuilderDefine os critérios de filtro para mostrar células vazias.
whenCellNotEmpty()FilterCriteriaBuilderDefine os critérios de filtro para mostrar células que não estão vazias.
whenDateAfter(date)FilterCriteriaBuilderDefine critérios de filtro que mostram células com datas posteriores à data especificada.
whenDateAfter(date)FilterCriteriaBuilderDefine critérios de filtro que mostram as células com datas posteriores à data relativa especificada.
whenDateBefore(date)FilterCriteriaBuilderDefine critérios de filtro que mostram células com datas anteriores à especificada.
whenDateBefore(date)FilterCriteriaBuilderDefine critérios de filtro que mostram células com datas anteriores à data relativa especificada.
whenDateEqualTo(date)FilterCriteriaBuilderDefine critérios de filtro que mostram células com datas iguais à especificada.
whenDateEqualTo(date)FilterCriteriaBuilderDefine critérios de filtro que mostram células com datas iguais à data relativa especificada.
whenDateEqualToAny(dates)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com datas iguais a qualquer uma das datas especificadas.
whenDateNotEqualTo(date)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células que não sejam iguais à data especificada.
whenDateNotEqualToAny(dates)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com datas diferentes de qualquer uma das datas especificadas.
whenFormulaSatisfied(formula)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com uma fórmula especificada (como =B:B<C:C) que é avaliada como true.
whenNumberBetween(start, end)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número que esteja entre ou seja um dos dois números especificados.
whenNumberEqualTo(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número que é igual ao número especificado.
whenNumberEqualToAny(numbers)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número igual a qualquer um dos números especificados.
whenNumberGreaterThan(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número maior que o especificado
whenNumberGreaterThanOrEqualTo(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número maior ou igual ao número especificado.
whenNumberLessThan(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número menor que o especificado.
whenNumberLessThanOrEqualTo(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número menor ou igual ao número especificado.
whenNumberNotBetween(start, end)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número que não se enquadra entre dois números especificados.
whenNumberNotEqualTo(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número que não é igual ao número especificado.
whenNumberNotEqualToAny(numbers)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número diferente de qualquer um dos números especificados.
whenTextContains(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto especificado.
whenTextDoesNotContain(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto que não contém o texto especificado.
whenTextEndsWith(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto que termina com o texto especificado.
whenTextEqualTo(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto igual ao especificado.
whenTextEqualToAny(texts)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto igual a qualquer um dos valores de texto especificados.
whenTextNotEqualTo(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto diferente do especificado.
whenTextNotEqualToAny(texts)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto diferente de qualquer um dos valores especificados.
whenTextStartsWith(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto que começa com o texto especificado.
withCriteria(criteria, args)FilterCriteriaBuilderDefine os critérios de filtro como uma condição booleana definida por valores BooleanCriteria, como CELL_EMPTY ou NUMBER_GREATER_THAN.

FrequencyType

Propriedades

PropriedadeTipoDescrição
FREQUENCY_TYPE_UNSUPPORTEDEnumO tipo de frequência não é compatível.
DAILYEnumAtualize diariamente.
WEEKLYEnumAtualizar toda semana, em dias específicos da semana.
MONTHLYEnumÉ atualizado mensalmente, em determinados dias do mês.

GradientCondition

Métodos

MétodoTipo de retornoBreve descrição
getMaxColorObject()ColorRecebe a cor definida para o valor máximo dessa condição de gradiente.
getMaxType()InterpolationTypeRecebe o tipo de interpolação do valor máximo dessa condição de gradiente.
getMaxValue()StringRecebe o valor máximo dessa condição de gradiente.
getMidColorObject()ColorRecebe a cor definida para o valor do ponto médio dessa condição de gradiente.
getMidType()InterpolationTypeRecebe o tipo de interpolação do valor do ponto médio dessa condição de gradiente.
getMidValue()StringRecebe o valor do ponto médio dessa condição de gradiente.
getMinColorObject()ColorRecebe a cor definida para o valor mínimo dessa condição de gradiente.
getMinType()InterpolationTypeRecebe o tipo de interpolação do valor mínimo dessa condição de gradiente.
getMinValue()StringRecebe o valor mínimo dessa condição de gradiente.

Group

Métodos

MétodoTipo de retornoBreve descrição
collapse()GroupRecolhe o grupo.
expand()GroupExpande este grupo.
getControlIndex()IntegerRetorna o índice de alternância do controle deste grupo.
getDepth()IntegerRetorna a profundidade deste grupo.
getRange()RangeRetorna o intervalo em que este grupo existe.
isCollapsed()BooleanRetornará true se este grupo estiver recolhido.
remove()voidRemove esse grupo da página, reduzindo a profundidade do grupo de range por um.

GroupControlTogglePosition

Propriedades

PropriedadeTipoDescrição
BEFOREEnumA posição em que o botão de controle está antes do grupo (em índices mais baixos).
AFTEREnumA posição em que o botão de controle está depois do grupo (em índices mais altos).

InterpolationType

Propriedades

PropriedadeTipoDescrição
NUMBEREnumUse o número como ponto de interpolação específico para uma condição de gradiente.
PERCENTEnumUse o número como um ponto de interpolação percentual para uma condição de gradiente.
PERCENTILEEnumUse o número como um ponto de interpolação de percentil para uma condição de gradiente.
MINEnumInfira o número mínimo como um ponto de interpolação específico para uma condição de gradiente.
MAXEnumInfira o número máximo como um ponto de interpolação específico para uma condição de gradiente.

NamedRange

Métodos

MétodoTipo de retornoBreve descrição
getName()StringAcessa o nome desse intervalo nomeado.
getRange()RangeRecebe o intervalo referenciado por este intervalo nomeado.
remove()voidExclui este intervalo nomeado.
setName(name)NamedRangeDefine/atualiza o nome do intervalo nomeado.
setRange(range)NamedRangeDefine/atualiza o intervalo deste intervalo nomeado.

OverGridImage

Métodos

MétodoTipo de retornoBreve descrição
assignScript(functionName)OverGridImageAtribui a função com o nome de função especificado a esta imagem.
getAltTextDescription()StringRetorna a descrição de texto alternativo desta imagem.
getAltTextTitle()StringRetorna o título do texto alternativo desta imagem.
getAnchorCell()RangeRetorna a célula em que uma imagem está fixada.
getAnchorCellXOffset()IntegerRetorna o deslocamento horizontal de pixels da célula âncora.
getAnchorCellYOffset()IntegerRetorna o deslocamento vertical do pixel da célula âncora.
getHeight()IntegerRetorna a altura real da imagem em pixels.
getInherentHeight()IntegerRetorna a altura inerente da imagem em pixels.
getInherentWidth()IntegerRetorna a altura inerente da imagem em pixels.
getScript()StringRetorna o nome da função atribuída a esta imagem.
getSheet()SheetRetorna a página em que esta imagem aparece.
getUrl()StringRecebe o URL de origem da imagem. Retorna null se o URL não estiver disponível.
getWidth()IntegerRetorna a largura real da imagem em pixels.
remove()voidExclui esta imagem da planilha.
replace(blob)OverGridImageSubstitui essa imagem pela especificada pelo BlobSource fornecido.
replace(url)OverGridImageSubstitui essa imagem pela do URL especificado.
resetSize()OverGridImageRedefine esta imagem para as dimensões inerentes.
setAltTextDescription(description)OverGridImageDefine a descrição do texto alternativo desta imagem.
setAltTextTitle(title)OverGridImageDefine o título do texto alternativo para esta imagem.
setAnchorCell(cell)OverGridImageDefine a célula em que uma imagem está fixada.
setAnchorCellXOffset(offset)OverGridImageDefine o deslocamento horizontal do pixel da célula âncora.
setAnchorCellYOffset(offset)OverGridImageDefine o deslocamento do pixel vertical da célula âncora.
setHeight(height)OverGridImageDefine a altura real da imagem em pixels.
setWidth(width)OverGridImageDefine a largura real da imagem em pixels.

PageProtection

PivotFilter

Métodos

MétodoTipo de retornoBreve descrição
getFilterCriteria()FilterCriteriaRetorna os critérios para este filtro dinâmico.
getPivotTable()PivotTableRetorna a PivotTable a que este filtro pertence.
getSourceDataColumn()IntegerRetorna o número da coluna de dados de origem em que o filtro opera.
getSourceDataSourceColumn()DataSourceColumnRetorna a coluna da fonte de dados em que o filtro opera.
remove()voidRemove este filtro de tabela dinâmica da tabela dinâmica.
setFilterCriteria(filterCriteria)PivotFilterDefine os critérios para este filtro dinâmico.

PivotGroup

Métodos

MétodoTipo de retornoBreve descrição
addManualGroupingRule(groupName, groupMembers)PivotGroupAdiciona uma regra de agrupamento manual para este grupo dinâmico.
areLabelsRepeated()BooleanRetorna se os rótulos são exibidos como repetidos.
clearGroupingRule()PivotGroupRemove todas as regras de agrupamento deste grupo dinâmico.
clearSort()PivotGroupRemove qualquer classificação aplicada a este grupo.
getDateTimeGroupingRule()DateTimeGroupingRuleRetorna a regra de agrupamento de data e hora no grupo dinâmico ou null se nenhuma regra de agrupamento de data e hora estiver definida.
getDimension()DimensionRetorna se é um grupo de linhas ou colunas.
getGroupLimit()PivotGroupLimitRetorna o limite do grupo dinâmico.
getIndex()IntegerRetorna o índice desse grupo dinâmico na ordem atual do grupo.
getPivotTable()PivotTableRetorna o PivotTable ao qual este agrupamento pertence.
getSourceDataColumn()IntegerRetorna o número da coluna de dados de origem que este grupo resume.
getSourceDataSourceColumn()DataSourceColumnRetorna a coluna da fonte de dados em que o grupo dinâmico opera.
hideRepeatedLabels()PivotGroupOculta os rótulos repetidos para este agrupamento.
isSortAscending()BooleanRetornará true se a classificação estiver em ordem crescente. Retornará false se a ordem de classificação for decrescente.
moveToIndex(index)PivotGroupMove esse grupo para a posição especificada na lista atual de grupos de linhas ou colunas.
remove()voidRemove este grupo dinâmico da tabela.
removeManualGroupingRule(groupName)PivotGroupRemove a regra de agrupamento manual com o groupName especificado.
resetDisplayName()PivotGroupRedefine o nome de exibição deste grupo na tabela dinâmica para o valor padrão.
setDateTimeGroupingRule(dateTimeGroupingRuleType)PivotGroupDefine a regra de agrupamento de data e hora no grupo dinâmico.
setDisplayName(name)PivotGroupDefine o nome de exibição deste grupo na tabela dinâmica.
setGroupLimit(countLimit)PivotGroupDefine o limite do grupo dinâmico.
setHistogramGroupingRule(minValue, maxValue, intervalSize)PivotGroupDefine uma regra de agrupamento de histograma para este grupo dinâmico.
showRepeatedLabels()PivotGroupQuando há mais de um agrupamento de linhas ou colunas, esse método exibe esse rótulo de agrupamento para cada entrada do agrupamento subsequente.
showTotals(showTotals)PivotGroupDefine se os valores totais deste grupo dinâmico serão exibidos na tabela.
sortAscending()PivotGroupDefine a ordem de classificação como crescente.
sortBy(value, oppositeGroupValues)PivotGroupClassifica este grupo pelo PivotValue especificado para os valores de oppositeGroupValues.
sortDescending()PivotGroupDefine a ordem de classificação em ordem decrescente.
totalsAreShown()BooleanRetorna se os valores totais são mostrados para este grupo dinâmico.

PivotGroupLimit

Métodos

MétodoTipo de retornoBreve descrição
getCountLimit()IntegerAcessa o limite de contagem em linhas ou colunas no grupo dinâmico.
getPivotGroup()PivotGroupRetorna o grupo dinâmico ao qual o limite pertence.
remove()voidRemove o limite de grupo dinâmico.
setCountLimit(countLimit)PivotGroupLimitDefine o limite de contagem em linhas ou colunas no grupo dinâmico.

PivotTable

Métodos

MétodoTipo de retornoBreve descrição
addCalculatedPivotValue(name, formula)PivotValueCria um novo valor dinâmico na tabela dinâmica calculado com base no formula especificado com o name especificado.
addColumnGroup(sourceDataColumn)PivotGroupDefine um novo agrupamento de colunas dinâmicas na tabela dinâmica.
addFilter(sourceDataColumn, filterCriteria)PivotFilterCria um novo filtro para a tabela dinâmica.
addPivotValue(sourceDataColumn, summarizeFunction)PivotValueDefine um novo valor dinâmico na tabela dinâmica com o valor summarizeFunction especificado.
addRowGroup(sourceDataColumn)PivotGroupDefine um novo agrupamento de linhas dinâmicas na tabela dinâmica.
asDataSourcePivotTable()DataSourcePivotTableRetorna a tabela dinâmica como uma tabela dinâmica de fonte de dados se a tabela dinâmica estiver vinculada a um DataSource, ou null se não estiver.
getAnchorCell()RangeRetorna a Range que representa a célula em que a tabela dinâmica está fixada.
getColumnGroups()PivotGroup[]Retorna uma lista ordenada dos grupos de colunas nesta tabela dinâmica.
getFilters()PivotFilter[]Retorna uma lista ordenada dos filtros nesta tabela dinâmica.
getPivotValues()PivotValue[]Retorna uma lista ordenada dos valores dinâmicos nesta tabela dinâmica.
getRowGroups()PivotGroup[]Retorna uma lista ordenada dos grupos de linhas nesta tabela dinâmica.
getSourceDataRange()RangeRetorna o intervalo de dados de origem em que a tabela dinâmica é construída.
getValuesDisplayOrientation()DimensionRetorna se os valores são exibidos como linhas ou colunas.
remove()voidExclui esta tabela dinâmica.
setValuesDisplayOrientation(dimension)PivotTableDefine o layout da tabela dinâmica para mostrar valores como colunas ou linhas.

PivotTableSummarizeFunction

Propriedades

PropriedadeTipoDescrição
CUSTOMEnumUma função personalizada, este valor só é válido para campos calculados.
SUMEnuma função SUM;
COUNTAEnuma função COUNTA;
COUNTEnuma função COUNT;
COUNTUNIQUEEnuma função COUNTUNIQUE;
AVERAGEEnumA função Average
MAXEnumA função MAX
MINEnuma função MIN;
MEDIANEnuma função MEDIAN
PRODUCTEnumA função PRODUCT
STDEVEnuma função STDEV;
STDEVPEnuma função STDEVP;
VAREnuma função VAR;
VARPEnuma função VARP

PivotValue

Métodos

MétodoTipo de retornoBreve descrição
getDisplayType()PivotValueDisplayTypeRetorna o tipo de exibição que descreve como esse valor dinâmico é exibido na tabela.
getFormula()StringRetorna a fórmula usada para calcular esse valor.
getPivotTable()PivotTableRetorna o PivotTable ao qual este valor pertence.
getSourceDataColumn()IntegerRetorna o número da coluna de dados de origem que o valor dinâmico resume.
getSourceDataSourceColumn()DataSourceColumnRetorna a coluna da fonte de dados que o valor dinâmico resume.
getSummarizedBy()PivotTableSummarizeFunctionRetorna a função de resumo deste grupo.
remove()voidRemova esse valor da tabela dinâmica.
setDisplayName(name)PivotValueDefine o nome de exibição deste valor na tabela dinâmica.
setFormula(formula)PivotValueDefine a fórmula usada para calcular esse valor.
showAs(displayType)PivotValueExibe esse valor na tabela dinâmica como uma função de outro valor.
summarizeBy(summarizeFunction)PivotValueDefine a função de resumo.

PivotValueDisplayType

Propriedades

PropriedadeTipoDescrição
DEFAULTEnumPadrão:
PERCENT_OF_ROW_TOTALEnumExibe valores dinâmicos como uma porcentagem do total para essa linha.
PERCENT_OF_COLUMN_TOTALEnumExibe valores dinâmicos como uma porcentagem do total para essa coluna.
PERCENT_OF_GRAND_TOTALEnumExibe valores dinâmicos como uma porcentagem do total geral.

Protection

Métodos

MétodoTipo de retornoBreve descrição
addEditor(emailAddress)ProtectionAdiciona o usuário fornecido à lista de editores da página ou ao intervalo protegido.
addEditor(user)ProtectionAdiciona o usuário fornecido à lista de editores da página ou ao intervalo protegido.
addEditors(emailAddresses)ProtectionAdiciona a matriz especificada de usuários à lista de editores para a página ou o intervalo protegido.
addTargetAudience(audienceId)ProtectionAdiciona o público-alvo especificado como um editor do intervalo protegido.
canDomainEdit()BooleanDetermina se todos os usuários no domínio proprietário da planilha têm permissão para editar o intervalo ou a página protegida.
canEdit()BooleanDetermina se o usuário tem permissão para editar o intervalo ou a página protegida.
getDescription()StringRecebe a descrição do intervalo ou da página protegida.
getEditors()User[]Recebe a lista de editores do intervalo ou da página protegida.
getProtectionType()ProtectionTypeRecebe o tipo da área protegida, RANGE ou SHEET.
getRange()RangeRecebe o intervalo que está sendo protegido.
getRangeName()StringAcessa o nome do intervalo protegido se estiver associado a um intervalo nomeado.
getTargetAudiences()TargetAudience[]Retorna os IDs dos públicos-alvo que podem editar o intervalo protegido.
getUnprotectedRanges()Range[]Recebe uma matriz de intervalos não protegidos em uma página protegida.
isWarningOnly()BooleanDetermina se a área protegida está usando a proteção "com base em avisos"
remove()voidDesprotege o intervalo ou a página.
removeEditor(emailAddress)ProtectionRemove o usuário especificado da lista de editores da página ou do intervalo protegido.
removeEditor(user)ProtectionRemove o usuário especificado da lista de editores da página ou do intervalo protegido.
removeEditors(emailAddresses)ProtectionRemove a matriz de usuários especificada da lista de editores da página ou do intervalo protegido.
removeTargetAudience(audienceId)ProtectionRemove o público-alvo especificado como um editor do intervalo protegido.
setDescription(description)ProtectionDefine a descrição do intervalo ou da página protegida.
setDomainEdit(editable)ProtectionDefine se todos os usuários no domínio proprietário da planilha têm permissão para editar o intervalo ou a página protegida.
setNamedRange(namedRange)ProtectionAssocia o intervalo protegido a um intervalo nomeado existente.
setRange(range)ProtectionAjusta o intervalo que está sendo protegido.
setRangeName(rangeName)ProtectionAssocia o intervalo protegido a um intervalo nomeado existente.
setUnprotectedRanges(ranges)ProtectionNão protege a matriz especificada de intervalos em uma página protegida.
setWarningOnly(warningOnly)ProtectionDefine se este intervalo protegido está ou não usando a proteção de "com base em avisos"

ProtectionType

Propriedades

PropriedadeTipoDescrição
RANGEEnumProteção para um intervalo.
SHEETEnumProteção para uma página.

Range

Métodos

MétodoTipo de retornoBreve descrição
activate()RangeDefine o intervalo especificado como o active range, com a célula superior esquerda no intervalo como o current cell.
activateAsCurrentCell()RangeDefine a célula especificada como o current cell.
addDeveloperMetadata(key)RangeAdiciona metadados do desenvolvedor com a chave especificada ao intervalo.
addDeveloperMetadata(key, visibility)RangeAdiciona metadados do desenvolvedor com a chave especificada e a visibilidade do intervalo.
addDeveloperMetadata(key, value)RangeAdiciona metadados do desenvolvedor com a chave e o valor especificados ao intervalo.
addDeveloperMetadata(key, value, visibility)RangeAdiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados ao intervalo.
applyColumnBanding()BandingAplica um tema de faixa de colunas padrão ao intervalo.
applyColumnBanding(bandingTheme)BandingAplica um tema de faixa de colunas especificado ao intervalo.
applyColumnBanding(bandingTheme, showHeader, showFooter)BandingAplica um tema de faixa de colunas especificado ao intervalo com configurações específicas de cabeçalho e rodapé.
applyRowBanding()BandingAplica um tema de faixa de linha padrão ao intervalo.
applyRowBanding(bandingTheme)BandingAplica um tema de faixa de linha especificado ao intervalo.
applyRowBanding(bandingTheme, showHeader, showFooter)BandingAplica um tema de faixa de linha especificado ao intervalo com configurações específicas de cabeçalho e rodapé.
autoFill(destination, series)voidPreenche a destinationRange com dados baseados nos dados desse intervalo.
autoFillToNeighbor(series)voidCalcula um intervalo a ser preenchido com novos dados com base em células vizinhas e preenche automaticamente esse intervalo com novos valores com base nos dados contidos nesse intervalo.
breakApart()RangeDivida as células de várias colunas no intervalo em células individuais novamente.
canEdit()BooleanDetermina se o usuário tem permissão para editar cada célula do intervalo.
check()RangeMuda o estado das caixas de seleção no intervalo para "marcado".
clear()RangeLimpa o intervalo de conteúdo, formatos e regras de validação de dados.
clear(options)RangeLimpa o intervalo de conteúdo, formato, regras de validação de dados e/ou comentários, conforme especificado com as opções avançadas fornecidas.
clearContent()RangeLimpa o conteúdo do intervalo, deixando a formatação intacta.
clearDataValidations()RangeLimpa as regras de validação de dados do intervalo.
clearFormat()RangeLimpa a formatação deste intervalo.
clearNote()RangeLimpa a anotação em uma ou mais células.
collapseGroups()RangeRecolhe todos os grupos que estão totalmente dentro do intervalo.
copyFormatToRange(gridId, column, columnEnd, row, rowEnd)voidCopie a formatação do intervalo para o local especificado.
copyFormatToRange(sheet, column, columnEnd, row, rowEnd)voidCopie a formatação do intervalo para o local especificado.
copyTo(destination)voidCopia os dados de um intervalo de células para outro intervalo de células.
copyTo(destination, copyPasteType, transposed)voidCopia os dados de um intervalo de células para outro intervalo de células.
copyTo(destination, options)voidCopia os dados de um intervalo de células para outro intervalo de células.
copyValuesToRange(gridId, column, columnEnd, row, rowEnd)voidCopie o conteúdo do intervalo no local especificado.
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)voidCopie o conteúdo do intervalo no local especificado.
createDataSourcePivotTable(dataSource)DataSourcePivotTableCria uma tabela dinâmica vazia da fonte de dados, ancorada na primeira célula desse intervalo.
createDataSourceTable(dataSource)DataSourceTableCria uma tabela de fonte de dados vazia da fonte de dados, ancorada na primeira célula nesse intervalo.
createDeveloperMetadataFinder()DeveloperMetadataFinderRetorna uma DeveloperMetadataFinderApi para encontrar metadados de desenvolvedores no escopo desse intervalo.
createFilter()FilterCria um filtro e o aplica ao intervalo especificado na página.
createPivotTable(sourceData)PivotTableCria uma tabela dinâmica vazia com base no sourceData especificado, ancorado na primeira célula nesse intervalo.
createTextFinder(findText)TextFinderCria um localizador para o intervalo, que pode encontrar e substituir texto nesse intervalo.
deleteCells(shiftDimension)voidExclui este intervalo de células.
expandGroups()RangeExpande os grupos recolhidos cujo intervalo ou controle alterna com esse intervalo.
getA1Notation()StringRetorna uma descrição de string do intervalo, em notação A1.
getBackground()StringRetorna a cor do plano de fundo da célula superior esquerda no intervalo (por exemplo, '#ffffff').
getBackgroundObject()ColorRetorna a cor do plano de fundo da célula superior esquerda no intervalo.
getBackgroundObjects()Color[][]Retorna as cores de plano de fundo das células no intervalo.
getBackgrounds()String[][]Retorna as cores de plano de fundo das células no intervalo (por exemplo, '#ffffff').
getBandings()Banding[]Retorna todas as faixas aplicadas a qualquer célula nesse intervalo.
getCell(row, column)RangeRetorna uma determinada célula dentro de um intervalo.
getColumn()IntegerRetorna a posição inicial da coluna desse intervalo.
getDataRegion()RangeRetorna uma cópia do intervalo expandido nos quatro Directions cardinais para cobrir todas as células adjacentes com dados.
getDataRegion(dimension)RangeRetorna uma cópia do intervalo expandido Direction.UP e Direction.DOWN se a dimensão especificada for Dimension.ROWS, ou Direction.NEXT e Direction.PREVIOUS se a dimensão for Dimension.COLUMNS.
getDataSourceFormula()DataSourceFormulaRetorna o DataSourceFormula da primeira célula do intervalo ou null se a célula não tiver uma fórmula de fonte de dados.
getDataSourceFormulas()DataSourceFormula[]Retorna as DataSourceFormulas das células do intervalo.
getDataSourcePivotTables()DataSourcePivotTable[]Recebe todas as tabelas dinâmicas da fonte de dados que cruzam com o intervalo.
getDataSourceTables()DataSourceTable[]Recebe todas as tabelas de fontes de dados que cruzam com o intervalo.
getDataSourceUrl()StringRetorna um URL para os dados nesse intervalo, que pode ser usado para criar gráficos e consultas.
getDataTable()DataTableRetorne os dados dentro desse objeto como uma tabela de dados.
getDataTable(firstRowIsHeader)DataTableRetorne os dados dentro desse intervalo como uma tabela de dados.
getDataValidation()DataValidationRetorna a regra de validação de dados da célula superior esquerda no intervalo.
getDataValidations()DataValidation[][]Retorna as regras de validação de dados de todas as células no intervalo.
getDeveloperMetadata()DeveloperMetadata[]Receba os metadados do desenvolvedor associados a esse intervalo.
getDisplayValue()StringRetorna o valor exibido da célula superior esquerda no intervalo.
getDisplayValues()String[][]Retorna a grade retangular de valores para esse intervalo.
getFilter()FilterRetorna o filtro na página a que esse intervalo pertence ou null se não houver filtro na página.
getFontColorObject()ColorRetorna a cor da fonte da célula no canto superior esquerdo do intervalo.
getFontColorObjects()Color[][]Retorna as cores de fonte das células no intervalo.
getFontFamilies()String[][]Retorna os grupos de fontes das células do intervalo.
getFontFamily()StringRetorna a família de fontes da célula no canto superior esquerdo do intervalo.
getFontLine()StringAcessa o estilo da linha da célula no canto superior esquerdo do intervalo ('underline', 'line-through' ou 'none').
getFontLines()String[][]Recebe o estilo da linha das células no intervalo ('underline', 'line-through' ou 'none').
getFontSize()IntegerRetorna o tamanho da fonte no tamanho do ponto da célula no canto superior esquerdo do intervalo.
getFontSizes()Integer[][]Retorna os tamanhos de fonte das células no intervalo.
getFontStyle()StringRetorna o estilo de fonte ('italic' ou 'normal') da célula no canto superior esquerdo do intervalo.
getFontStyles()String[][]Retorna os estilos de fonte das células no intervalo.
getFontWeight()StringRetorna o peso da fonte (normal/negrito) da célula no canto superior esquerdo do intervalo.
getFontWeights()String[][]Retorna os pesos de fonte das células no intervalo.
getFormula()StringRetorna a fórmula (notação A1) da célula do canto superior esquerdo do intervalo ou uma string vazia se a célula estiver vazia ou não tiver uma fórmula.
getFormulaR1C1()StringRetorna a fórmula (notação R1C1) de uma determinada célula ou null se não houver nenhuma.
getFormulas()String[][]Retorna as fórmulas (notação A1) das células no intervalo.
getFormulasR1C1()String[][]Retorna as fórmulas (notação R1C1) das células no intervalo.
getGridId()IntegerRetorna o ID da grade da página mãe do intervalo.
getHeight()IntegerRetorna a altura do intervalo.
getHorizontalAlignment()StringRetorna o alinhamento horizontal do texto (esquerda/central/direita) da célula no canto superior esquerdo do intervalo.
getHorizontalAlignments()String[][]Retorna os alinhamentos horizontais das células do intervalo.
getLastColumn()IntegerRetorna a posição da coluna final.
getLastRow()IntegerRetorna a posição da linha final.
getMergedRanges()Range[]Retorna uma matriz de objetos Range que representam células mescladas que estão totalmente no intervalo atual ou contêm pelo menos uma célula no intervalo atual.
getNextDataCell(direction)RangeComeçando com a célula na primeira coluna e linha do intervalo, retorna a próxima célula na direção indicada, que é a borda de um intervalo contíguo de células com dados nelas ou a célula na borda da planilha nessa direção.
getNote()StringRetorna a nota associada ao intervalo especificado.
getNotes()String[][]Retorna as notas associadas às células no intervalo.
getNumColumns()IntegerRetorna o número de colunas nesse intervalo.
getNumRows()IntegerRetorna o número de linhas nesse intervalo.
getNumberFormat()StringVeja o formato de número ou de data da célula superior esquerda do intervalo especificado.
getNumberFormats()String[][]Retorna os formatos de número ou data das células no intervalo.
getRichTextValue()RichTextValueRetorna o valor de rich text para a célula superior esquerda do intervalo ou null se o valor da célula não for texto.
getRichTextValues()RichTextValue[][]Retorna os valores de rich text para as células do intervalo.
getRow()IntegerRetorna a posição da linha para esse intervalo.
getRowIndex()IntegerRetorna a posição da linha para esse intervalo.
getSheet()SheetRetorna a página a que este intervalo pertence.
getTextDirection()TextDirectionRetorna a direção do texto da célula superior esquerda do intervalo.
getTextDirections()TextDirection[][]Retorna as rotas de texto das células no intervalo.
getTextRotation()TextRotationRetorna as configurações de rotação de texto da célula superior esquerda do intervalo.
getTextRotations()TextRotation[][]Retorna as configurações de rotação de texto para as células no intervalo.
getTextStyle()TextStyleRetorna o estilo de texto da célula superior esquerda do intervalo.
getTextStyles()TextStyle[][]Retorna os estilos de texto das células no intervalo.
getValue()ObjectRetorna o valor da célula superior esquerda no intervalo.
getValues()Object[][]Retorna a grade retangular de valores para esse intervalo.
getVerticalAlignment()StringRetorna o alinhamento vertical (superior/intermediário/inferior) da célula no canto superior esquerdo do intervalo.
getVerticalAlignments()String[][]Retorna os alinhamentos verticais das células no intervalo.
getWidth()IntegerRetorna a largura do intervalo em colunas.
getWrap()BooleanRetorna se o texto na célula é quebrado.
getWrapStrategies()WrapStrategy[][]Retorna as estratégias de ajuste de texto das células no intervalo.
getWrapStrategy()WrapStrategyRetorna a estratégia de ajuste de texto para a célula superior esquerda do intervalo.
getWraps()Boolean[][]Retorna se o texto nas células é quebrado.
insertCells(shiftDimension)RangeInsere células vazias neste intervalo.
insertCheckboxes()Rangeinsere caixas de seleção em cada célula no intervalo, configurado com true para marcado e false para desmarcado.
insertCheckboxes(checkedValue)Rangeinsere caixas de seleção em cada célula no intervalo, configuradas com um valor personalizado para marcado e a string vazia para desmarcada.
insertCheckboxes(checkedValue, uncheckedValue)Rangeinsere caixas de seleção em cada célula do intervalo, configuradas com valores personalizados para os estados marcados e desmarcadas.
isBlank()BooleanRetornará true se o intervalo estiver totalmente em branco.
isChecked()BooleanRetorna se todas as células no intervalo têm o estado de caixa de seleção como 'checked'.
isEndColumnBounded()BooleanDetermina se o fim do intervalo está vinculado a uma coluna específica.
isEndRowBounded()BooleanDetermina se o fim do intervalo está vinculado a uma linha específica.
isPartOfMerge()BooleanRetornará true se as células no intervalo atual se sobrepuserem a alguma célula mesclada.
isStartColumnBounded()BooleanDetermina se o início do intervalo está vinculado a uma coluna específica.
isStartRowBounded()BooleanDetermina se o início do intervalo está vinculado a uma linha específica.
merge()RangeMescla as células do intervalo em um único bloco.
mergeAcross()RangeMescle as células no intervalo entre as colunas dele.
mergeVertically()RangeMescla as células do intervalo.
moveTo(target)voidRecortar e colar (formato e valores) desse intervalo no intervalo de destino.
offset(rowOffset, columnOffset)RangeRetorna um novo intervalo que é ajustado a esse intervalo pelo número de linhas e colunas fornecido, que pode ser negativo.
offset(rowOffset, columnOffset, numRows)RangeRetorna um novo intervalo relativo ao intervalo atual, cujo ponto superior esquerdo é deslocado do intervalo atual pelas linhas e colunas determinadas e com a altura especificada nas células.
offset(rowOffset, columnOffset, numRows, numColumns)RangeRetorna um novo intervalo relativo ao intervalo atual, cujo ponto superior esquerdo é deslocado do intervalo atual pelas linhas e colunas fornecidas e com a altura e a largura fornecidas nas células.
protect()ProtectionCria um objeto que pode impedir que o intervalo seja editado, exceto por usuários que tenham permissão.
randomize()RangeMostra aleatoriamente a ordem das linhas no intervalo especificado.
removeCheckboxes()RangeRemove todas as caixas de seleção do intervalo.
removeDuplicates()RangeRemove linhas dentro desse intervalo que contêm valores duplicados em qualquer linha anterior.
removeDuplicates(columnsToCompare)RangeRemove linhas dentro desse intervalo que contêm valores nas colunas especificadas que são cópias de valores de qualquer linha anterior.
setBackground(color)RangeDefine a cor de fundo de todas as células no intervalo em notação CSS (como '#ffffff' ou 'white').
setBackgroundObject(color)RangeDefine a cor do plano de fundo de todas as células no intervalo.
setBackgroundObjects(color)RangeDefine uma grade retangular de cores de plano de fundo (precisa corresponder às dimensões deste intervalo).
setBackgroundRGB(red, green, blue)RangeDefine o plano de fundo para a cor especificada usando valores RGB (números inteiros entre 0 e 255, inclusive).
setBackgrounds(color)RangeDefine uma grade retangular de cores de plano de fundo (precisa corresponder às dimensões deste intervalo).
setBorder(top, left, bottom, right, vertical, horizontal)RangeDefine a propriedade de borda.
setBorder(top, left, bottom, right, vertical, horizontal, color, style)RangeDefine a propriedade de borda com cor e/ou estilo.
setDataValidation(rule)RangeDefine uma regra de validação de dados para todas as células no intervalo.
setDataValidations(rules)RangeDefine as regras de validação de dados para todas as células no intervalo.
setFontColor(color)RangeDefine a cor da fonte na notação CSS (como '#ffffff' ou 'white').
setFontColorObject(color)RangeDefine a cor da fonte do intervalo especificado.
setFontColorObjects(colors)RangeDefine uma grade retangular de cores de fonte (precisa corresponder às dimensões deste intervalo).
setFontColors(colors)RangeDefine uma grade retangular de cores de fonte (precisa corresponder às dimensões deste intervalo).
setFontFamilies(fontFamilies)RangeDefine uma grade retangular de famílias de fontes (precisa corresponder às dimensões desse intervalo).
setFontFamily(fontFamily)RangeDefine a família de fontes, como "quot;Arial" ou "DELIMITER"
setFontLine(fontLine)RangeDefine o estilo da linha de fonte do intervalo especificado ('underline', 'line-through' ou 'none').
setFontLines(fontLines)RangeDefine uma grade retangular de estilos de linha (precisa corresponder às dimensões deste intervalo).
setFontSize(size)RangeDefine o tamanho da fonte, sendo o tamanho do ponto a ser usado.
setFontSizes(sizes)RangeDefine uma grade retangular de tamanhos de fonte (precisa corresponder às dimensões deste intervalo).
setFontStyle(fontStyle)RangeDefina o estilo da fonte para o intervalo especificado ('italic' ou 'normal').
setFontStyles(fontStyles)RangeDefine uma grade retangular de estilos de fonte (precisa corresponder às dimensões deste intervalo).
setFontWeight(fontWeight)RangeDefina a espessura da fonte para o intervalo especificado (normal/negrito).
setFontWeights(fontWeights)RangeDefine uma grade retangular de pesos de fontes (precisa corresponder a dimensões deste intervalo).
setFormula(formula)RangeAtualiza a fórmula desse intervalo.
setFormulaR1C1(formula)RangeAtualiza a fórmula desse intervalo.
setFormulas(formulas)RangeDefine uma grade retangular de fórmulas (precisa corresponder às dimensões desse intervalo).
setFormulasR1C1(formulas)RangeDefine uma grade retangular de fórmulas (precisa corresponder às dimensões desse intervalo).
setHorizontalAlignment(alignment)RangeDefina o alinhamento horizontal (da esquerda para a direita) do intervalo especificado (esquerda/central/direita).
setHorizontalAlignments(alignments)RangeDefine uma grade retangular de alinhamentos horizontais.
setNote(note)RangeDefine a anotação como o valor informado.
setNotes(notes)RangeDefine uma grade retangular de notas (precisa corresponder às dimensões desse intervalo).
setNumberFormat(numberFormat)RangeDefine o formato do número ou da data para a string de formatação fornecida.
setNumberFormats(numberFormats)RangeDefine uma grade retangular de formatos de número ou data (precisa corresponder a dimensões desse intervalo).
setRichTextValue(value)RangeDefine o valor de rich text para as células do intervalo.
setRichTextValues(values)RangeDefine uma grade retangular de valores de rich text.
setShowHyperlink(showHyperlink)RangeDefine se o intervalo deve mostrar hiperlinks.
setTextDirection(direction)RangeDefine a direção do texto das células no intervalo.
setTextDirections(directions)RangeDefine uma grade retangular de rotas de texto.
setTextRotation(degrees)RangeDefine as configurações de rotação de texto para as células no intervalo.
setTextRotation(rotation)RangeDefine as configurações de rotação de texto para as células no intervalo.
setTextRotations(rotations)RangeDefine uma grade retangular de rotações de texto.
setTextStyle(style)RangeDefine o estilo de texto das células no intervalo.
setTextStyles(styles)RangeDefine uma grade retangular de estilos de texto.
setValue(value)RangeDefine o valor do intervalo.
setValues(values)RangeDefine uma grade de valores retangulares que precisa corresponder às dimensões desse intervalo.
setVerticalAlignment(alignment)RangeDefina o alinhamento vertical (de cima para baixo) do intervalo especificado (superior/intermediário/inferior).
setVerticalAlignments(alignments)RangeDefine uma grade retangular de alinhamentos verticais (precisa corresponder às dimensões desse intervalo).
setVerticalText(isVertical)RangeDefine se é necessário ou não empilhar o texto das células no intervalo.
setWrap(isWrapEnabled)RangeDefina o wrapper de célula do intervalo fornecido.
setWrapStrategies(strategies)RangeDefine uma grade retangular de estratégias de agrupamento.
setWrapStrategy(strategy)RangeDefine a estratégia de ajuste de texto para as células no intervalo.
setWraps(isWrapEnabled)RangeDefine uma grade retangular de políticas de quebra de palavras (precisa corresponder às dimensões desse intervalo).
shiftColumnGroupDepth(delta)RangeMuda a profundidade do agrupamento de colunas do intervalo de acordo com o valor especificado.
shiftRowGroupDepth(delta)RangeMuda a profundidade do agrupamento de linhas do intervalo pelo valor especificado.
sort(sortSpecObj)RangeClassifica as células no intervalo especificado, por coluna e ordem especificadas.
splitTextToColumns()voidDivide uma coluna de texto em várias colunas com base em um delimitador detectado automaticamente.
splitTextToColumns(delimiter)voidDivide uma coluna de texto em várias colunas usando a string especificada como um delimitador personalizado.
splitTextToColumns(delimiter)voidDivide uma coluna de texto em várias colunas com base no delimitador especificado.
trimWhitespace()RangeCorta o espaço em branco (como espaços, tabulações ou novas linhas) em cada célula desse intervalo.
uncheck()RangeMuda o estado das caixas de seleção no intervalo para "desmarcado".

RangeList

Métodos

MétodoTipo de retornoBreve descrição
activate()RangeListSeleciona a lista de instâncias de Range.
breakApart()RangeListDivida todas as células mescladas horizontal ou verticalmente na lista de intervalos em células individuais novamente.
check()RangeListMuda o estado das caixas de seleção no intervalo para "marcado".
clear()RangeListLimpa o intervalo de conteúdo, formatos e regras de validação de dados para cada Range na lista de intervalos.
clear(options)RangeListLimpa o intervalo de conteúdo, formato, regras de validação de dados e comentários, conforme especificado com as opções fornecidas.
clearContent()RangeListLimpa o conteúdo de cada Range na lista de intervalos, deixando a formatação intacta.
clearDataValidations()RangeListLimpa as regras de validação de dados para cada Range na lista de intervalos.
clearFormat()RangeListLimpa a formatação de texto de cada Range na lista de intervalos.
clearNote()RangeListLimpa a observação para cada Range na lista de intervalos.
getRanges()Range[]Retorna uma lista de uma ou mais instâncias de Range na mesma planilha.
insertCheckboxes()RangeListinsere caixas de seleção em cada célula no intervalo, configurado com true para marcado e false para desmarcado.
insertCheckboxes(checkedValue)RangeListinsere caixas de seleção em cada célula no intervalo, configuradas com um valor personalizado para marcado e a string vazia para desmarcada.
insertCheckboxes(checkedValue, uncheckedValue)RangeListinsere caixas de seleção em cada célula do intervalo, configuradas com valores personalizados para os estados marcados e desmarcadas.
removeCheckboxes()RangeListRemove todas as caixas de seleção do intervalo.
setBackground(color)RangeListDefine a cor do plano de fundo de cada Range na lista de intervalos.
setBackgroundRGB(red, green, blue)RangeListDefine o plano de fundo da cor RGB fornecida.
setBorder(top, left, bottom, right, vertical, horizontal)RangeListDefine a propriedade de borda para cada Range na lista de intervalos.
setBorder(top, left, bottom, right, vertical, horizontal, color, style)RangeListDefine a propriedade de borda com cor e/ou estilo para cada Range na lista de intervalos.
setFontColor(color)RangeListDefine a cor da fonte para cada Range na lista de intervalos.
setFontFamily(fontFamily)RangeListDefine a família de fontes para cada Range na lista de intervalos.
setFontLine(fontLine)RangeListDefine o estilo da linha de fonte de cada Range na lista de intervalos.
setFontSize(size)RangeListDefine o tamanho da fonte (em pontos) para cada Range na lista de intervalos.
setFontStyle(fontStyle)RangeListDefina o estilo de fonte para cada Range na lista de intervalos.
setFontWeight(fontWeight)RangeListDefina a espessura da fonte para cada Range na lista.
setFormula(formula)RangeListAtualiza a fórmula de cada Range na lista de intervalos.
setFormulaR1C1(formula)RangeListAtualiza a fórmula de cada Range na lista de intervalos.
setHorizontalAlignment(alignment)RangeListDefina o alinhamento horizontal de cada Range na lista de intervalos.
setNote(note)RangeListDefine o texto da nota para cada Range na lista.
setNumberFormat(numberFormat)RangeListDefine o formato de número ou de data para cada Range na lista de intervalos.
setShowHyperlink(showHyperlink)RangeListDefine se cada Range da lista de intervalos deve mostrar hiperlinks.
setTextDirection(direction)RangeListDefine a direção do texto das células em cada Range da lista de intervalos.
setTextRotation(degrees)RangeListDefine as configurações de rotação de texto para as células em cada Range na lista de intervalos.
setValue(value)RangeListDefine o valor de cada Range na lista de intervalos.
setVerticalAlignment(alignment)RangeListDefina o alinhamento vertical para cada Range na lista de intervalos.
setVerticalText(isVertical)RangeListDefine se é necessário ou não empilhar o texto das células de cada Range na lista de intervalos.
setWrap(isWrapEnabled)RangeListDefina o ajuste de texto para cada Range na lista.
setWrapStrategy(strategy)RangeListDefine a estratégia de ajuste de texto para cada Range na lista de intervalos.
trimWhitespace()RangeListCorta o espaço em branco (como espaços, tabulações ou novas linhas) em cada célula da lista.
uncheck()RangeListMuda o estado das caixas de seleção no intervalo para "desmarcado".

RecalculationInterval

Propriedades

PropriedadeTipoDescrição
ON_CHANGEEnumRecalcular somente quando os valores forem alterados.
MINUTEEnumRecalcular quando os valores são alterados e a cada minuto.
HOUREnumRecalcular quando os valores forem alterados e a cada hora.

RelativeDate

Propriedades

PropriedadeTipoDescrição
TODAYEnumDatas em comparação com a data atual.
TOMORROWEnumDatas em comparação com a data posterior à atual.
YESTERDAYEnumDatas em comparação com a data anterior à atual.
PAST_WEEKEnumDatas no período da semana passada.
PAST_MONTHEnumDatas do último mês.
PAST_YEAREnumDatas no período do ano passado.

RichTextValue

Métodos

MétodoTipo de retornoBreve descrição
copy()RichTextValueBuilderRetorna um builder para um valor de rich text inicializado com os valores desse valor de rich text.
getEndIndex()IntegerRecebe o índice final desse valor na célula.
getLinkUrl()StringRetorna o URL do link para esse valor.
getLinkUrl(startOffset, endOffset)StringRetorna o URL do link do texto de startOffset a endOffset.
getRuns()RichTextValue[]Retorna a string rich text dividida em uma matriz de execuções, em que cada execução é a substring mais longa possível com um estilo de texto consistente.
getStartIndex()IntegerRecebe o índice inicial desse valor na célula.
getText()StringRetorna o texto desse valor.
getTextStyle()TextStyleRetorna o estilo de texto desse valor.
getTextStyle(startOffset, endOffset)TextStyleRetorna o estilo do texto de startOffset para endOffset.

RichTextValueBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()RichTextValueCria um valor de rich text do builder.
setLinkUrl(startOffset, endOffset, linkUrl)RichTextValueBuilderDefine o URL do link para a substring especificada desse valor ou limpa-o se linkUrl for null.
setLinkUrl(linkUrl)RichTextValueBuilderDefine o URL do link para todo o valor ou o limpa se linkUrl for null.
setText(text)RichTextValueBuilderDefine o texto desse valor e limpa qualquer estilo de texto existente.
setTextStyle(startOffset, endOffset, textStyle)RichTextValueBuilderAplica um estilo de texto à substring especificada desse valor.
setTextStyle(textStyle)RichTextValueBuilderAplica um estilo de texto a todo o valor.

Selection

Métodos

MétodoTipo de retornoBreve descrição
getActiveRange()RangeRetorna o intervalo selecionado na página ativa ou null se não houver um intervalo ativo.
getActiveRangeList()RangeListRetorna a lista de intervalos ativos na página ativa ou null se não houver intervalos ativos.
getActiveSheet()SheetRetorna a planilha ativa na planilha.
getCurrentCell()RangeRetorna a célula atual (em destaque) que está selecionada em um dos intervalos ativos ou null se não houver uma célula atual.
getNextDataRange(direction)RangeComeçando com current cell e active range e movendo na direção especificada, retorna um intervalo ajustado em que a borda adequada do intervalo foi alterada para cobrir o next data cell enquanto ainda cobre a célula atual.

Sheet

Métodos

MétodoTipo de retornoBreve descrição
activate()SheetAtiva esta página.
addDeveloperMetadata(key)SheetAdiciona metadados de desenvolvedor com a chave especificada à página.
addDeveloperMetadata(key, visibility)SheetAdiciona metadados do desenvolvedor com a chave e a visibilidade especificadas à página.
addDeveloperMetadata(key, value)SheetAdiciona metadados do desenvolvedor com a chave e o valor especificados à página.
addDeveloperMetadata(key, value, visibility)SheetAdiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados à página.
appendRow(rowContents)SheetAnexa uma linha à parte inferior da região de dados atual na página.
asDataSourceSheet()DataSourceSheetRetornará a planilha como DataSourceSheet se ela for do tipo SheetType.DATASOURCE. Caso contrário, retornará null.
autoResizeColumn(columnPosition)SheetDefine a largura da coluna especificada para se ajustar ao conteúdo.
autoResizeColumns(startColumn, numColumns)SheetDefine a largura de todas as colunas começando na posição da coluna especificada para ajustar o conteúdo.
autoResizeRows(startRow, numRows)SheetDefine a altura de todas as linhas a partir da posição da linha específica de acordo com o conteúdo delas.
clear()SheetLimpa a página de conteúdo e informações de formatação.
clear(options)SheetLimpa o sumário e/ou o formato, conforme especificado com as opções avançadas fornecidas.
clearConditionalFormatRules()voidRemove todas as regras de formato condicional da página.
clearContents()SheetLimpa o índice, preservando as informações de formatação.
clearFormats()SheetLimpa a página de formatação, preservando o conteúdo.
clearNotes()SheetLimpa a página de todas as notas.
collapseAllColumnGroups()SheetRecolhe todos os grupos de colunas na página.
collapseAllRowGroups()SheetRecolhe todos os grupos de linhas na página.
copyTo(spreadsheet)SheetCopia a página para uma determinada planilha, que pode ser a mesma da fonte.
createDeveloperMetadataFinder()DeveloperMetadataFinderRetorna um DeveloperMetadataFinder para encontrar metadados do desenvolvedor no escopo desta página.
createTextFinder(findText)TextFinderCriar um localizador para a página, que pode encontrar e substituir o texto dela.
deleteColumn(columnPosition)SheetExclui a coluna na posição da coluna especificada.
deleteColumns(columnPosition, howMany)voidExclui várias colunas que começam na posição especificada.
deleteRow(rowPosition)SheetExclui a linha na posição da linha especificada.
deleteRows(rowPosition, howMany)voidExclui várias linhas que começam na posição da linha especificada.
expandAllColumnGroups()SheetAbre todos os grupos de colunas na página.
expandAllRowGroups()SheetAbre todos os grupos de linhas na página.
expandColumnGroupsUpToDepth(groupDepth)SheetAbre todos os grupos de colunas até a profundidade especificada e recolhe todos os outros.
expandRowGroupsUpToDepth(groupDepth)SheetExpande todos os grupos de linhas até a profundidade especificada e recolhe todos os outros.
getActiveCell()RangeRetorna a célula ativa nesta página.
getActiveRange()RangeRetorna o intervalo selecionado na página ativa ou null se não houver um intervalo ativo.
getActiveRangeList()RangeListRetorna a lista de intervalos ativos na página ativa ou null se não houver intervalos ativos.
getBandings()Banding[]Retorna todas as faixas nesta página.
getCharts()EmbeddedChart[]Retorna uma matriz de gráficos nesta página.
getColumnGroup(columnIndex, groupDepth)GroupRetorna o grupo da coluna no índice e profundidade de grupo fornecidos.
getColumnGroupControlPosition()GroupControlTogglePositionRetorna GroupControlTogglePosition para todos os grupos de colunas na página.
getColumnGroupDepth(columnIndex)IntegerRetorna a profundidade do grupo da coluna no índice especificado.
getColumnWidth(columnPosition)IntegerAcessa a largura em pixels da coluna especificada.
getConditionalFormatRules()ConditionalFormatRule[]Veja todas as regras de formatação condicional nesta página.
getCurrentCell()RangeRetorna a célula atual na página ativa ou null se não houver uma célula atual.
getDataRange()RangeRetorna um Range correspondente às dimensões em que os dados estão presentes.
getDataSourceFormulas()DataSourceFormula[]Recebe todas as fórmulas da fonte de dados.
getDataSourcePivotTables()DataSourcePivotTable[]Recebe todas as tabelas dinâmicas da fonte de dados.
getDataSourceTables()DataSourceTable[]Acessa todas as tabelas de fontes de dados.
getDeveloperMetadata()DeveloperMetadata[]Veja todos os metadados do desenvolvedor associados a esta página.
getDrawings()Drawing[]Retorna uma matriz de desenhos na página.
getFilter()FilterRetorna o filtro nesta página ou null se não houver filtro.
getFormUrl()StringRetorna o URL do formulário que envia as respostas a esta página ou null se a página não tiver um formulário associado.
getFrozenColumns()IntegerRetorna o número de colunas congeladas.
getFrozenRows()IntegerRetorna o número de linhas congeladas.
getImages()OverGridImage[]Retorna todas as imagens da grade na página.
getIndex()IntegerAcessa a posição da planilha na planilha mãe.
getLastColumn()IntegerRetorna a posição da última coluna que tem conteúdo.
getLastRow()IntegerRetorna a posição da última linha que possui conteúdo.
getMaxColumns()IntegerRetorna o número atual de colunas na página, independentemente do conteúdo.
getMaxRows()IntegerRetorna o número atual de linhas na página, independentemente do conteúdo.
getName()StringRetorna o nome da página.
getNamedRanges()NamedRange[]Recebe todos os intervalos nomeados nesta página.
getParent()SpreadsheetRetorna o Spreadsheet que contém esta página.
getPivotTables()PivotTable[]Retorna todas as tabelas dinâmicas nesta página.
getProtections(type)Protection[]Recebe uma matriz de objetos que representam todos os intervalos protegidos na página ou uma matriz de um único elemento que representa a proteção na própria página.
getRange(row, column)RangeRetorna o intervalo com a célula superior esquerda nas coordenadas especificadas.
getRange(row, column, numRows)RangeRetorna o intervalo com a célula superior esquerda nas coordenadas especificadas e com o número de linhas especificado.
getRange(row, column, numRows, numColumns)RangeRetorna o intervalo com a célula superior esquerda nas coordenadas especificadas com o número especificado de linhas e colunas.
getRange(a1Notation)RangeRetorna o intervalo conforme especificado na notação A1 ou R1C1.
getRangeList(a1Notations)RangeListRetorna a coleção RangeList que representa os intervalos na mesma planilha especificada por uma lista não vazia de notações A1 ou R1C1.
getRowGroup(rowIndex, groupDepth)GroupRetorna o grupo de linhas com o índice e a profundidade de grupo especificados.
getRowGroupControlPosition()GroupControlTogglePositionRetorna GroupControlTogglePosition para todos os grupos de linhas na página.
getRowGroupDepth(rowIndex)IntegerRetorna a profundidade do grupo da linha no índice especificado.
getRowHeight(rowPosition)IntegerRecebe a altura em pixels da linha especificada.
getSelection()SelectionRetorna o Selection atual na planilha.
getSheetId()IntegerRetorna o ID da planilha representada por este objeto.
getSheetName()StringRetorna o nome da página.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Retorna a grade retangular de valores para esse intervalo a partir das coordenadas fornecidas.
getSlicers()Slicer[]Retorna uma matriz de fatiadores na página.
getTabColorObject()ColorRecebe a cor da guia da página ou null se a guia da página não tiver cor.
getType()SheetTypeRetorna o tipo da página.
hasHiddenGridlines()BooleanRetorna true se as linhas de grade da página estiverem ocultas. Caso contrário, retorna false.
hideColumn(column)voidOculta a coluna ou os intervalos no intervalo especificado.
hideColumns(columnIndex)voidOculta uma única coluna no índice especificado.
hideColumns(columnIndex, numColumns)voidOculta uma ou mais colunas consecutivas começando no índice especificado.
hideRow(row)voidOculta as linhas no intervalo especificado.
hideRows(rowIndex)voidOculta a linha no índice especificado.
hideRows(rowIndex, numRows)voidOculta uma ou mais linhas consecutivas começando no índice especificado.
hideSheet()SheetOculta esta página.
insertChart(chart)voidAdiciona um novo gráfico a esta página.
insertColumnAfter(afterPosition)Sheetinsere uma coluna após a posição especificada da coluna.
insertColumnBefore(beforePosition)Sheetinsere uma coluna antes da posição da coluna especificada.
insertColumns(columnIndex)voidinsere uma coluna em branco em uma página no local especificado.
insertColumns(columnIndex, numColumns)voidinsere uma ou mais colunas em branco consecutivas em uma página começando no local especificado.
insertColumnsAfter(afterPosition, howMany)Sheetinsere uma série de colunas após a posição da coluna especificada.
insertColumnsBefore(beforePosition, howMany)Sheetinsere uma série de colunas antes da posição da coluna especificada.
insertImage(blobSource, column, row)OverGridImageinsere uma BlobSource como uma imagem no documento em uma determinada linha e coluna.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageInsere um BlobSource como uma imagem no documento em uma determinada linha e coluna, com um deslocamento de pixel.
insertImage(url, column, row)OverGridImageInsere uma imagem no documento em uma determinada linha e coluna.
insertImage(url, column, row, offsetX, offsetY)OverGridImageInsere uma imagem no documento em uma determinada linha e coluna com um deslocamento de pixel.
insertRowAfter(afterPosition)SheetInsere uma linha após a posição da linha fornecida.
insertRowBefore(beforePosition)SheetInsere uma linha antes da posição de linha fornecida.
insertRows(rowIndex)voidInsere uma linha em branco em uma planilha no local especificado.
insertRows(rowIndex, numRows)voidinsere uma ou mais linhas em branco consecutivas em uma página a partir do local especificado.
insertRowsAfter(afterPosition, howMany)Sheetinsere uma série de linhas após a posição da linha especificada.
insertRowsBefore(beforePosition, howMany)Sheetinsere uma série de linhas antes da posição da linha especificada.
insertSlicer(range, anchorRowPos, anchorColPos)SlicerAdiciona um novo controle de filtros a esta página.
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)SlicerAdiciona um novo controle de filtros a esta página.
isColumnHiddenByUser(columnPosition)BooleanRetorna se a coluna especificada está oculta pelo usuário.
isRightToLeft()BooleanRetorna true se o layout dessa página for da direita para a esquerda.
isRowHiddenByFilter(rowPosition)BooleanRetorna se a linha especificada está oculta por um filtro (não por uma visualização de filtro).
isRowHiddenByUser(rowPosition)BooleanRetorna se a linha especificada está oculta pelo usuário.
isSheetHidden()BooleanRetornará true se a página estiver oculta.
moveColumns(columnSpec, destinationIndex)voidMove as colunas selecionadas pelo intervalo especificado para a posição indicada pelo destinationIndex.
moveRows(rowSpec, destinationIndex)voidMove as linhas selecionadas pelo intervalo especificado para a posição indicada pelo destinationIndex.
newChart()EmbeddedChartBuilderRetorna um builder para criar um novo gráfico para esta página.
protect()ProtectionCria um objeto que pode impedir a edição da página, exceto por usuários com permissão.
removeChart(chart)voidRemove um gráfico da página principal.
setActiveRange(range)RangeDefine o intervalo especificado como active range na página ativa, com a célula superior esquerda no intervalo como current cell.
setActiveRangeList(rangeList)RangeListDefine a lista de intervalos especificada como active ranges na página ativa.
setActiveSelection(range)RangeDefine a região de seleção ativa desta página.
setActiveSelection(a1Notation)RangeDefine a seleção ativa, conforme especificado nas anotações A1 ou R1C1.
setColumnGroupControlPosition(position)SheetDefine a posição do botão de controle do grupo de colunas na página.
setColumnWidth(columnPosition, width)SheetDefine a largura da coluna especificada em pixels.
setColumnWidths(startColumn, numColumns, width)SheetDefine a largura das colunas fornecidas em pixels.
setConditionalFormatRules(rules)voidSubstitui todas as regras de formatação condicional existentes na planilha pelas regras de entrada.
setCurrentCell(cell)RangeDefine a célula especificada como o current cell.
setFrozenColumns(columns)voidCongela o número especificado de colunas.
setFrozenRows(rows)voidCongela o número de linhas especificado.
setHiddenGridlines(hideGridlines)SheetOculta ou revela as linhas de grade da página.
setName(name)SheetDefine o nome da planilha.
setRightToLeft(rightToLeft)SheetDefine ou cancela a configuração do layout da página da direita para a esquerda.
setRowGroupControlPosition(position)SheetDefine a posição do botão para controlar o grupo de linhas na página.
setRowHeight(rowPosition, height)SheetDefine a altura da linha em pixels.
setRowHeights(startRow, numRows, height)SheetDefine a altura das linhas fornecidas em pixels.
setRowHeightsForced(startRow, numRows, height)SheetDefine a altura das linhas fornecidas em pixels.
setTabColor(color)SheetDefine a cor da guia da página.
setTabColorObject(color)SheetDefine a cor da guia da página.
showColumns(columnIndex)voidExibe a coluna no índice especificado.
showColumns(columnIndex, numColumns)voidExibe uma ou mais colunas consecutivas começando no índice especificado.
showRows(rowIndex)voidExibe a linha no índice especificado.
showRows(rowIndex, numRows)voidReexibe uma ou mais linhas consecutivas começando no índice especificado.
showSheet()SheetTorna a página visível.
sort(columnPosition)SheetClassifica uma página por coluna em ordem crescente.
sort(columnPosition, ascending)SheetClassifica uma página por coluna.
unhideColumn(column)voidExibe a coluna no intervalo especificado.
unhideRow(row)voidExibe a linha no intervalo especificado.
updateChart(chart)voidAtualiza o gráfico nesta página.

SheetType

Propriedades

PropriedadeTipoDescrição
GRIDEnumUma página com uma grade.
OBJECTEnumUma página contendo um único objeto incorporado, como um EmbeddedChart.
DATASOURCEEnumUma página contendo um DataSource.

Slicer

Métodos

MétodoTipo de retornoBreve descrição
getBackgroundColorObject()ColorRetorne o segundo plano Color do controle de filtros.
getColumnPosition()IntegerRetorna a posição da coluna (relativa ao intervalo de dados do controle de filtros) em que o filtro é aplicado no controle de filtros ou null se a posição da coluna não estiver definida.
getContainerInfo()ContainerInfoRecebe informações sobre onde o controle de filtros está posicionado na página.
getFilterCriteria()FilterCriteriaRetorna o critério do filtro do controle de filtros ou null se os critérios de filtro não estiverem definidos.
getRange()RangeRecebe o intervalo de dados ao qual o controle de filtros é aplicado.
getTitle()StringRetorna o título do controle de filtros.
getTitleHorizontalAlignment()StringRecebe o alinhamento horizontal do título.
getTitleTextStyle()TextStyleRetorna o estilo de texto do título do controle de filtros.
isAppliedToPivotTables()BooleanRetorna se o controle de filtros fornecido é aplicado a tabelas dinâmicas.
remove()voidExclui o controle de filtros.
setApplyToPivotTables(applyToPivotTables)SlicerDefine se o controle de qualidade específico deve ser aplicado a tabelas dinâmicas na planilha.
setBackgroundColor(color)SlicerDefine a cor do plano de fundo do controle de filtros.
setBackgroundColorObject(color)SlicerDefine o segundo plano Color do controle de filtros.
setColumnFilterCriteria(columnPosition, filterCriteria)SlicerDefine o índice de colunas e os critérios de filtragem do controle de filtros.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)SlicerDefine a posição em que o controle de filtros é exibido na página.
setRange(rangeApi)SlicerDefine o intervalo de dados em que o controle de filtros é aplicado.
setTitle(title)SlicerDefine o título do controle de filtros.
setTitleHorizontalAlignment(horizontalAlignment)SlicerDefine o alinhamento horizontal do título no controle de filtros.
setTitleTextStyle(textStyle)SlicerDefine o estilo de texto do controle de filtros.

SortOrder

Propriedades

PropriedadeTipoDescrição
ASCENDINGEnumOrdem de classificação crescente.
DESCENDINGEnumOrdem de classificação decrescente.

SortSpec

Métodos

MétodoTipo de retornoBreve descrição
getBackgroundColor()ColorRetorna a cor de fundo usada para classificação, ou null se ausente.
getDataSourceColumn()DataSourceColumnRecebe a coluna da fonte de dados em que a especificação da classificação age.
getDimensionIndex()IntegerRetorna o índice da dimensão ou null se não estiver vinculado a um filtro local.
getForegroundColor()ColorRetorna a cor do primeiro plano usada para classificação, ou null se ausente.
getSortOrder()SortOrderRetorna a ordem de classificação.
isAscending()BooleanRetorna se a ordem de classificação é crescente.

Spreadsheet

Métodos

MétodoTipo de retornoBreve descrição
addDeveloperMetadata(key)SpreadsheetAdiciona metadados de desenvolvedor com a chave especificada à planilha de nível superior.
addDeveloperMetadata(key, visibility)SpreadsheetAdiciona metadados de desenvolvedor com a chave especificada e a visibilidade da planilha.
addDeveloperMetadata(key, value)SpreadsheetAdiciona metadados de desenvolvedor com a chave e o valor especificados à planilha.
addDeveloperMetadata(key, value, visibility)SpreadsheetAdiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados à planilha.
addEditor(emailAddress)SpreadsheetAdiciona o usuário especificado à lista de editores de Spreadsheet.
addEditor(user)SpreadsheetAdiciona o usuário especificado à lista de editores de Spreadsheet.
addEditors(emailAddresses)SpreadsheetAdiciona a matriz especificada de usuários à lista de editores de Spreadsheet.
addMenu(name, subMenus)voidCria um novo menu na IU da planilha.
addViewer(emailAddress)SpreadsheetAdiciona o usuário especificado à lista de visualizadores do Spreadsheet.
addViewer(user)SpreadsheetAdiciona o usuário especificado à lista de visualizadores do Spreadsheet.
addViewers(emailAddresses)SpreadsheetAdiciona a matriz de usuários especificada à lista de visualizadores de Spreadsheet.
appendRow(rowContents)SheetAnexa uma linha à parte inferior da região de dados atual na página.
autoResizeColumn(columnPosition)SheetDefine a largura da coluna especificada para se ajustar ao conteúdo.
copy(name)SpreadsheetCopia a planilha e retorna a nova.
createDeveloperMetadataFinder()DeveloperMetadataFinderRetorna um DeveloperMetadataFinder para encontrar metadados do desenvolvedor no escopo desta planilha.
createTextFinder(findText)TextFinderCriar um localizador para a planilha, que pode ser usada para encontrar e substituir texto nela.
deleteActiveSheet()SheetExclui a página ativa no momento.
deleteColumn(columnPosition)SheetExclui a coluna na posição da coluna especificada.
deleteColumns(columnPosition, howMany)voidExclui várias colunas que começam na posição especificada.
deleteRow(rowPosition)SheetExclui a linha na posição da linha especificada.
deleteRows(rowPosition, howMany)voidExclui várias linhas que começam na posição da linha especificada.
deleteSheet(sheet)voidExclui a página especificada.
duplicateActiveSheet()SheetDuplica a página ativa e a torna ativa.
getActiveCell()RangeRetorna a célula ativa nesta página.
getActiveRange()RangeRetorna o intervalo selecionado na página ativa ou null se não houver um intervalo ativo.
getActiveRangeList()RangeListRetorna a lista de intervalos ativos na página ativa ou null se não houver intervalos ativos.
getActiveSheet()SheetRecebe a planilha ativa em uma planilha.
getAs(contentType)BlobRetorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBandings()Banding[]Retorna todas as faixas nesta planilha.
getBlob()BlobRetorne os dados dentro desse objeto como um blob.
getColumnWidth(columnPosition)IntegerAcessa a largura em pixels da coluna especificada.
getCurrentCell()RangeRetorna a célula atual na página ativa ou null se não houver uma célula atual.
getDataRange()RangeRetorna um Range correspondente às dimensões em que os dados estão presentes.
getDataSourceFormulas()DataSourceFormula[]Recebe todas as fórmulas da fonte de dados.
getDataSourcePivotTables()DataSourcePivotTable[]Recebe todas as tabelas dinâmicas da fonte de dados.
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]Recebe as programações de atualização da planilha.
getDataSourceSheets()DataSourceSheet[]Retorna todas as planilhas de fonte de dados na planilha.
getDataSourceTables()DataSourceTable[]Acessa todas as tabelas de fontes de dados.
getDataSources()DataSource[]Retorna todas as fontes de dados na planilha.
getDeveloperMetadata()DeveloperMetadata[]Receba os metadados do desenvolvedor associados à planilha de nível superior.
getEditors()User[]Recebe a lista de editores desse Spreadsheet.
getFormUrl()StringRetorna o URL do formulário que envia as respostas a esta planilha ou null se a planilha não tiver um formulário associado.
getFrozenColumns()IntegerRetorna o número de colunas congeladas.
getFrozenRows()IntegerRetorna o número de linhas congeladas.
getId()StringRecebe um identificador exclusivo para essa planilha.
getImages()OverGridImage[]Retorna todas as imagens da grade na página.
getIterativeCalculationConvergenceThreshold()NumberRetorna o valor do limite usado durante o cálculo iterativo.
getLastColumn()IntegerRetorna a posição da última coluna que tem conteúdo.
getLastRow()IntegerRetorna a posição da última linha que possui conteúdo.
getMaxIterativeCalculationCycles()IntegerRetorna o número máximo de iterações a serem usadas durante o cálculo iterativo.
getName()StringRecebe o nome do documento.
getNamedRanges()NamedRange[]Acessa todos os intervalos nomeados nesta planilha.
getNumSheets()IntegerRetorna o número de páginas nesta planilha.
getOwner()UserRetorna o proprietário do documento ou null para um documento em um drive compartilhado.
getPredefinedSpreadsheetThemes()SpreadsheetTheme[]Retorna a lista de temas predefinidos.
getProtections(type)Protection[]Recebe uma matriz de objetos que representam todos os intervalos ou páginas protegidos na planilha.
getRange(a1Notation)RangeRetorna o intervalo conforme especificado na notação A1 ou R1C1.
getRangeByName(name)RangeRetornará um intervalo nomeado ou null se nenhum intervalo com o nome fornecido for encontrado.
getRangeList(a1Notations)RangeListRetorna a coleção RangeList que representa os intervalos na mesma planilha especificada por uma lista não vazia de notações A1 ou R1C1.
getRecalculationInterval()RecalculationIntervalRetorna o intervalo de cálculo desta planilha.
getRowHeight(rowPosition)IntegerRecebe a altura em pixels da linha especificada.
getSelection()SelectionRetorna o Selection atual na planilha.
getSheetByName(name)SheetRetorna uma página com o nome informado.
getSheetId()IntegerRetorna o ID da planilha representada por este objeto.
getSheetName()StringRetorna o nome da página.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Retorna a grade retangular de valores para esse intervalo a partir das coordenadas fornecidas.
getSheets()Sheet[]Recebe todas as planilhas desta planilha.
getSpreadsheetLocale()StringRecebe a localidade da planilha.
getSpreadsheetTheme()SpreadsheetThemeRetorna o tema atual da planilha ou null se nenhum tema for aplicado.
getSpreadsheetTimeZone()StringRecebe o fuso horário da planilha.
getUrl()StringRetorna o URL da planilha especificada.
getViewers()User[]Recebe a lista de espectadores e comentaristas deste Spreadsheet.
hideColumn(column)voidOculta a coluna ou os intervalos no intervalo especificado.
hideRow(row)voidOculta as linhas no intervalo especificado.
insertColumnAfter(afterPosition)Sheetinsere uma coluna após a posição especificada da coluna.
insertColumnBefore(beforePosition)Sheetinsere uma coluna antes da posição da coluna especificada.
insertColumnsAfter(afterPosition, howMany)Sheetinsere uma série de colunas após a posição da coluna especificada.
insertColumnsBefore(beforePosition, howMany)Sheetinsere uma série de colunas antes da posição da coluna especificada.
insertDataSourceSheet(spec)DataSourceSheetinsere uma nova DataSourceSheet na planilha e inicia a execução de dados.
insertImage(blobSource, column, row)OverGridImageinsere uma Spreadsheet como uma imagem no documento em uma determinada linha e coluna.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageInsere um Spreadsheet como uma imagem no documento em uma determinada linha e coluna, com um deslocamento de pixel.
insertImage(url, column, row)OverGridImageInsere uma imagem no documento em uma determinada linha e coluna.
insertImage(url, column, row, offsetX, offsetY)OverGridImageInsere uma imagem no documento em uma determinada linha e coluna com um deslocamento de pixel.
insertRowAfter(afterPosition)SheetInsere uma linha após a posição da linha fornecida.
insertRowBefore(beforePosition)SheetInsere uma linha antes da posição de linha fornecida.
insertRowsAfter(afterPosition, howMany)Sheetinsere uma série de linhas após a posição da linha especificada.
insertRowsBefore(beforePosition, howMany)Sheetinsere uma série de linhas antes da posição da linha especificada.
insertSheet()SheetInsere uma nova página na planilha, usando um nome de página padrão.
insertSheet(sheetIndex)SheetInsere uma nova página na planilha no índice especificado.
insertSheet(sheetIndex, options)Sheetinsere uma nova página na planilha no índice especificado e usa argumentos avançados opcionais.
insertSheet(options)Sheetinsere uma nova página na planilha, usando um nome de planilha padrão e argumentos avançados opcionais.
insertSheet(sheetName)Sheetinsere uma nova página com o nome fornecido na planilha.
insertSheet(sheetName, sheetIndex)Sheetinsere uma nova página na planilha com o nome informado no índice especificado.
insertSheet(sheetName, sheetIndex, options)Sheetinsere uma nova página na planilha com o nome especificado no índice especificado e usa argumentos avançados opcionais.
insertSheet(sheetName, options)Sheetinsere uma nova planilha na planilha com o nome fornecido e usa argumentos avançados opcionais.
insertSheetWithDataSourceTable(spec)Sheetinsere uma nova página na planilha, cria um DataSourceTable que abrange toda a planilha com a especificação da fonte de dados fornecida e inicia a execução dos dados;
isColumnHiddenByUser(columnPosition)BooleanRetorna se a coluna especificada está oculta pelo usuário.
isIterativeCalculationEnabled()BooleanRetorna se o cálculo de iteração está ativado nesta planilha.
isRowHiddenByFilter(rowPosition)BooleanRetorna se a linha especificada está oculta por um filtro (não por uma visualização de filtro).
isRowHiddenByUser(rowPosition)BooleanRetorna se a linha especificada está oculta pelo usuário.
moveActiveSheet(pos)voidMove a página ativa para a posição especificada na lista de páginas.
moveChartToObjectSheet(chart)SheetCria uma nova página SheetType.OBJECT e move o gráfico fornecido para ela.
refreshAllDataSources()voidAtualiza todas as fontes de dados compatíveis e os objetos de fonte de dados vinculados, ignorando objetos inválidos.
removeEditor(emailAddress)SpreadsheetRemove o usuário especificado da lista de editores para o Spreadsheet.
removeEditor(user)SpreadsheetRemove o usuário especificado da lista de editores para o Spreadsheet.
removeMenu(name)voidRemove um menu adicionado por addMenu(name, subMenus).
removeNamedRange(name)voidExclui um intervalo nomeado com o nome informado.
removeViewer(emailAddress)SpreadsheetRemove o usuário em questão da lista de leitores e comentaristas do Spreadsheet.
removeViewer(user)SpreadsheetRemove o usuário em questão da lista de leitores e comentaristas do Spreadsheet.
rename(newName)voidRenomeia o documento.
renameActiveSheet(newName)voidRenomeia a página ativa atual com o novo nome.
resetSpreadsheetTheme()SpreadsheetThemeRemove o tema aplicado e define o tema padrão na planilha.
setActiveRange(range)RangeDefine o intervalo especificado como active range na página ativa, com a célula superior esquerda no intervalo como current cell.
setActiveRangeList(rangeList)RangeListDefine a lista de intervalos especificada como active ranges na página ativa.
setActiveSelection(range)RangeDefine a região de seleção ativa desta página.
setActiveSelection(a1Notation)RangeDefine a seleção ativa, conforme especificado nas anotações A1 ou R1C1.
setActiveSheet(sheet)SheetDefine a página específica como ativa na planilha.
setActiveSheet(sheet, restoreSelection)SheetDefine a página especificada como ativa na planilha, com a opção de restaurar a seleção mais recente nela.
setColumnWidth(columnPosition, width)SheetDefine a largura da coluna especificada em pixels.
setCurrentCell(cell)RangeDefine a célula especificada como o current cell.
setFrozenColumns(columns)voidCongela o número especificado de colunas.
setFrozenRows(rows)voidCongela o número de linhas especificado.
setIterativeCalculationConvergenceThreshold(minThreshold)SpreadsheetDefine o valor limite mínimo para o cálculo iterativo.
setIterativeCalculationEnabled(isEnabled)SpreadsheetDefine se o cálculo iterativo está ativado nesta planilha.
setMaxIterativeCalculationCycles(maxIterations)SpreadsheetDefine o número máximo de iterações de cálculo que precisam ser realizadas durante o cálculo iterativo.
setNamedRange(name, range)voidNomeia um intervalo.
setRecalculationInterval(recalculationInterval)SpreadsheetDefine com que frequência a planilha será recalculada.
setRowHeight(rowPosition, height)SheetDefine a altura da linha em pixels.
setSpreadsheetLocale(locale)voidDefine a localidade da planilha.
setSpreadsheetTheme(theme)SpreadsheetThemeDefine um tema na planilha.
setSpreadsheetTimeZone(timezone)voidDefine o fuso horário da planilha.
show(userInterface)voidExibe um componente de interface do usuário personalizado em uma caixa de diálogo centralizada na janela de visualização do navegador do usuário.
sort(columnPosition)SheetClassifica uma página por coluna em ordem crescente.
sort(columnPosition, ascending)SheetClassifica uma página por coluna.
toast(msg)voidMostra uma janela pop-up no canto inferior direito da planilha com a mensagem especificada.
toast(msg, title)voidMostra uma janela pop-up no canto inferior direito da planilha com a mensagem e o título fornecidos.
toast(msg, title, timeoutSeconds)voidMostra uma janela pop-up no canto inferior direito da planilha com o título e a mensagem fornecidos, que permanece visível por um determinado período.
unhideColumn(column)voidExibe a coluna no intervalo especificado.
unhideRow(row)voidExibe a linha no intervalo especificado.
updateMenu(name, subMenus)voidAtualiza um menu adicionado por addMenu(name, subMenus).
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidAguarda até que todas as execuções atuais na planilha sejam concluídas, após o tempo limite após o número de segundos fornecido.

SpreadsheetApp

Propriedades

PropriedadeTipoDescrição
AutoFillSeriesAutoFillSeriesUma enumeração dos tipos de série usados para calcular os valores preenchidos automaticamente.
BandingThemeBandingThemeUma enumeração dos possíveis temas de faixas.
BooleanCriteriaBooleanCriteriaUma enumeração dos critérios booleanos de formatação condicional.
BorderStyleBorderStyleUma enumeração dos estilos válidos para definir bordas em uma Range.
ColorTypeColorTypeUma enumeração dos possíveis tipos de cor.
CopyPasteTypeCopyPasteTypeUma enumeração dos possíveis tipos de colagem.
DataExecutionErrorCodeDataExecutionErrorCodeUma enumeração dos possíveis códigos de erro de execução de dados.
DataExecutionStateDataExecutionStateUma enumeração dos possíveis estados de execução de dados.
DataSourceParameterTypeDataSourceParameterTypeUma enumeração dos possíveis tipos de parâmetros da fonte de dados.
DataSourceRefreshScopeDataSourceRefreshScopeUma enumeração dos possíveis escopos de atualização da fonte de dados.
DataSourceTypeDataSourceTypeUma enumeração dos possíveis tipos de fonte de dados.
DataValidationCriteriaDataValidationCriteriaUma enumeração que representa os critérios de validação de dados que podem ser definidos em um intervalo.
DateTimeGroupingRuleTypeDateTimeGroupingRuleTypeUma enumeração da regra de agrupamento de data e hora.
DeveloperMetadataLocationTypeDeveloperMetadataLocationTypeUma enumeração dos possíveis tipos de local dos metadados do desenvolvedor.
DeveloperMetadataVisibilityDeveloperMetadataVisibilityUma enumeração das possíveis visibilidades de metadados do desenvolvedor.
DimensionDimensionUma enumeração das possíveis dimensões de uma planilha.
DirectionDirectionUma enumeração das possíveis rotas que podem ser movidas em uma planilha usando as teclas de seta.
FrequencyTypeFrequencyTypeUma enumeração dos possíveis tipos de frequência.
GroupControlTogglePositionGroupControlTogglePositionUma enumeração das posições em que o controle de grupo pode estar.
InterpolationTypeInterpolationTypeUma enumeração dos tipos de interpolação de gradiente de formato condicional.
PivotTableSummarizeFunctionPivotTableSummarizeFunctionUma enumeração das funções que podem ser usadas para resumir os valores de uma tabela dinâmica.
PivotValueDisplayTypePivotValueDisplayTypeUma enumeração das formas em que um valor dinâmico pode ser exibido.
ProtectionTypeProtectionTypeUma enumeração que representa as partes de uma planilha que podem ser protegidas contra edições.
RecalculationIntervalRecalculationIntervalUma enumeração dos possíveis intervalos que podem ser usados no recálculo de planilha.
RelativeDateRelativeDateUma enumeração das opções de data relativa para calcular um valor a ser usado em BooleanCriteria baseado em data.
SheetTypeSheetTypeUma enumeração dos diferentes tipos de planilha que podem existir em uma planilha.
SortOrderSortOrderUma enumeração da ordem de classificação.
TextDirectionTextDirectionUma enumeração de rotas de texto válidas.
TextToColumnsDelimiterTextToColumnsDelimiterUma enumeração dos delimitadores predefinidos do texto dividido nas colunas.
ThemeColorTypeThemeColorTypeUma enumeração dos possíveis tipos de cores do tema.
ValueTypeValueTypeUma enumeração dos tipos de valor retornados por Range.getValue() e Range.getValues() da classe "Range" do serviço da planilha.
WrapStrategyWrapStrategyUma enumeração das estratégias usadas para unir células.

Métodos

MétodoTipo de retornoBreve descrição
create(name)SpreadsheetCria uma nova planilha com o nome fornecido.
create(name, rows, columns)SpreadsheetCria uma nova planilha com o nome fornecido e o número especificado de linhas e colunas.
enableAllDataSourcesExecution()voidAtiva a execução de dados para todos os tipos de fontes de dados.
enableBigQueryExecution()voidAtiva a execução de dados para a fonte de dados do BigQuery.
flush()voidAplica todas as alterações pendentes à planilha.
getActive()SpreadsheetRetorna a planilha ativa no momento ou null se não houver nenhuma.
getActiveRange()RangeRetorna o intervalo selecionado na página ativa ou null se não houver um intervalo ativo.
getActiveRangeList()RangeListRetorna a lista de intervalos ativos na página ativa ou null se não houver intervalos selecionados.
getActiveSheet()SheetRecebe a planilha ativa em uma planilha.
getActiveSpreadsheet()SpreadsheetRetorna a planilha ativa no momento ou null se não houver nenhuma.
getCurrentCell()RangeRetorna a célula atual (em destaque) selecionada em um dos intervalos ativos na página ativa ou em null, se não houver uma célula atual.
getSelection()SelectionRetorna o Selection atual na planilha.
getUi()UiRetorna uma instância do ambiente de interface do usuário da planilha que permite que o script adicione recursos como menus, caixas de diálogo e barras laterais.
newCellImage()CellImageBuilderCrie um builder para um CellImage.
newColor()ColorBuilderCrie um builder para um Color.
newConditionalFormatRule()ConditionalFormatRuleBuilderCria um builder para uma regra de formatação condicional.
newDataSourceSpec()DataSourceSpecBuilderCrie um builder para um DataSourceSpec.
newDataValidation()DataValidationBuilderCria um builder para uma regra de validação de dados.
newFilterCriteria()FilterCriteriaBuilderCrie um builder para um FilterCriteria.
newRichTextValue()RichTextValueBuilderCria um builder para um valor de rich text.
newTextStyle()TextStyleBuilderCrie um builder para um estilo de texto.
open(file)SpreadsheetAbre a planilha que corresponde ao objeto "Arquivo" especificado.
openById(id)SpreadsheetAbre a planilha com o ID fornecido.
openByUrl(url)SpreadsheetAbre a planilha com o URL fornecido.
setActiveRange(range)RangeDefine o intervalo especificado como o active range, com a célula superior esquerda no intervalo como o current cell.
setActiveRangeList(rangeList)RangeListDefine a lista de intervalos especificada como active ranges.
setActiveSheet(sheet)SheetDefine a planilha ativa em uma planilha.
setActiveSheet(sheet, restoreSelection)SheetDefine a página ativa em uma planilha, com a opção de restaurar a seleção mais recente nessa página.
setActiveSpreadsheet(newActiveSpreadsheet)voidDefine a planilha ativa.
setCurrentCell(cell)RangeDefine a célula especificada como o current cell.

SpreadsheetTheme

Métodos

MétodoTipo de retornoBreve descrição
getConcreteColor(themeColorType)ColorRetorna o Color concreto para um tipo de cor válido do tema.
getFontFamily()StringRetorna a família de fontes do tema ou null se for um tema de null.
getThemeColors()ThemeColorType[]Retorna uma lista de todos os tipos de cores de tema possíveis para o tema atual.
setConcreteColor(themeColorType, color)SpreadsheetThemeDefine a cor concreta associada ao ThemeColorType neste esquema de cores como a cor especificada.
setConcreteColor(themeColorType, red, green, blue)SpreadsheetThemeDefine a cor concreta associada ao ThemeColorType neste esquema de cores como a cor fornecida no formato RGB.
setFontFamily(fontFamily)SpreadsheetThemeDefine a família de fontes do tema.

TextDirection

Propriedades

PropriedadeTipoDescrição
LEFT_TO_RIGHTEnumDireção do texto da esquerda para a direita.
RIGHT_TO_LEFTEnumÉ a direção do texto da direita para a esquerda.

TextFinder

Métodos

MétodoTipo de retornoBreve descrição
findAll()Range[]Retorna todas as células que correspondem aos critérios de pesquisa.
findNext()RangeRetorna a próxima célula que corresponde aos critérios de pesquisa.
findPrevious()RangeRetorna a célula anterior que corresponde aos critérios de pesquisa.
getCurrentMatch()RangeRetorna a célula atual que corresponde aos critérios de pesquisa.
ignoreDiacritics(ignoreDiacritics)TextFinderSe true, configura a pesquisa para ignorar sinais diacríticos durante a correspondência. Caso contrário, a pesquisa corresponderá a diacríticos.
matchCase(matchCase)TextFinderSe true, configura a pesquisa para corresponder exatamente ao caso de texto da pesquisa. Caso contrário, a pesquisa usará como padrão a correspondência indiferente a maiúsculas.
matchEntireCell(matchEntireCell)TextFinderSe true, a pesquisa será configurada para corresponder a todo o conteúdo de uma célula. Caso contrário, a pesquisa usará a correspondência parcial por padrão.
matchFormulaText(matchFormulaText)TextFinderSe true, configura a pesquisa para retornar correspondências que aparecem no texto da fórmula. Caso contrário, as células com fórmulas serão consideradas com base no valor exibido.
replaceAllWith(replaceText)IntegerSubstitui todas as correspondências pelo texto especificado.
replaceWith(replaceText)IntegerSubstitui o texto de pesquisa na célula correspondente atualmente pelo texto especificado e retorna o número de ocorrências substituídas.
startFrom(startRange)TextFinderConfigura a pesquisa para iniciar a pesquisa imediatamente após o intervalo de células especificado.
useRegularExpression(useRegEx)TextFinderSe true, configura a pesquisa para interpretar a string de pesquisa como uma expressão regular. Caso contrário, a pesquisa interpretará a string de pesquisa como texto normal.

TextRotation

Métodos

MétodoTipo de retornoBreve descrição
getDegrees()IntegerAcessa o ângulo entre a orientação padrão do texto e a atual.
isVertical()BooleanRetornará true se o texto estiver empilhado verticalmente. Caso contrário, retornará false.

TextStyle

Métodos

MétodoTipo de retornoBreve descrição
copy()TextStyleBuilderCria um builder de estilo de texto inicializado com os valores desse estilo de texto.
getFontFamily()StringRecebe a família de fontes do texto.
getFontSize()IntegerAcessa o tamanho da fonte do texto em pontos.
getForegroundColorObject()ColorRecebe a cor da fonte do texto.
isBold()BooleanDefine se o texto está em negrito.
isItalic()BooleanRecebe ou não a célula em itálico.
isStrikethrough()BooleanRecebe o tachado da célula.
isUnderline()BooleanRecebe o sublinhado da célula.

TextStyleBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()TextStyleCria um estilo de texto com este builder.
setBold(bold)TextStyleBuilderDefine se o texto fica em negrito.
setFontFamily(fontFamily)TextStyleBuilderDefine a família de fontes de texto, como "quot;Arial"
setFontSize(fontSize)TextStyleBuilderDefine o tamanho da fonte do texto em pontos.
setForegroundColor(cssString)TextStyleBuilderDefine a cor da fonte do texto.
setForegroundColorObject(color)TextStyleBuilderDefine a cor da fonte do texto.
setItalic(italic)TextStyleBuilderDefine se o texto é itálico ou não.
setStrikethrough(strikethrough)TextStyleBuilderDefine se o texto tem tachado ou não.
setUnderline(underline)TextStyleBuilderDefine se o texto é sublinhado ou não.

TextToColumnsDelimiter

Propriedades

PropriedadeTipoDescrição
COMMAEnum"," delimitador.
SEMICOLONEnum";" delimitador.
PERIODEnum"." delimitador.
SPACEEnum" " delimitador.

ThemeColor

Métodos

MétodoTipo de retornoBreve descrição
getColorType()ColorTypeDescubra o tipo dessa cor.
getThemeColorType()ThemeColorTypeRecebe o tipo de cor do tema dessa cor.

ThemeColorType

Propriedades

PropriedadeTipoDescrição
UNSUPPORTEDEnumRepresenta uma cor de tema não compatível.
TEXTEnumRepresenta a cor do texto.
BACKGROUNDEnumRepresenta a cor a ser usada no plano de fundo do gráfico.
ACCENT1EnumRepresenta a primeira cor de destaque.
ACCENT2EnumRepresenta a segunda cor de destaque.
ACCENT3EnumRepresenta a terceira cor de destaque.
ACCENT4EnumRepresenta a quarta cor de destaque.
ACCENT5EnumRepresenta a quinta cor de destaque.
ACCENT6EnumRepresenta o sexto cor de destaque.
HYPERLINKEnumRepresenta a cor a ser usada para hiperlinks.

ValueType

Propriedades

PropriedadeTipoDescrição
IMAGEEnumO tipo de valor quando a célula contém uma imagem.

WrapStrategy

Propriedades

PropriedadeTipoDescrição
WRAPEnumUnir as linhas que são maiores que a largura da célula em uma nova linha.
OVERFLOWEnumPasse as linhas para a próxima célula, desde que ela esteja vazia.
CLIPEnumAs linhas de corte são mais longas que a largura da célula.