Spreadsheet Service

Planilha

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

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

Classes

NomeBreve descrição
AutoFillSeriesUma enumeração dos tipos de série usados para calcular valores preenchidos automaticamente.
BandingAcessar e modificar as faixas, que são os padrões de cores aplicados a linhas ou colunas de um intervalo.
BandingThemeUma enumeração de temas de bandas.
BigQueryDataSourceSpecAcesse a especificação 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 em formatação condicional ou filtro.
BorderStyleEstilos que podem ser definidos em um intervalo usando Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style).
CellImageRepresenta um valor de imagem em uma célula.
CellImageBuilderBuilder para a classe CellImage.
ColorUma representação de uma cor.
ColorBuilderO builder de ColorBuilder.
ConditionalFormatRuleAcesse as regras de formatação condicional.
ConditionalFormatRuleBuilderBuilder para regras de formatação condicional.
ContainerInfoAcessa a posição do gráfico em uma planilha.
CopyPasteTypeUma enumeração de possíveis tipos de colagem especial.
DataExecutionErrorCodeUma enumeração de códigos de erro de execução de dados.
DataExecutionStateUma enumeração de estados de execução de dados.
DataExecutionStatusO status da execução de dados.
DataSourceAcessar e modificar uma fonte de dados.
DataSourceChartAcessar e modificar um gráfico de fonte de dados.
DataSourceColumnAcessar e modificar uma coluna de fonte de dados.
DataSourceFormulaAcessar e modificar fórmulas de fontes de dados atuais.
DataSourceParameterAcessar parâmetros de fonte de dados atuais.
DataSourceParameterTypeUma enumeração de tipos de parâmetros de fonte de dados.
DataSourcePivotTableAcessar e modificar a tabela dinâmica da fonte de dados.
DataSourceRefreshScheduleAcessar e modificar uma programação de atualização.
DataSourceRefreshScheduleFrequencyAcessar a frequência de uma programação de atualização, que especifica com que frequência e quando atualizar.
DataSourceRefreshScopeUma enumeração de escopos para atualizações.
DataSourceSheetAcessar e modificar a página da fonte de dados.
DataSourceSheetFilterAcessar e modificar um filtro de planilha de fonte de dados.
DataSourceSpecAcessar as configurações gerais de uma especificação de fonte de dados.
DataSourceSpecBuilderO builder de DataSourceSpec.
DataSourceTableAcessar e modificar a tabela da fonte de dados.
DataSourceTableColumnAcessar e modificar uma coluna em um DataSourceTable.
DataSourceTableFilterAcessar e modificar um filtro de tabela de fonte de dados.
DataSourceTypeUma enumeração de tipos de fontes 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.
DateTimeGroupingRuleAcessar uma regra de agrupamento de data e hora.
DateTimeGroupingRuleTypeOs tipos de regra de agrupamento de data e hora.
DeveloperMetadataAcessar e modificar metadados do desenvolvedor.
DeveloperMetadataFinderPesquisar 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 de metadados do desenvolvedor.
DimensionUma enumeração de possíveis direções ao longo das quais os dados podem ser armazenados em uma planilha.
DirectionUma enumeração que representa as possíveis direções em que é possível se mover em uma planilha usando as teclas de seta.
DrawingRepresenta um desenho em uma página de uma planilha.
EmbeddedAreaChartBuilderBuilder para gráficos de área.
EmbeddedBarChartBuilderBuilder para gráficos de barras.
EmbeddedChartRepresenta um gráfico incorporado a uma planilha.
EmbeddedChartBuilderBuilder usado para editar um EmbeddedChart.
EmbeddedColumnChartBuilderBuilder para gráficos de colunas.
EmbeddedComboChartBuilderBuilder para gráficos de combinação.
EmbeddedHistogramChartBuilderBuilder para histogramas.
EmbeddedLineChartBuilderBuilder para gráficos de linhas.
EmbeddedPieChartBuilderBuilder para gráficos de pizza.
EmbeddedScatterChartBuilderBuilder para gráficos de dispersão.
EmbeddedTableChartBuilderBuilder para gráficos de tabela.
FilterUse essa classe para modificar os filtros atuais nas planilhas Grid, o tipo padrão de planilha.
FilterCriteriaUse essa classe para receber informações ou copiar os critérios em filtros atuais.
FilterCriteriaBuilderCriador de critérios de filtro.
FrequencyTypeUma enumeração de tipos de frequência.
GradientConditionAcesse as condições de gradiente (cor) em ConditionalFormatRuleApis.
GroupAcessar e modificar grupos de planilhas.
GroupControlTogglePositionUma enumeração que representa as posições possíveis que uma alternância de 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.
LookerDataSourceSpecUm DataSourceSpec usado para acessar especificamente as especificações da fonte de dados do Looker.
LookerDataSourceSpecBuilderO builder de LookerDataSourceSpecBuilder.
NamedRangeCriar, acessar e modificar intervalos nomeados em uma planilha.
OverGridImageRepresenta uma imagem sobre a grade em uma planilha.
PageProtectionAcessar e modificar páginas protegidas na versão mais antiga das Planilhas Google.
PivotFilterAcessar e modificar filtros de tabela dinâmica.
PivotGroupAcessar e modificar grupos de detalhamento de tabelas dinâmicas.
PivotGroupLimitAcessar e modificar o limite de grupos de tabelas dinâmicas.
PivotTableAcessar e modificar tabelas dinâmicas.
PivotTableSummarizeFunctionUma enumeração de funções que resumem os dados da tabela dinâmica.
PivotValueAcessar e modificar grupos de valores em tabelas dinâmicas.
PivotValueDisplayTypeUma enumeração de maneiras de mostrar um valor de pivô como uma função de outro valor.
ProtectionAcessar e modificar intervalos e páginas protegidos.
ProtectionTypeUma enumeração que representa as partes de uma planilha que podem ser protegidas contra edições.
RangeAcessar e modificar 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 relativa para calcular um valor a ser usado em BooleanCriteria com base em datas.
RichTextValueUma string de texto estilizada usada para representar o texto da célula.
RichTextValueBuilderUm criador de valores de rich text.
SelectionAcessa a seleção ativa atual na página ativa.
SheetAcessar e modificar páginas de planilhas.
SheetTypeOs diferentes tipos de páginas que podem existir em uma planilha.
SlicerRepresenta um controle de filtros, que é usado para filtrar intervalos, gráficos e tabelas dinâmicas de maneira não colaborativa.
SortOrderUma enumeração que representa a ordem de classificação.
SortSpecA especificação de classificação.
SpreadsheetAcessar e modificar arquivos das Planilhas Google.
SpreadsheetAppAcessar e criar arquivos das Planilhas Google.
SpreadsheetThemeAcessar e modificar temas atuais.
TextDirectionUma enumeração de rotas em texto.
TextFinderEncontrar ou substituir texto em um intervalo, uma página ou uma planilha.
TextRotationAcessar 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 de uma cor de tema.
ThemeColorTypeUm enum que descreve várias entradas de cores compatíveis com temas.
ValueTypeUma enumeração de tipos de valores retornados por Range.getValue() e Range.getValues() da classe Range do serviço de planilha.
WrapStrategyUma enumeração das estratégias usadas para processar a quebra de texto da célula.

AutoFillSeries

Propriedades

PropriedadeTipoDescrição
DEFAULT_SERIESEnumPadrão.
ALTERNATE_SERIESEnumO preenchimento automático com essa configuração resulta no preenchimento das células vazias no intervalo expandido com cópias dos valores atuais.

Banding

Métodos

MétodoTipo de retornoBreve descrição
copyTo(range)BandingCopia essa faixa para outro intervalo.
getFirstColumnColorObject()ColorRetorna a primeira cor de coluna alternada no efeito de faixa ou null se nenhuma cor estiver definida.
getFirstRowColorObject()ColorRetorna a primeira cor de linha alternada ou null se nenhuma cor estiver definida.
getFooterColumnColorObject()ColorRetorna a cor da última coluna no efeito zebrado ou null se nenhuma cor estiver definida.
getFooterRowColorObject()ColorRetorna a cor da última linha no agrupamento ou null se nenhuma cor estiver definida.
getHeaderColumnColorObject()ColorRetorna a cor da primeira coluna no efeito de faixa ou null se nenhuma cor estiver definida.
getHeaderRowColorObject()ColorRetorna a cor da linha de cabeçalho ou null se nenhuma cor estiver definida.
getRange()RangeRetorna o intervalo para essa agrupamento.
getSecondColumnColorObject()ColorRetorna a segunda cor de coluna alternada no encadeamento ou null se nenhuma cor estiver definida.
getSecondRowColorObject()ColorRetorna a segunda cor de linha alternada ou null se nenhuma cor estiver definida.
remove()voidRemove esse efeito.
setFirstColumnColor(color)BandingDefine a cor da primeira coluna que está alternando.
setFirstColumnColorObject(color)BandingDefine a primeira cor de coluna alternada no encadeamento.
setFirstRowColor(color)BandingDefine a primeira cor da linha que está alternando.
setFirstRowColorObject(color)BandingDefine a primeira cor de linha alternada na faixa.
setFooterColumnColor(color)BandingDefine a cor da última coluna.
setFooterColumnColorObject(color)BandingDefine a cor da última coluna do agrupamento.
setFooterRowColor(color)BandingDefine a cor da última linha.
setFooterRowColorObject(color)BandingDefine a cor da linha de rodapé no agrupamento.
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 de cabeçalho.
setHeaderRowColorObject(color)BandingDefine a cor da linha de cabeçalho.
setRange(range)BandingDefine o intervalo para essa agrupamento.
setSecondColumnColor(color)BandingDefine a cor da segunda coluna que está alternando.
setSecondColumnColorObject(color)BandingDefine a segunda cor da coluna alternada no agrupamento.
setSecondRowColor(color)BandingDefine a segunda cor da linha que está alternando.
setSecondRowColorObject(color)BandingDefine a segunda cor alternada na faixa.

BandingTheme

Propriedades

PropriedadeTipoDescrição
LIGHT_GREYEnumUm tema de faixas cinza-claro.
CYANEnumUm tema de faixa ciano.
GREENEnumUm tema de faixas verdes.
YELLOWEnumUm tema de faixas amarelas.
ORANGEEnumUm tema de faixas laranjas.
BLUEEnumUm tema de faixas azuis.
TEALEnumUm tema de faixa azul-petróleo.
GREYEnumUm tema de faixa cinza.
BROWNEnumUm tema de faixas marrons.
LIGHT_GREENEnumUm tema de faixas verde-claro.
INDIGOEnumUm tema de faixas na cor anil.
PINKEnumUm tema de faixas rosa.

BigQueryDataSourceSpec

Métodos

MétodoTipo de retornoBreve descrição
copy()DataSourceSpecBuilderCria um DataSourceSpecBuilder com base nas configurações dessa fonte de dados.
getDatasetId()StringRecebe o ID do conjunto de dados do BigQuery.
getParameters()DataSourceParameter[]Recebe 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()DataSourceTypeRecebe o tipo da fonte de dados.

BigQueryDataSourceSpecBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()DataSourceSpecCria uma especificação de fonte de dados com base nas configurações deste criador.
copy()DataSourceSpecBuilderCria um DataSourceSpecBuilder com base nas configurações dessa fonte de dados.
getDatasetId()StringRecebe o ID do conjunto de dados do BigQuery.
getParameters()DataSourceParameter[]Recebe 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()DataSourceTypeRecebe 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 o parâmetro com o nome existir, atualiza a célula de origem para criadores de especificações de fonte de dados do tipo DataSourceType.BIGQUERY.
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 de segundo plano para essa condição booleana.
getBold()BooleanRetorna true se essa condição booleana colocar o texto em negrito e false se ela remover o negrito do texto.
getCriteriaType()BooleanCriteriaRecebe o tipo de critério da regra, conforme definido na enumeração BooleanCriteria.
getCriteriaValues()Object[]Recebe uma matriz de argumentos para os critérios da regra.
getFontColorObject()ColorRecebe a cor da fonte para essa condição booleana.
getItalic()BooleanRetorna true se essa condição booleana colocar o texto em itálico e false se ela remover o itálico do texto.
getStrikethrough()BooleanRetorna true se essa condição booleana riscar o texto e false se ela remover o risco do texto.
getUnderline()BooleanRetorna true se essa condição booleana sublinhar o texto e false se ela remover o sublinhado.

BooleanCriteria

Propriedades

PropriedadeTipoDescrição
CELL_EMPTYEnumO critério é atendido quando uma célula está vazia.
CELL_NOT_EMPTYEnumO critério é atendido quando uma célula não está vazia.
DATE_AFTEREnumO critério é atendido quando uma data é posterior ao valor especificado.
DATE_BEFOREEnumO critério é atendido quando uma data é anterior ao valor especificado.
DATE_EQUAL_TOEnumO critério é atendido quando uma data é igual ao valor especificado.
DATE_NOT_EQUAL_TOEnumO critério é atendido quando uma data não é igual ao valor fornecido.
DATE_AFTER_RELATIVEEnumO critério é atendido quando uma data é posterior ao valor da data relativa.
DATE_BEFORE_RELATIVEEnumO critério é atendido quando uma data é anterior ao valor da data relativa.
DATE_EQUAL_TO_RELATIVEEnumO critério é atendido quando uma data é igual ao valor da data relativa.
NUMBER_BETWEENEnumO critério é atendido quando um número está entre os valores especificados.
NUMBER_EQUAL_TOEnumO critério é atendido quando um número é igual ao valor fornecido.
NUMBER_GREATER_THANEnumO critério é atendido quando um número é maior que o valor especificado.
NUMBER_GREATER_THAN_OR_EQUAL_TOEnumO critério é atendido quando um número é maior ou igual ao valor fornecido.
NUMBER_LESS_THANEnumO critério é atendido quando um número é menor que o valor especificado.
NUMBER_LESS_THAN_OR_EQUAL_TOEnumO critério é atendido quando um número é menor ou igual ao valor especificado.
NUMBER_NOT_BETWEENEnumO critério é atendido quando um número não está entre os valores especificados.
NUMBER_NOT_EQUAL_TOEnumO critério é atendido quando um número não é igual ao valor fornecido.
TEXT_CONTAINSEnumO critério é atendido quando a entrada contém o valor especificado.
TEXT_DOES_NOT_CONTAINEnumO critério é atendido quando a entrada não contém o valor especificado.
TEXT_EQUAL_TOEnumO critério é atendido quando a entrada é igual ao valor fornecido.
TEXT_NOT_EQUAL_TOEnumO critério é atendido quando a entrada não é igual ao valor fornecido.
TEXT_STARTS_WITHEnumO critério é atendido quando a entrada começa com o valor especificado.
TEXT_ENDS_WITHEnumO critério é atendido quando a entrada termina com o valor especificado.
CUSTOM_FORMULAEnumO critério é atendido quando a entrada faz com que a fórmula fornecida seja avaliada como true.

BorderStyle

Propriedades

PropriedadeTipoDescrição
DOTTEDEnumBordas com linha pontilhada.
DASHEDEnumBordas de linha tracejada.
SOLIDEnumBordas de linha sólida fina.
SOLID_MEDIUMEnumBordas de linha sólida média.
SOLID_THICKEnumBordas de linha sólida grossa.
DOUBLEEnumDuas bordas de linha sólida.

CellImage

Propriedades

PropriedadeTipoDescrição
valueTypeValueTypeO tipo de valor da imagem da célula, que é ValueType.IMAGE.

Métodos

MétodoTipo de retornoBreve descrição
getAltTextDescription()StringRetorna a descrição do texto alternativo para esta imagem.
getAltTextTitle()StringRetorna o título do texto alternativo para esta imagem.
getContentUrl()StringRetorna um URL hospedado pelo Google para a imagem.
toBuilder()CellImageBuilderCria um criador de imagens de células com base nas propriedades da imagem atual.

CellImageBuilder

Propriedades

PropriedadeTipoDescrição
valueTypeValueTypeO tipo de valor da imagem da célula, que é ValueType.IMAGE.

Métodos

MétodoTipo de retornoBreve descrição
build()CellImageCria o tipo de valor de imagem necessário para adicionar uma imagem a uma célula.
getAltTextDescription()StringRetorna a descrição do texto alternativo para esta imagem.
getAltTextTitle()StringRetorna o título do texto alternativo para esta imagem.
getContentUrl()StringRetorna um URL hospedado pelo Google para a imagem.
setAltTextDescription(description)CellImageDefine a descrição do texto alternativo para esta 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 criador de imagens de células com base nas propriedades da imagem atual.

Color

Métodos

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

ColorBuilder

Métodos

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

ConditionalFormatRule

Métodos

MétodoTipo de retornoBreve descrição
copy()ConditionalFormatRuleBuilderRetorna uma predefinição do criador de regras com as configurações dessa regra.
getBooleanCondition()BooleanConditionRecupera as informações de BooleanCondition da regra se ela usar critérios de condição booleana.
getGradientCondition()GradientConditionRecupera as informações de GradientCondition da regra, se ela 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 formatação condicional com base nas configurações aplicadas ao builder.
copy()ConditionalFormatRuleBuilderRetorna uma predefinição do criador de regras com as configurações dessa regra.
getBooleanCondition()BooleanConditionRecupera as informações de BooleanCondition da regra se ela usar critérios de condição booleana.
getGradientCondition()GradientConditionRecupera as informações de GradientCondition da regra, se ela 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 de plano de fundo para o formato da regra de formatação condicional.
setBackgroundObject(color)ConditionalFormatRuleBuilderDefine a cor de plano de fundo para o formato da regra de formatação condicional.
setBold(bold)ConditionalFormatRuleBuilderDefine o negrito do texto para o formato da regra de formatação condicional.
setFontColor(color)ConditionalFormatRuleBuilderDefine a cor da fonte para o formato da regra de formatação condicional.
setFontColorObject(color)ConditionalFormatRuleBuilderDefine a cor da fonte para o formato da regra de formatação condicional.
setGradientMaxpoint(color)ConditionalFormatRuleBuilderLimpa o valor máximo do gradiente da regra de formatação condicional e usa o valor máximo nos intervalos da regra.
setGradientMaxpointObject(color)ConditionalFormatRuleBuilderLimpa o valor máximo do gradiente da regra de formatação condicional e usa o valor máximo nos intervalos da regra.
setGradientMaxpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos maxpoint de gradiente da regra de formatação condicional.
setGradientMaxpointWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos maxpoint de gradiente da regra de formatação condicional.
setGradientMidpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos de ponto médio do gradiente da regra de formatação condicional.
setGradientMidpointWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos de ponto médio do gradiente da regra de formatação condicional.
setGradientMinpoint(color)ConditionalFormatRuleBuilderLimpa o valor mínimo do gradiente da regra de formatação condicional e usa o valor mínimo nos intervalos da regra.
setGradientMinpointObject(color)ConditionalFormatRuleBuilderLimpa o valor mínimo do gradiente da regra de formatação condicional e usa o valor mínimo nos intervalos da regra.
setGradientMinpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos de ponto mínimo de gradiente da regra de formatação condicional.
setGradientMinpointWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos de ponto mínimo de gradiente da regra de formatação condicional.
setItalic(italic)ConditionalFormatRuleBuilderDefine o texto em itálico para o formato da regra de formatação condicional.
setRanges(ranges)ConditionalFormatRuleBuilderDefine um ou mais intervalos a que essa regra de formatação condicional é aplicada.
setStrikethrough(strikethrough)ConditionalFormatRuleBuilderDefine tachado no texto para o formato da regra de formatação condicional.
setUnderline(underline)ConditionalFormatRuleBuilderDefine o sublinhado do texto para o formato da regra de formatação condicional.
whenCellEmpty()ConditionalFormatRuleBuilderDefine a regra de formatação 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 está vazia.
whenDateAfter(date)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando uma data for posterior ao valor especificado.
whenDateAfter(date)ConditionalFormatRuleBuilderDefine a regra de formatação 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 formatação 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 é igual à data especificada.
whenDateEqualTo(date)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando uma data for igual à data relativa especificada.
whenFormulaSatisfied(formula)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando a fórmula especificada for avaliada como true.
whenNumberBetween(start, end)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando um número está entre dois valores especificados ou é um deles.
whenNumberEqualTo(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando um número é igual ao valor especificado.
whenNumberGreaterThan(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando um número é maior que o valor especificado.
whenNumberGreaterThanOrEqualTo(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando um número for maior ou igual ao valor especificado.
whenNumberLessThan(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando um número for menor que o valor especificado.
whenNumberLessThanOrEqualTo(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando um número for menor ou igual ao valor especificado.
whenNumberNotBetween(start, end)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando um número não estiver entre dois valores especificados e não for igual a nenhum deles.
whenNumberNotEqualTo(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando um número não é igual ao valor especificado.
whenTextContains(text)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando a entrada contém o valor especificado.
whenTextDoesNotContain(text)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando a entrada não contém o valor especificado.
whenTextEndsWith(text)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando a entrada terminar com o valor especificado.
whenTextEqualTo(text)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando a entrada for igual ao valor especificado.
whenTextStartsWith(text)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para ser acionada quando a entrada começa com o valor especificado.
withCriteria(criteria, args)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para critérios definidos por valores BooleanCriteria, normalmente extraídos de criteria e arguments de uma regra existente.

ContainerInfo

Métodos

MétodoTipo de retornoBreve descrição
getAnchorColumn()IntegerO lado esquerdo do gráfico está fixado nessa coluna.
getAnchorRow()IntegerA parte superior do gráfico fica ancorada nessa linha.
getOffsetX()IntegerO canto superior esquerdo do gráfico é deslocado da coluna de ancoragem por esse número de pixels.
getOffsetY()IntegerO canto superior esquerdo do gráfico é deslocado da linha de ancoragem por esse número de pixels.

CopyPasteType

Propriedades

PropriedadeTipoDescrição
PASTE_NORMALEnumCole valores, fórmulas, formatos e mesclagens.
PASTE_NO_BORDERSEnumCola valores, fórmulas, formatos e mesclagens, mas sem bordas.
PASTE_FORMATEnumCole apenas a formatação.
PASTE_FORMULAEnumCole apenas as fórmulas.
PASTE_DATA_VALIDATIONEnumCole apenas a validação de dados.
PASTE_VALUESEnumCole SOMENTE os valores, sem formatos, fórmulas ou mesclagens.
PASTE_CONDITIONAL_FORMATTINGEnumCole apenas as regras de cor.
PASTE_COLUMN_WIDTHSEnumCole apenas as larguras 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 de dados não tem erros.
TIME_OUTEnumA execução de dados expirou.
TOO_MANY_ROWSEnumA execução de dados retorna mais linhas do que o limite.
TOO_MANY_COLUMNSEnumA execução de dados retorna mais colunas do que o limite.
TOO_MANY_CELLSEnumA execução de 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 de dados retorna um tipo de dados não compatível.
DUPLICATE_COLUMN_NAMESEnumA execução dos dados retorna nomes de colunas duplicados.
INTERRUPTEDEnumA execução de dados é interrompida.
OTHEREnumOutros erros.
TOO_MANY_CHARS_PER_CELLEnumA execução de dados retorna valores que excedem o número máximo de caracteres permitidos em uma única célula.
DATA_NOT_FOUNDEnumNão foi possível encontrar o banco de dados referenciado pela fonte de dados.
PERMISSION_DENIEDEnumO usuário não tem acesso ao banco de dados referenciado pela fonte de dados.

DataExecutionState

Propriedades

PropriedadeTipoDescrição
DATA_EXECUTION_STATE_UNSUPPORTEDEnumNão há suporte para um estado de execução de dados no Apps Script.
RUNNINGEnumA execução de dados foi iniciada e está em andamento.
SUCCESSEnumA execução de dados foi concluída e bem-sucedida.
ERROREnumA execução de dados foi concluída e tem erros.
NOT_STARTEDEnumA execução de 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 da execução.
getLastRefreshedTime()DateRecebe a hora em que os dados foram atualizados pela última vez.
isTruncated()BooleanRetorna true se os dados da última execução bem-sucedida forem truncados ou false caso contrário.

DataSource

Métodos

MétodoTipo de retornoBreve descrição
cancelAllLinkedDataSourceObjectRefreshes()voidCancela todas as atualizações em execução de objetos da fonte de dados vinculados a esta fonte.
createCalculatedColumn(name, formula)DataSourceColumnCria uma coluna calculada.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableCria uma tabela dinâmica de fonte de dados com base nessa fonte na primeira célula de uma nova planilha.
createDataSourceTableOnNewSheet()DataSourceTableCria uma tabela de fonte de dados com base nessa fonte na primeira célula de uma nova planilha.
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 na fonte de dados.
getDataSourceSheets()DataSourceSheet[]Retorna as planilhas de origem de dados associadas a esta fonte de dados.
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 vinculados a ela 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)voidAguarde até que todas as execuções atuais dos objetos de fonte de dados vinculada sejam concluídas, com tempo limite após o número de segundos fornecido.

DataSourceChart

Métodos

MétodoTipo de retornoBreve descrição
cancelDataRefresh()DataSourceChartCancela a atualização de dados associada a esse objeto se ela estiver em execução.
forceRefreshData()DataSourceChartAtualiza os dados desse objeto, independente do estado atual.
getDataSource()DataSourceRecebe a fonte de dados a que o objeto está vinculado.
getStatus()DataExecutionStatusRecebe o status de execução de dados do objeto.
refreshData()DataSourceChartAtualiza os dados do objeto.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarde até que a execução atual seja concluída, com tempo limite após o número de segundos fornecido.

DataSourceColumn

Métodos

MétodoTipo de retornoBreve descrição
getDataSource()DataSourceRecebe a fonte de dados associada à coluna de fonte de dados.
getFormula()StringRecebe a fórmula da coluna de fonte de dados.
getName()StringRecebe o nome da coluna da 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 da coluna da fonte de dados.
setName(name)DataSourceColumnDefine o nome da coluna da fonte de dados.

DataSourceFormula

Métodos

MétodoTipo de retornoBreve descrição
cancelDataRefresh()DataSourceFormulaCancela a atualização de dados associada a esse objeto se ela estiver em execução.
forceRefreshData()DataSourceFormulaAtualiza os dados desse objeto, independente do estado atual.
getAnchorCell()RangeRetorna o Range que representa a célula em que essa fórmula de fonte de dados está ancorada.
getDataSource()DataSourceRecebe a fonte de dados a que o objeto está vinculado.
getDisplayValue()StringRetorna o valor de exibição da fórmula da fonte de dados.
getFormula()StringRetorna a fórmula para essa fórmula de fonte de dados.
getStatus()DataExecutionStatusRecebe o status de execução de dados do objeto.
refreshData()DataSourceFormulaAtualiza os dados do objeto.
setFormula(formula)DataSourceFormulaAtualiza a fórmula.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarde até que a execução atual seja concluída, com tempo limite após o número de segundos fornecido.

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 parâmetro da fonte de dados é avaliado 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 especificada da fonte de dados.
addFilter(columnName, filterCriteria)PivotFilterAdiciona um filtro com base na coluna especificada da fonte de dados e nos critérios de filtro especificados.
addPivotValue(columnName)PivotValueAdiciona um novo valor dinâmico com base na coluna especificada da fonte de dados sem nenhuma função de resumo.
addPivotValue(columnName, summarizeFunction)PivotValueAdiciona um novo valor de representação dinâmica com base na coluna especificada da fonte de dados e na função de resumo especificada.
addRowGroup(columnName)PivotGroupAdiciona um novo grupo de linhas de tabela dinâmica com base na coluna especificada da fonte de dados.
asPivotTable()PivotTableRetorna a tabela dinâmica da fonte de dados como um objeto de tabela dinâmica comum.
cancelDataRefresh()DataSourcePivotTableCancela a atualização de dados associada a esse objeto se ela estiver em execução.
forceRefreshData()DataSourcePivotTableAtualiza os dados desse objeto, independente do estado atual.
getDataSource()DataSourceRecebe a fonte de dados a que o objeto está vinculado.
getStatus()DataExecutionStatusRecebe o status de execução de dados do objeto.
refreshData()DataSourcePivotTableAtualiza os dados do objeto.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarde até que a execução atual seja concluída, com tempo limite após o número de segundos fornecido.

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 a janela de tempo 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 durante o qual 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 à página da fonte de dados.
asSheet()SheetRetorna a página de fonte de dados como um objeto de página comum.
autoResizeColumn(columnName)DataSourceSheetRedimensiona automaticamente a largura da coluna especificada.
autoResizeColumns(columnNames)DataSourceSheetRedimensiona automaticamente a largura das colunas especificadas.
cancelDataRefresh()DataSourceSheetCancela a atualização de dados associada a esse objeto se ela estiver em execução.
forceRefreshData()DataSourceSheetAtualiza os dados desse objeto, independente do estado atual.
getColumnWidth(columnName)IntegerRetorna a largura da coluna especificada.
getDataSource()DataSourceRecebe a fonte de dados a que o objeto está vinculado.
getFilters()DataSourceSheetFilter[]Retorna todos os filtros aplicados à página da fonte de dados.
getSheetValues(columnName)Object[]Retorna todos os valores da planilha de origem de dados para o nome de coluna fornecido.
getSheetValues(columnName, startRow, numRows)Object[]Retorna todos os valores da planilha de origem de dados para o nome da coluna fornecido, da linha inicial (com base em 1) até o numRows fornecido.
getSortSpecs()SortSpec[]Recebe todas as especificações de classificação na planilha da fonte de dados.
getStatus()DataExecutionStatusRecebe o status de execução de dados do objeto.
refreshData()DataSourceSheetAtualiza os dados do objeto.
removeFilters(columnName)DataSourceSheetRemove todos os filtros aplicados à coluna da planilha de fonte de dados.
removeSortSpec(columnName)DataSourceSheetRemove a especificação de classificação em uma coluna na planilha 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 de origem de dados.
setSortSpec(columnName, sortOrder)DataSourceSheetDefine a especificação de classificação em uma coluna na página de origem de dados.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarde até que a execução atual seja concluída, com tempo limite após o número de segundos fornecido.

DataSourceSheetFilter

Métodos

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

DataSourceSpec

Métodos

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

DataSourceSpecBuilder

Métodos

MétodoTipo de retornoBreve descrição
asBigQuery()BigQueryDataSourceSpecBuilderRecebe o builder para a fonte de dados do BigQuery.
asLooker()LookerDataSourceSpecBuilderRecebe o builder da fonte de dados do Looker.
build()DataSourceSpecCria uma especificação de fonte de dados com base nas configurações deste criador.
copy()DataSourceSpecBuilderCria um DataSourceSpecBuilder com base nas configurações dessa fonte de dados.
getParameters()DataSourceParameter[]Recebe os parâmetros da fonte de dados.
getType()DataSourceTypeRecebe 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 o parâmetro com o nome existir, atualiza a célula de origem para criadores de especificações de fonte de dados do tipo DataSourceType.BIGQUERY.

DataSourceTable

Métodos

MétodoTipo de retornoBreve descrição
addColumns(columnNames)DataSourceTableAdiciona colunas à tabela de origem de dados.
addFilter(columnName, filterCriteria)DataSourceTableAdiciona um filtro aplicado à tabela de origem de dados.
addSortSpec(columnName, ascending)DataSourceTableAdiciona uma especificação de classificação a uma coluna na tabela de origem de dados.
addSortSpec(columnName, sortOrder)DataSourceTableAdiciona uma especificação de classificação a uma coluna na tabela de origem de dados.
cancelDataRefresh()DataSourceTableCancela a atualização de dados associada a esse objeto se ela estiver em execução.
forceRefreshData()DataSourceTableAtualiza os dados desse objeto, independente do estado atual.
getColumns()DataSourceTableColumn[]Recebe todas as colunas da fonte de dados adicionadas à tabela de origem.
getDataSource()DataSourceRecebe a fonte de dados a que o objeto está vinculado.
getFilters()DataSourceTableFilter[]Retorna todos os filtros aplicados à tabela de fonte de dados.
getRange()RangeRecebe o Range abrangido por essa tabela de fonte de dados.
getRowLimit()IntegerRetorna o limite de linhas para a tabela da fonte de dados.
getSortSpecs()SortSpec[]Recebe todas as especificações de classificação na tabela da fonte de dados.
getStatus()DataExecutionStatusRecebe 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 da tabela de origem de dados.
removeAllSortSpecs()DataSourceTableRemove todas as especificações de classificação na tabela da fonte de dados.
setRowLimit(rowLimit)DataSourceTableAtualiza o limite de linhas da tabela de origem de dados.
syncAllColumns()DataSourceTableSincronize todas as colunas atuais e futuras na fonte de dados associada com a tabela da fonte de dados.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarde até que a execução atual seja concluída, com tempo limite após o número de segundos fornecido.

DataSourceTableColumn

Métodos

MétodoTipo de retornoBreve descrição
getDataSourceColumn()DataSourceColumnRecebe a coluna da fonte 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 a que esse filtro se aplica.
getDataSourceTable()DataSourceTableRetorna o DataSourceTable a que este filtro pertence.
getFilterCriteria()FilterCriteriaRetorna os critérios de filtragem para este filtro.
remove()voidRemove esse filtro do objeto da fonte de dados.
setFilterCriteria(filterCriteria)DataSourceTableFilterDefine os critérios de filtragem 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.
LOOKEREnumUma fonte de dados do Looker.

DataValidation

Métodos

MétodoTipo de retornoBreve descrição
copy()DataValidationBuilderCria um builder para uma regra de validação de dados com base nas configurações dessa regra.
getAllowInvalid()BooleanRetorna true se a regra mostrar um aviso quando a entrada falhar na validação de dados ou false se ela rejeitar a entrada por completo.
getCriteriaType()DataValidationCriteriaRecebe o tipo de critério da regra, conforme definido na enumeração 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 estiver 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 builder para uma regra de validação de dados com base nas configurações dessa regra.
getAllowInvalid()BooleanRetorna true se a regra mostrar um aviso quando a entrada falhar na validação de dados ou false se ela rejeitar a entrada por completo.
getCriteriaType()DataValidationCriteriaRecebe o tipo de critério da regra, conforme definido na enumeração 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 estiver definido.
requireCheckbox()DataValidationBuilderDefine a regra de validação de 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 esteja em branco.
requireCheckbox(checkedValue, uncheckedValue)DataValidationBuilderDefine a regra de validação de 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 de dados para exigir uma data posterior ao valor especificado.
requireDateBefore(date)DataValidationBuilderDefine a regra de validação de dados para exigir uma data anterior ao valor especificado.
requireDateBetween(start, end)DataValidationBuilderDefine a regra de validação de dados para exigir uma data que esteja entre duas datas especificadas ou seja uma delas.
requireDateEqualTo(date)DataValidationBuilderDefine a regra de validação de dados para exigir uma data igual ao valor especificado.
requireDateNotBetween(start, end)DataValidationBuilderDefine a regra de validação de dados para exigir uma data que não esteja entre duas datas especificadas nem seja uma delas.
requireDateOnOrAfter(date)DataValidationBuilderDefine a regra de validação de dados para exigir uma data igual ou posterior ao valor especificado.
requireDateOnOrBefore(date)DataValidationBuilderDefine a regra de validação de dados para exigir uma data igual ou anterior ao valor especificado.
requireFormulaSatisfied(formula)DataValidationBuilderDefine a regra de validação de dados para exigir que a fórmula fornecida seja avaliada como true.
requireNumberBetween(start, end)DataValidationBuilderDefine a regra de validação de dados para exigir um número que esteja entre dois números especificados ou seja um deles.
requireNumberEqualTo(number)DataValidationBuilderDefine a regra de validação de dados para exigir um número igual ao valor especificado.
requireNumberGreaterThan(number)DataValidationBuilderDefine a regra de validação de dados para exigir um número maior que o valor especificado.
requireNumberGreaterThanOrEqualTo(number)DataValidationBuilderDefine a regra de validação de dados para exigir um número maior ou igual ao valor especificado.
requireNumberLessThan(number)DataValidationBuilderDefine a regra de validação de dados para exigir um número menor que o valor especificado.
requireNumberLessThanOrEqualTo(number)DataValidationBuilderDefine a regra de validação de dados para exigir um número menor ou igual ao valor especificado.
requireNumberNotBetween(start, end)DataValidationBuilderDefine a regra de validação de dados para exigir um número que não esteja entre dois números especificados e que não seja nenhum deles.
requireNumberNotEqualTo(number)DataValidationBuilderDefine a regra de validação de dados para exigir um número diferente do valor especificado.
requireTextContains(text)DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada contenha o valor especificado.
requireTextDoesNotContain(text)DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada não contenha o valor especificado.
requireTextEqualTo(text)DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada seja igual ao valor especificado.
requireTextIsEmail()DataValidationBuilderDefine a regra de validação de 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 de dados para exigir que a entrada seja igual a um dos valores fornecidos.
requireValueInList(values, showDropdown)DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada seja igual a um dos valores fornecidos, com uma opção para ocultar o menu suspenso.
requireValueInRange(range)DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada seja igual a um valor no intervalo especificado.
requireValueInRange(range, showDropdown)DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada seja igual a um valor no intervalo especificado, com a opção de ocultar o menu suspenso.
setAllowInvalid(allowInvalidData)DataValidationBuilderDefine se um aviso será mostrado quando a entrada não passar na validação de dados ou se ela será rejeitada por completo.
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 para critérios definidos por valores DataValidationCriteria, geralmente extraídos de criteria e arguments de uma regra existente.

DataValidationCriteria

Propriedades

PropriedadeTipoDescrição
DATE_AFTEREnumExige uma data posterior ao valor especificado.
DATE_BEFOREEnumRequer uma data anterior ao valor especificado.
DATE_BETWEENEnumExige uma data entre os valores fornecidos.
DATE_EQUAL_TOEnumExige uma data igual ao valor informado.
DATE_IS_VALID_DATEEnumRequer uma data.
DATE_NOT_BETWEENEnumExige uma data que não esteja entre os valores especificados.
DATE_ON_OR_AFTEREnumExige uma data igual ou posterior ao valor especificado.
DATE_ON_OR_BEFOREEnumRequer uma data igual ou anterior ao valor especificado.
NUMBER_BETWEENEnumExige um número entre os valores fornecidos.
NUMBER_EQUAL_TOEnumRequer um número igual ao valor fornecido.
NUMBER_GREATER_THANEnumExige um número maior que o valor especificado.
NUMBER_GREATER_THAN_OR_EQUAL_TOEnumExige um número maior ou igual ao valor especificado.
NUMBER_LESS_THANEnumExige um número menor que o valor especificado.
NUMBER_LESS_THAN_OR_EQUAL_TOEnumExige um número menor ou igual ao valor fornecido.
NUMBER_NOT_BETWEENEnumExige um número que não esteja entre os valores fornecidos.
NUMBER_NOT_EQUAL_TOEnumRequer um número que não seja igual ao valor informado.
TEXT_CONTAINSEnumExige que a entrada contenha o valor especificado.
TEXT_DOES_NOT_CONTAINEnumExige que a entrada não contenha o valor especificado.
TEXT_EQUAL_TOEnumExige que a entrada seja igual ao valor informado.
TEXT_IS_VALID_EMAILEnumExige que a entrada esteja no formato de um endereço de e-mail.
TEXT_IS_VALID_URLEnumExige que a entrada esteja no formato de um URL.
VALUE_IN_LISTEnumExige que a entrada seja igual a um dos valores fornecidos.
VALUE_IN_RANGEEnumExige que a entrada seja igual a um valor no intervalo especificado.
CUSTOM_FORMULAEnumExige que a entrada faça com que a fórmula fornecida seja avaliada como true.
CHECKBOXEnumExige que a entrada seja um valor personalizado ou um booleano. Renderizado como uma caixa de seleção.
DATE_AFTER_RELATIVEEnumExige uma data posterior ao valor da data relativa.
DATE_BEFORE_RELATIVEEnumRequer uma data anterior ao valor da data relativa.
DATE_EQUAL_TO_RELATIVEEnumExige uma data igual ao valor da data relativa.

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 que não é aceito.
SECONDEnumAgrupa data e hora por segundo, de 0 a 59.
MINUTEEnumAgrupa data e hora por minuto, de 0 a 59.
HOUREnumAgrupa data e hora por hora usando um sistema de 24 horas, de 0 a 23.
HOUR_MINUTEEnumAgrupe data e hora por hora e minuto usando um sistema de 24 horas, por exemplo, 19:45.
HOUR_MINUTE_AMPMEnumAgrupe data e hora por hora e minuto usando um sistema de 12 horas, por exemplo, 7:45 PM.
DAY_OF_WEEKEnumAgrupa data e hora por dia da semana, por exemplo, Sunday.
DAY_OF_YEAREnumAgrupa data e hora por dia do ano, de 1 a 366.
DAY_OF_MONTHEnumAgrupa 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 e hora por mês, por exemplo, Nov.
QUARTEREnumAgrupe data e hora por trimestre, por exemplo, T1 (que representa janeiro a março).
YEAREnumAgrupe data e hora por ano, por exemplo, 2008.
YEAR_MONTHEnumAgrupe data e hora por ano e mês, por exemplo, 2008-Nov.
YEAR_QUARTEREnumAgrupe data e hora 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 a localização desses metadados do desenvolvedor.
getValue()StringRetorna o valor associado a esses metadados do desenvolvedor ou null se eles não tiverem um valor.
getVisibility()DeveloperMetadataVisibilityRetorna a visibilidade desses metadados do desenvolvedor.
moveToColumn(column)DeveloperMetadataMove esses metadados do desenvolvedor para a coluna especificada.
moveToRow(row)DeveloperMetadataMove esses metadados do desenvolvedor para a linha especificada.
moveToSheet(sheet)DeveloperMetadataMove esses metadados do desenvolvedor para a planilha especificada.
moveToSpreadsheet()DeveloperMetadataMove esses 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 especificada.

DeveloperMetadataFinder

Métodos

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

DeveloperMetadataLocation

Métodos

MétodoTipo de retornoBreve descrição
getColumn()RangeRetorna o Range da localização da coluna desses metadados ou null se o tipo de localização não for DeveloperMetadataLocationType.COLUMN.
getLocationType()DeveloperMetadataLocationTypeRecebe o tipo de local.
getRow()RangeRetorna o Range para a localização 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
SPREADSHEETEnumO tipo de local dos metadados do desenvolvedor associados à planilha de nível superior.
SHEETEnumO tipo de local para metadados do desenvolvedor associados a uma planilha inteira.
ROWEnumO tipo de local dos metadados do desenvolvedor associados a uma linha.
COLUMNEnumO tipo de local para metadados do desenvolvedor associados a uma coluna.

DeveloperMetadataVisibility

Propriedades

PropriedadeTipoDescrição
DOCUMENTEnumOs metadados visíveis no documento podem ser acessados de qualquer projeto de desenvolvedor com acesso ao documento.
PROJECTEnumOs metadados visíveis para o projeto só podem ser vistos e acessados pelo projeto do desenvolvedor que criou os metadados.

Dimension

Propriedades

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

Direction

Propriedades

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

Drawing

Métodos

MétodoTipo de retornoBreve descrição
getContainerInfo()ContainerInfoRecebe informações sobre onde o desenho está posicionado na planilha.
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 o 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 planilha.
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 mudanças feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna o gráfico ContainerInfo, que encapsula onde ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que fornecem dados para este gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
reverseCategories()EmbeddedAreaChartBuilderInverte a ordem das séries no eixo de domínio.
setBackgroundColor(cssValue)EmbeddedAreaChartBuilderDefine a cor do plano de fundo do gráfico.
setChartType(type)EmbeddedChartBuilderMuda 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 do texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratados 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, mudando onde o gráfico aparece na planilha.
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 do texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico são transpostas.
setXAxisTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo do texto do eixo horizontal.
setXAxisTitle(title)EmbeddedAreaChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo do 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()EmbeddedAreaChartBuilderTransforma 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 mudanças feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna o gráfico ContainerInfo, que encapsula onde ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que fornecem dados para este gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
reverseCategories()EmbeddedBarChartBuilderInverte a ordem das séries no eixo de 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)EmbeddedChartBuilderMuda 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 do texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratados como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, mudando onde o gráfico aparece na planilha.
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 do texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico são transpostas.
setXAxisTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo do texto do eixo horizontal.
setXAxisTitle(title)EmbeddedBarChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo do 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()EmbeddedBarChartBuilderTransforma 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()DataSourceChartFaz a conversão para uma instância de gráfico de fonte de dados se o gráfico for desse tipo 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()BlobRetorna os dados dentro desse objeto como um blob.
getChartId()IntegerRetorna um identificador estável e exclusivo para o gráfico na planilha que o contém ou null se ele não estiver em uma planilha.
getContainerInfo()ContainerInfoRetorna informações sobre onde o gráfico está posicionado em uma planilha.
getHiddenDimensionStrategy()ChartHiddenDimensionStrategyRetorna a estratégia a ser usada para processar linhas e colunas ocultas.
getMergeStrategy()ChartMergeStrategyRetorna a estratégia de fusão usada quando há mais de um intervalo.
getNumHeaders()IntegerRetorna o número de linhas ou colunas do intervalo que são tratadas como cabeçalhos.
getOptions()ChartOptionsRetorna as opções do 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 serão trocadas.
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 mudanças feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna o gráfico ContainerInfo, que encapsula onde ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que fornecem dados para este gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
setChartType(type)EmbeddedChartBuilderMuda 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 mesclagem a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratados como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, mudando onde o gráfico aparece na planilha.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e 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 mudanças feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna o gráfico ContainerInfo, que encapsula onde ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que fornecem dados para este gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
reverseCategories()EmbeddedColumnChartBuilderInverte a ordem das séries no eixo de domínio.
setBackgroundColor(cssValue)EmbeddedColumnChartBuilderDefine a cor do plano de fundo do gráfico.
setChartType(type)EmbeddedChartBuilderMuda 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 do texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratados como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, mudando onde o gráfico aparece na planilha.
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 do texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico são transpostas.
setXAxisTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo do texto do eixo horizontal.
setXAxisTitle(title)EmbeddedColumnChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo do 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()EmbeddedColumnChartBuilderTransforma 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 mudanças feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna o gráfico ContainerInfo, que encapsula onde ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que fornecem dados para este gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
reverseCategories()EmbeddedComboChartBuilderInverte a ordem das séries no eixo de domínio.
setBackgroundColor(cssValue)EmbeddedComboChartBuilderDefine a cor do plano de fundo do gráfico.
setChartType(type)EmbeddedChartBuilderMuda 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 do texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratados como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, mudando onde o gráfico aparece na planilha.
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 do texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico são transpostas.
setXAxisTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo do texto do eixo horizontal.
setXAxisTitle(title)EmbeddedComboChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo do 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()EmbeddedComboChartBuilderTransforma 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 mudanças feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna o gráfico ContainerInfo, que encapsula onde ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que fornecem dados para este gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
reverseCategories()EmbeddedHistogramChartBuilderInverte a ordem das séries no eixo de domínio.
setBackgroundColor(cssValue)EmbeddedHistogramChartBuilderDefine a cor do plano de fundo do gráfico.
setChartType(type)EmbeddedChartBuilderMuda 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 do texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratados como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, mudando onde o gráfico aparece na planilha.
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 do texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico são transpostas.
setXAxisTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo do texto do eixo horizontal.
setXAxisTitle(title)EmbeddedHistogramChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo do 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()EmbeddedHistogramChartBuilderTransforma 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 mudanças feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna o gráfico ContainerInfo, que encapsula onde ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que fornecem dados para este gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
reverseCategories()EmbeddedLineChartBuilderInverte a ordem das séries no eixo de domínio.
setBackgroundColor(cssValue)EmbeddedLineChartBuilderDefine a cor do plano de fundo do gráfico.
setChartType(type)EmbeddedChartBuilderMuda 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 do texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratados 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, mudando onde o gráfico aparece na planilha.
setRange(start, end)EmbeddedLineChartBuilderDefine o intervalo do gráfico.
setTitle(chartTitle)EmbeddedLineChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedLineChartBuilderDefine o estilo do texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico são transpostas.
setXAxisTextStyle(textStyle)EmbeddedLineChartBuilderDefine o estilo do texto do eixo horizontal.
setXAxisTitle(title)EmbeddedLineChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedLineChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedLineChartBuilderDefine o estilo do 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()EmbeddedLineChartBuilderTransforma 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 mudanças feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna o gráfico ContainerInfo, que encapsula onde ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que fornecem dados para este gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
reverseCategories()EmbeddedPieChartBuilderInverte a ordem das séries no eixo de domínio.
set3D()EmbeddedPieChartBuilderDefine o gráfico como tridimensional.
setBackgroundColor(cssValue)EmbeddedPieChartBuilderDefine a cor do plano de fundo do gráfico.
setChartType(type)EmbeddedChartBuilderMuda 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 do texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratados como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, mudando onde o gráfico aparece na planilha.
setTitle(chartTitle)EmbeddedPieChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedPieChartBuilderDefine o estilo do texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e 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 mudanças feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna o gráfico ContainerInfo, que encapsula onde ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que fornecem dados para este gráfico.
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)EmbeddedChartBuilderMuda 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 do texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratados 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, mudando onde o gráfico aparece na planilha.
setTitle(chartTitle)EmbeddedScatterChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedScatterChartBuilderDefine o estilo do texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico são transpostas.
setXAxisLogScale()EmbeddedScatterChartBuilderTransforma 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 do texto do eixo horizontal.
setXAxisTitle(title)EmbeddedScatterChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedScatterChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisLogScale()EmbeddedScatterChartBuilderTransforma 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 do 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 mudanças feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este builder modifica.
enablePaging(enablePaging)EmbeddedTableChartBuilderDefine se a paginação dos dados será ativada.
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 da tabela a ser exibida (os números das páginas são baseados em zero).
enableRtlTable(rtlEnabled)EmbeddedTableChartBuilderAdiciona suporte básico para idiomas da direita para a esquerda (como árabe ou hebraico) invertendo a ordem das colunas da tabela. Assim, a coluna zero é a mais à direita, e a última coluna é a mais à esquerda.
enableSorting(enableSorting)EmbeddedTableChartBuilderDefine se as colunas serão classificadas quando o usuário clicar em um cabeçalho de coluna.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna o gráfico ContainerInfo, que encapsula onde ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que fornecem dados para este gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este builder modifica.
setChartType(type)EmbeddedChartBuilderMuda 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 de acordo com a qual a tabela deve ser classificada inicialmente (em ordem crescente).
setInitialSortingDescending(column)EmbeddedTableChartBuilderDefine o índice da coluna de acordo com a qual a tabela deve ser classificada inicialmente (em ordem decrescente).
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratados como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, mudando onde o gráfico aparece na planilha.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico são transpostas.
showRowNumberColumn(showRowNumber)EmbeddedTableChartBuilderDefine se o número da linha vai aparecer 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.
getRange()RangeRecebe o intervalo a que este filtro se aplica.
remove()voidRemove este filtro.
removeColumnFilterCriteria(columnPosition)FilterRemove os critérios 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 (o cabeçalho) no intervalo a que o filtro se aplica.

FilterCriteria

Métodos

MétodoTipo de retornoBreve descrição
copy()FilterCriteriaBuilderCopia esses critérios de filtro e cria um criador de critérios que pode ser aplicado a outro filtro.
getCriteriaType()BooleanCriteriaRetorna o tipo booleano dos critérios, por exemplo, 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 plano de fundo usada como critério de filtro.
getVisibleForegroundColor()ColorRetorna a cor de primeiro plano usada como um critério de filtro.
getVisibleValues()String[]Retorna os valores mostrados pelo filtro da tabela dinâmica.

FilterCriteriaBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()FilterCriteriaReúne os critérios de filtro usando as configurações adicionadas ao criador de critérios.
copy()FilterCriteriaBuilderCopia esses critérios de filtro e cria um criador de critérios que pode ser aplicado a outro filtro.
getCriteriaType()BooleanCriteriaRetorna o tipo booleano dos critérios, por exemplo, 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 plano de fundo usada como critério de filtro.
getVisibleForegroundColor()ColorRetorna a cor de primeiro plano usada como um critério de filtro.
getVisibleValues()String[]Retorna os valores mostrados pelo filtro da tabela dinâmica.
setHiddenValues(values)FilterCriteriaBuilderDefine os valores a serem ocultados.
setVisibleBackgroundColor(visibleBackgroundColor)FilterCriteriaBuilderDefine a cor de plano de fundo usada como critério de filtro.
setVisibleForegroundColor(visibleForegroundColor)FilterCriteriaBuilderDefine a cor de primeiro plano usada como critério de filtro.
setVisibleValues(values)FilterCriteriaBuilderDefine os valores a serem mostrados 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 células com datas posteriores à data relativa especificada.
whenDateBefore(date)FilterCriteriaBuilderDefine critérios de filtro que mostram células com datas anteriores à data 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 à data 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 são iguais à data especificada.
whenDateNotEqualToAny(dates)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com datas diferentes das 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 dois números especificados ou seja um deles.
whenNumberEqualTo(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número igual ao 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 está entre dois números especificados.
whenNumberNotEqualTo(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número diferente do especificado.
whenNumberNotEqualToAny(numbers)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número que não é igual a nenhum dos números especificados.
whenTextContains(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto que contém o 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 que não é igual a nenhum 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 para 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 semanalmente, em determinados dias da semana.
MONTHLYEnumAtualizar mensalmente nos dias especificados 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 para o 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 para o 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 para o 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()GroupFecha este grupo.
expand()GroupExpande este grupo.
getControlIndex()IntegerRetorna o índice de alternância de controle deste grupo.
getDepth()IntegerRetorna a profundidade deste grupo.
getRange()RangeRetorna o intervalo em que esse grupo existe.
isCollapsed()BooleanRetorna true se o grupo estiver fechado.
remove()voidRemove esse grupo da planilha, reduzindo a profundidade do grupo do range em um.

GroupControlTogglePosition

Propriedades

PropriedadeTipoDescrição
BEFOREEnumA posição em que a alternância de controle está antes do grupo (em índices mais baixos).
AFTEREnumA posição em que a chave de controle está após o grupo (em índices mais altos).

InterpolationType

Propriedades

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

LookerDataSourceSpec

Métodos

MétodoTipo de retornoBreve descrição
copy()DataSourceSpecBuilderCria um DataSourceSpecBuilder com base nas configurações dessa fonte de dados.
getExploreName()StringRecebe o nome da Análise do Looker no modelo.
getInstanceUrl()StringRecebe o URL da instância do Looker.
getModelName()StringRecebe o nome do modelo do Looker na instância.
getParameters()DataSourceParameter[]Recebe os parâmetros da fonte de dados.
getType()DataSourceTypeRecebe o tipo da fonte de dados.

LookerDataSourceSpecBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()DataSourceSpecCria uma especificação de fonte de dados com base nas configurações deste criador.
copy()DataSourceSpecBuilderCria um DataSourceSpecBuilder com base nas configurações dessa fonte de dados.
getExploreName()StringRecebe o nome da Análise do Looker no modelo.
getInstanceUrl()StringRecebe o URL da instância do Looker.
getModelName()StringRecebe o nome do modelo do Looker na instância.
getParameters()DataSourceParameter[]Recebe os parâmetros da fonte de dados.
getType()DataSourceTypeRecebe o tipo da fonte de dados.
removeAllParameters()LookerDataSourceSpecBuilderRemove todos os parâmetros.
removeParameter(parameterName)LookerDataSourceSpecBuilderRemove o parâmetro especificado.
setExploreName(exploreName)LookerDataSourceSpecBuilderDefine o nome da análise no modelo do Looker.
setInstanceUrl(instanceUrl)LookerDataSourceSpecBuilderDefine o URL da instância do Looker.
setModelName(modelName)LookerDataSourceSpecBuilderDefine o nome do modelo do Looker na instância do Looker.
setParameterFromCell(parameterName, sourceCell)LookerDataSourceSpecBuilderAdiciona um parâmetro ou, se o parâmetro com o nome existir, atualiza a célula de origem para criadores de especificações de fonte de dados do tipo DataSourceType.BIGQUERY.

NamedRange

Métodos

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

OverGridImage

Métodos

MétodoTipo de retornoBreve descrição
assignScript(functionName)OverGridImageAtribui a função com o nome especificado a esta imagem.
getAltTextDescription()StringRetorna a descrição do texto alternativo para esta imagem.
getAltTextTitle()StringRetorna o título do texto alternativo para esta imagem.
getAnchorCell()RangeRetorna a célula em que uma imagem está ancorada.
getAnchorCellXOffset()IntegerRetorna o deslocamento horizontal de pixels da célula de ancoragem.
getAnchorCellYOffset()IntegerRetorna o deslocamento vertical de pixels da célula de ancoragem.
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 a imagem aparece.
getWidth()IntegerRetorna a largura real da imagem em pixels.
remove()voidExclui a imagem da planilha.
replace(blob)OverGridImageSubstitui a imagem pela especificada no BlobSource fornecido.
replace(url)OverGridImageSubstitui a imagem pelo conteúdo do URL especificado.
resetSize()OverGridImageRedefine a imagem para as dimensões inerentes.
setAltTextDescription(description)OverGridImageDefine a descrição do texto alternativo para esta imagem.
setAltTextTitle(title)OverGridImageDefine o título do texto alternativo para esta imagem.
setAnchorCell(cell)OverGridImageDefine a célula em que uma imagem é ancorada.
setAnchorCellXOffset(offset)OverGridImageDefine o deslocamento horizontal de pixels da célula de ancoragem.
setAnchorCellYOffset(offset)OverGridImageDefine o deslocamento vertical de pixels da célula de ancoragem.
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 de filtro para este filtro de tabela dinâmica.
getPivotTable()PivotTableRetorna o PivotTable a que este filtro pertence.
getSourceDataColumn()IntegerRetorna o número da coluna de dados de origem em que este filtro opera.
getSourceDataSourceColumn()DataSourceColumnRetorna a coluna da fonte de dados em que o filtro opera.
remove()voidRemove esse filtro da tabela dinâmica.
setFilterCriteria(filterCriteria)PivotFilterDefine os critérios de filtragem para este filtro de tabela dinâmica.

PivotGroup

Métodos

MétodoTipo de retornoBreve descrição
addManualGroupingRule(groupName, groupMembers)PivotGroupAdiciona uma regra de agrupamento manual para esse grupo dinâmico.
areLabelsRepeated()BooleanRetorna se os rótulos são mostrados como repetidos.
clearGroupingRule()PivotGroupRemove todas as regras de agrupamento desse grupo dinâmico.
clearSort()PivotGroupRemove qualquer classificação aplicada a esse grupo.
getDateTimeGroupingRule()DateTimeGroupingRuleRetorna a regra de agrupamento de data e hora no grupo de pivô ou null se nenhuma regra de agrupamento de data e hora estiver definida.
getDimension()DimensionRetorna se este é um grupo de linhas ou colunas.
getGroupLimit()PivotGroupLimitRetorna o limite do grupo dinâmico no grupo dinâmico.
getIndex()IntegerRetorna o índice deste grupo de indicadores na ordem atual.
getPivotTable()PivotTableRetorna o PivotTable a que 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 de pivô opera.
hideRepeatedLabels()PivotGroupOculta rótulos repetidos para esse agrupamento.
isSortAscending()BooleanRetorna true se a classificação for crescente e false se for decrescente.
moveToIndex(index)PivotGroupMove esse grupo para a posição especificada na lista atual de grupos de linhas ou colunas.
remove()voidRemove esse grupo de pivô 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 no grupo dinâmico.
setHistogramGroupingRule(minValue, maxValue, intervalSize)PivotGroupDefine uma regra de agrupamento de histograma para esse grupo dinâmico.
showRepeatedLabels()PivotGroupQuando há mais de um agrupamento de linhas ou colunas, esse método mostra o marcador do agrupamento para cada entrada do agrupamento subsequente.
showTotals(showTotals)PivotGroupDefine se os valores totais desse grupo dinâmico serão mostrados na tabela.
sortAscending()PivotGroupDefine a ordem de classificação como crescente.
sortBy(value, oppositeGroupValues)PivotGroupClassifica esse grupo pelo PivotValue especificado para os valores de oppositeGroupValues.
sortDescending()PivotGroupDefine a ordem de classificação como decrescente.
totalsAreShown()BooleanRetorna se os valores totais estão sendo mostrados para este grupo de pivô.

PivotGroupLimit

Métodos

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

PivotTable

Métodos

MétodoTipo de retornoBreve descrição
addCalculatedPivotValue(name, formula)PivotValueCria um novo valor de pivô na tabela dinâmica calculado com base no formula especificado e no name especificado.
addColumnGroup(sourceDataColumn)PivotGroupDefine um novo agrupamento de colunas dinâmicas na tabela dinâmica.
addFilter(sourceDataColumn, filterCriteria)PivotFilterCria um filtro de dinamização para a tabela dinâmica.
addPivotValue(sourceDataColumn, summarizeFunction)PivotValueDefine um novo valor de coluna dinâmica na tabela dinâmica com o 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 ela estiver vinculada a um DataSource ou null caso contrário.
getAnchorCell()RangeRetorna o Range que representa a célula em que a tabela dinâmica está ancorada.
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 mostrados como linhas ou colunas.
remove()voidExclui a 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. Esse 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 DESVPADP
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 de pivô está sendo mostrado na tabela.
getFormula()StringRetorna a fórmula usada para calcular esse valor.
getPivotTable()PivotTableRetorna o PivotTable a que 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 desse valor na tabela dinâmica.
setFormula(formula)PivotValueDefine a fórmula usada para calcular esse valor.
showAs(displayType)PivotValueMostra 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_TOTALEnumMostra os valores de dinamização como uma porcentagem do total da linha.
PERCENT_OF_COLUMN_TOTALEnumMostra os valores de dinamização como uma porcentagem do total da coluna.
PERCENT_OF_GRAND_TOTALEnumMostra os valores de pivô como uma porcentagem do total geral.

Protection

Métodos

MétodoTipo de retornoBreve descrição
addEditor(emailAddress)ProtectionAdiciona o usuário especificado à lista de editores da planilha ou do intervalo protegido.
addEditor(user)ProtectionAdiciona o usuário especificado à lista de editores da planilha ou do intervalo protegido.
addEditors(emailAddresses)ProtectionAdiciona a matriz de usuários à lista de editores da planilha ou do intervalo protegido.
addTargetAudience(audienceId)ProtectionAdiciona o público-alvo especificado como 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 planilha 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()StringRecebe o nome do intervalo protegido se ele 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 "baseada em aviso".
remove()voidRemove a proteção do intervalo ou da 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 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.
setRange(range)ProtectionAjusta o intervalo que está sendo protegido.
setRangeName(rangeName)ProtectionAssocia o intervalo protegido a um intervalo nomeado.
setUnprotectedRanges(ranges)ProtectionRemove a proteção da matriz de intervalos especificada em uma página protegida.
setWarningOnly(warningOnly)ProtectionDefine se o intervalo protegido está usando a proteção "baseada em aviso".

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 active range, com a célula superior esquerda no intervalo como current cell.
activateAsCurrentCell()RangeDefine a célula especificada como current cell.
addDeveloperMetadata(key)RangeAdiciona metadados do desenvolvedor com a chave especificada ao intervalo.
addDeveloperMetadata(key, visibility)RangeAdiciona metadados do desenvolvedor com a chave e a visibilidade especificadas ao 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 padrão de faixa de coluna ao intervalo.
applyColumnBanding(bandingTheme)BandingAplica um tema de bandas de coluna especificado ao intervalo.
applyColumnBanding(bandingTheme, showHeader, showFooter)BandingAplica um tema de bandas de coluna especificado ao intervalo com configurações de cabeçalho e rodapé especificadas.
applyRowBanding()BandingAplica um tema padrão de faixa de linha ao intervalo.
applyRowBanding(bandingTheme)BandingAplica um tema de bandas de linha especificado ao intervalo.
applyRowBanding(bandingTheme, showHeader, showFooter)BandingAplica um tema de faixa de linha especificado ao intervalo com as configurações de cabeçalho e rodapé especificadas.
autoFill(destination, series)voidPreenche o destinationRange com dados com base nas informações desse intervalo.
autoFillToNeighbor(series)voidCalcula um intervalo para preencher com novos dados com base nas células vizinhas e preenche automaticamente esse intervalo com novos valores com base nos dados contidos nele.
breakApart()RangeDivida novamente as células de várias colunas no intervalo em células individuais.
canEdit()BooleanDetermina se o usuário tem permissão para editar todas as células no intervalo.
check()RangeMuda o estado das caixas de seleção no intervalo para "marcado".
clear()RangeLimpa o intervalo de conteúdo e formatos.
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 desse intervalo.
clearNote()RangeLimpa a observação na célula ou nas células especificadas.
collapseGroups()RangeRecolhe todos os grupos totalmente contidos no intervalo.
copyFormatToRange(gridId, column, columnEnd, row, rowEnd)voidCopia a formatação do intervalo para o local especificado.
copyFormatToRange(sheet, column, columnEnd, row, rowEnd)voidCopia a formatação do intervalo para o local especificado.
copyTo(destination)voidCopia os dados de um intervalo de células para outro.
copyTo(destination, copyPasteType, transposed)voidCopia os dados de um intervalo de células para outro.
copyTo(destination, options)voidCopia os dados de um intervalo de células para outro.
copyValuesToRange(gridId, column, columnEnd, row, rowEnd)voidCopie o conteúdo do intervalo para o local especificado.
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)voidCopie o conteúdo do intervalo para o local especificado.
createDataSourcePivotTable(dataSource)DataSourcePivotTableCria uma tabela dinâmica de fonte de dados vazia com base na fonte de dados, ancorada na primeira célula desse intervalo.
createDataSourceTable(dataSource)DataSourceTableCria uma tabela de fonte de dados vazia com base na fonte de dados, ancorada na primeira célula desse intervalo.
createDeveloperMetadataFinder()DeveloperMetadataFinderRetorna um DeveloperMetadataFinderApi para encontrar metadados do desenvolvedor no escopo desse intervalo.
createFilter()FilterCria um filtro e o aplica ao intervalo especificado na planilha.
createPivotTable(sourceData)PivotTableCria uma tabela dinâmica vazia com base no sourceData especificado, ancorada na primeira célula do intervalo.
createTextFinder(findText)TextFinderCria um localizador de texto para o intervalo, que pode encontrar e substituir texto nele.
deleteCells(shiftDimension)voidExclui esse intervalo de células.
expandGroups()RangeExpande os grupos recolhidos cujo intervalo ou alternância de controle se cruzam com este intervalo.
getA1Notation()StringRetorna uma descrição de string do intervalo na notação A1.
getBackground()StringRetorna a cor de fundo da célula superior esquerda no intervalo (por exemplo, '#ffffff').
getBackgroundObject()ColorRetorna a cor 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 em um intervalo.
getColumn()IntegerRetorna a posição da coluna inicial para esse 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 no intervalo ou null se a célula não contiver uma fórmula de fonte de dados.
getDataSourceFormulas()DataSourceFormula[]Retorna os DataSourceFormulas das células no intervalo.
getDataSourcePivotTables()DataSourcePivotTable[]Recebe todas as tabelas dinâmicas de fonte de dados que se cruzam com o intervalo.
getDataSourceTables()DataSourceTable[]Recebe todas as tabelas de origem de dados que se cruzam com o intervalo.
getDataSourceUrl()StringRetorna um URL para os dados nesse intervalo, que pode ser usado para criar gráficos e consultas.
getDataTable()DataTableRetorna os dados dentro desse objeto como uma DataTable.
getDataTable(firstRowIsHeader)DataTableRetorna os dados dentro desse intervalo como uma DataTable.
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 para todas as células no intervalo.
getDeveloperMetadata()DeveloperMetadata[]Recebe os metadados do desenvolvedor associados a esse intervalo.
getDisplayValue()StringRetorna o valor mostrado da célula superior esquerda no intervalo.
getDisplayValues()String[][]Retorna a grade retangular de valores para esse intervalo.
getFilter()FilterRetorna o filtro na planilha a que esse intervalo pertence ou null se não houver filtro na planilha.
getFontColorObject()ColorRetorna a cor da fonte da célula no canto superior esquerdo do intervalo.
getFontColorObjects()Color[][]Retorna as cores da fonte das células no intervalo.
getFontFamilies()String[][]Retorna as famílias de fontes das células no intervalo.
getFontFamily()StringRetorna a família de fontes da célula no canto superior esquerdo do intervalo.
getFontLine()StringRecebe o estilo da linha da célula no canto superior esquerdo do intervalo ('underline', 'line-through' ou 'none').
getFontLines()String[][]Recebe o estilo de linha das células no intervalo ('underline', 'line-through' ou 'none').
getFontSize()IntegerRetorna o tamanho da fonte em pontos 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 da 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 a espessura da fonte (normal/negrito) da célula no canto superior esquerdo do intervalo.
getFontWeights()String[][]Retorna as espessuras da fonte das células no intervalo.
getFormula()StringRetorna a fórmula (notação A1) da célula superior esquerda do intervalo ou uma string vazia se a célula estiver vazia ou não contiver 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 planilha mãe do intervalo.
getHeight()IntegerRetorna a altura do intervalo.
getHorizontalAlignment()StringRetorna o alinhamento horizontal do texto (esquerda/centralizado/direita) da célula no canto superior esquerdo do intervalo.
getHorizontalAlignments()String[][]Retorna os alinhamentos horizontais das células no 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 totalmente dentro do intervalo atual ou que contêm pelo menos uma célula no intervalo atual.
getNextDataCell(direction)RangeComeçando pela célula na primeira coluna e linha do intervalo, retorna a próxima célula na direção especificada que é a borda de um intervalo contíguo de células com dados ou a célula na borda da planilha nessa direção.
getNote()StringRetorna a observação 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()StringRecebe a formatação de número ou data da célula no canto superior esquerdo do intervalo especificado.
getNumberFormats()String[][]Retorna os formatos de número ou data das células no intervalo.
getRichTextValue()RichTextValueRetorna o valor de texto avançado da célula superior esquerda do intervalo ou null se o valor da célula não for texto.
getRichTextValues()RichTextValue[][]Retorna os valores de texto formatado das células no intervalo.
getRow()IntegerRetorna a posição da linha para esse intervalo.
getRowIndex()IntegerRetorna a posição da linha para esse intervalo.
getSheet()SheetRetorna a planilha a que esse intervalo pertence.
getTextDirection()TextDirectionRetorna a direção do texto da célula superior esquerda do intervalo.
getTextDirections()TextDirection[][]Retorna as direções 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/central/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 quebra de texto para as células no intervalo.
getWrapStrategy()WrapStrategyRetorna a estratégia de quebra de texto da célula superior esquerda do intervalo.
getWraps()Boolean[][]Retorna se o texto nas células é quebrado.
insertCells(shiftDimension)RangeInsere células vazias nesse intervalo.
insertCheckboxes()RangeInsere caixas de seleção em cada célula do intervalo, configuradas com true para marcadas e false para desmarcadas.
insertCheckboxes(checkedValue)RangeInsere caixas de seleção em cada célula do intervalo, configuradas com um valor personalizado para marcado e a string vazia para desmarcado.
insertCheckboxes(checkedValue, uncheckedValue)RangeInsere caixas de seleção em cada célula do intervalo, configuradas com valores personalizados para os estados marcados e desmarcados.
isBlank()BooleanRetorna true se o intervalo estiver totalmente em branco.
isChecked()BooleanRetorna se todas as células no intervalo têm o estado da caixa de seleção como "marcado".
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()BooleanRetorna true se as células no intervalo atual se sobrepuserem a células mescladas.
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 no intervalo em um único bloco.
mergeAcross()RangeMescla as células no intervalo em todas as colunas.
mergeVertically()RangeMescla as células no intervalo.
moveTo(target)voidCorte e cole (formato e valores) desse intervalo no intervalo de destino.
offset(rowOffset, columnOffset)RangeRetorna um novo intervalo que é deslocado deste intervalo pelo número de linhas e colunas especificado (que pode ser negativo).
offset(rowOffset, columnOffset, numRows)RangeRetorna um novo intervalo relativo ao atual, cujo ponto superior esquerdo é deslocado do intervalo atual pelas linhas e colunas fornecidas e com a altura especificada em 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 largura fornecidas em células.
protect()ProtectionCria um objeto que pode proteger o intervalo contra edições, exceto por usuários que têm permissão.
randomize()RangeAleatoriza a ordem das linhas no intervalo especificado.
removeCheckboxes()RangeRemove todas as caixas de seleção do intervalo.
removeDuplicates()RangeRemove as linhas dentro desse intervalo que contêm valores duplicados de valores em qualquer linha anterior.
removeDuplicates(columnsToCompare)RangeRemove as linhas dentro desse intervalo que contêm valores nas colunas especificadas que são duplicados de valores em qualquer linha anterior.
setBackground(color)RangeDefine a cor de plano de fundo de todas as células no intervalo na notação CSS (como '#ffffff' ou 'white').
setBackgroundObject(color)RangeDefine a cor 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 desse intervalo).
setBackgroundRGB(red, green, blue)RangeDefine o plano de fundo com 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 desse 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 desse intervalo).
setFontColors(colors)RangeDefine uma grade retangular de cores de fonte (precisa corresponder às dimensões desse 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 "Arial" ou "Helvetica".
setFontLine(fontLine)RangeDefine o estilo da linha da fonte do intervalo especificado ('underline', 'line-through' ou 'none').
setFontLines(fontLines)RangeDefine uma grade retangular de estilos de linha (precisa corresponder às dimensões desse intervalo).
setFontSize(size)RangeDefine o tamanho da fonte, que é o tamanho do ponto a ser usado.
setFontSizes(sizes)RangeDefine uma grade retangular de tamanhos de fontes (precisa corresponder às dimensões desse 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 desse intervalo).
setFontWeight(fontWeight)RangeDefine o peso da fonte para o intervalo especificado (normal/negrito).
setFontWeights(fontWeights)RangeDefine uma grade retangular de pesos de fontes (precisa corresponder às dimensões desse 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)RangeDefine o alinhamento horizontal (da esquerda para a direita) para o intervalo especificado (esquerda/centro/direita).
setHorizontalAlignments(alignments)RangeDefine uma grade retangular de alinhamentos horizontais.
setNote(note)RangeDefine a nota como o valor especificado.
setNotes(notes)RangeDefine uma grade retangular de notas (precisa corresponder às dimensões desse intervalo).
setNumberFormat(numberFormat)RangeDefine o formato de número ou data para a string de formatação especificada.
setNumberFormats(numberFormats)RangeDefine uma grade retangular de formatos de número ou data (precisa corresponder às dimensões desse intervalo).
setRichTextValue(value)RangeDefine o valor de rich text para as células no 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 para as células no intervalo.
setTextDirections(directions)RangeDefine uma grade retangular de direções de texto.
setTextRotation(degrees)RangeDefine as configurações de rotação do texto para as células no intervalo.
setTextRotation(rotation)RangeDefine as configurações de rotação do texto para as células no intervalo.
setTextRotations(rotations)RangeDefine uma grade retangular de rotações de texto.
setTextStyle(style)RangeDefine o estilo do texto para as 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 retangular de valores (precisa corresponder às dimensões desse intervalo).
setVerticalAlignment(alignment)RangeDefina o alinhamento vertical (de cima para baixo) para o intervalo especificado (parte de cima/meio/parte de baixo).
setVerticalAlignments(alignments)RangeDefine uma grade retangular de alinhamentos verticais (precisa corresponder às dimensões desse intervalo).
setVerticalText(isVertical)RangeDefine se o texto das células no intervalo será empilhado ou não.
setWrap(isWrapEnabled)RangeDefine o ajuste de texto da célula do intervalo especificado.
setWrapStrategies(strategies)RangeDefine uma grade retangular de estratégias de ajuste de texto.
setWrapStrategy(strategy)RangeDefine a estratégia de quebra de texto para as células no intervalo.
setWraps(isWrapEnabled)RangeDefine uma grade retangular de políticas de quebra de texto (precisa corresponder às dimensões desse intervalo).
shiftColumnGroupDepth(delta)RangeMuda a profundidade do agrupamento de colunas do intervalo pela quantidade especificada.
shiftRowGroupDepth(delta)RangeMuda a profundidade do agrupamento de linhas do intervalo na quantidade especificada.
sort(sortSpecObj)RangeClassifica as células no intervalo especificado por coluna e ordem.
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()RangeRemove os espaços em branco (como espaços, tabulações ou novas linhas) em todas as células 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 Range.
breakApart()RangeListDivida todas as células mescladas horizontal ou verticalmente contidas 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údos, 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, mantendo 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 de cada Range na lista de intervalos.
getRanges()Range[]Retorna uma lista de uma ou mais instâncias Range na mesma planilha.
insertCheckboxes()RangeListInsere caixas de seleção em cada célula do intervalo, configuradas com true para marcadas e false para desmarcadas.
insertCheckboxes(checkedValue)RangeListInsere caixas de seleção em cada célula do intervalo, configuradas com um valor personalizado para marcado e a string vazia para desmarcado.
insertCheckboxes(checkedValue, uncheckedValue)RangeListInsere caixas de seleção em cada célula do intervalo, configuradas com valores personalizados para os estados marcados e desmarcados.
removeCheckboxes()RangeListRemove todas as caixas de seleção do intervalo.
setBackground(color)RangeListDefine a cor de fundo para cada Range na lista de intervalos.
setBackgroundRGB(red, green, blue)RangeListDefine o plano de fundo com a cor RGB especificada.
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 para 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 da fonte para cada Range na lista de intervalos.
setFontWeight(fontWeight)RangeListDefina a espessura da fonte para cada Range na lista de intervalos.
setFormula(formula)RangeListAtualiza a fórmula para cada Range na lista de intervalos.
setFormulaR1C1(formula)RangeListAtualiza a fórmula para cada Range na lista de intervalos.
setHorizontalAlignment(alignment)RangeListDefina o alinhamento horizontal para cada Range na lista de intervalos.
setNote(note)RangeListDefine o texto da observação para cada Range na lista de intervalos.
setNumberFormat(numberFormat)RangeListDefine o formato de número ou data para cada Range na lista de intervalos.
setShowHyperlink(showHyperlink)RangeListDefine se cada Range na lista de intervalos deve mostrar hiperlinks.
setTextDirection(direction)RangeListDefine a direção do texto para as células em cada Range na 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 o texto das células de cada Range na lista de intervalos será empilhado.
setWrap(isWrapEnabled)RangeListDefina o ajuste de texto para cada Range na lista de intervalos.
setWrapStrategy(strategy)RangeListDefine a estratégia de quebra de texto para cada Range na lista de intervalos.
trimWhitespace()RangeListRemove o espaço em branco (como espaços, tabulações ou novas linhas) de todas as células na lista de intervalos.
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 forem alterados e a cada minuto.
HOUREnumRecalcular quando os valores forem alterados e a cada hora.

RelativeDate

Propriedades

PropriedadeTipoDescrição
TODAYEnumDatas comparadas com a data atual.
TOMORROWEnumDatas comparadas com a data posterior à atual.
YESTERDAYEnumDatas comparadas com a data anterior à atual.
PAST_WEEKEnumDatas que estão dentro do período da semana passada.
PAST_MONTHEnumDatas que estão dentro do período do mês passado.
PAST_YEAREnumDatas que estão dentro do 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 deste 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 para o texto de startOffset a endOffset.
getRuns()RichTextValue[]Retorna a string de rich text dividida em uma matriz de execuções, em que cada execução é a maior substring 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 com base neste builder.
setLinkUrl(startOffset, endOffset, linkUrl)RichTextValueBuilderDefine o URL do link para a determinada substring desse valor ou o limpa 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 para esse valor e limpa qualquer estilo de texto atual.
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 planilha ativa ou null se não houver um intervalo ativo.
getActiveRangeList()RangeListRetorna a lista de intervalos ativos na planilha ativa ou null se não houver intervalos ativos.
getActiveSheet()SheetRetorna a página ativa na planilha.
getCurrentCell()RangeRetorna a célula atual (destacada) selecionada em um dos intervalos ativos ou null se não houver uma célula atual.
getNextDataRange(direction)RangeComeçando em current cell e active range e movendo-se na direção especificada, retorna um intervalo ajustado em que a borda apropriada do intervalo foi movida para cobrir next data cell, mas ainda cobrindo a célula atual.

Sheet

Métodos

MétodoTipo de retornoBreve descrição
activate()SheetAtiva a página.
addDeveloperMetadata(key)SheetAdiciona metadados do desenvolvedor com a chave especificada à planilha.
addDeveloperMetadata(key, visibility)SheetAdiciona metadados do desenvolvedor com a chave e a visibilidade especificadas à planilha.
addDeveloperMetadata(key, value)SheetAdiciona metadados do desenvolvedor com a chave e o valor especificados à planilha.
addDeveloperMetadata(key, value, visibility)SheetAdiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados à planilha.
appendRow(rowContents)SheetAcrescenta uma linha à parte de baixo da região de dados atual na planilha.
asDataSourceSheet()DataSourceSheetRetorna a planilha como um DataSourceSheet se ela for do tipo SheetType.DATASOURCE. Caso contrário, retorna null.
autoResizeColumn(columnPosition)SheetDefine a largura da coluna especificada para ajustar o conteúdo.
autoResizeColumns(startColumn, numColumns)SheetDefine a largura de todas as colunas a partir da posição especificada para ajustar o conteúdo delas.
autoResizeRows(startRow, numRows)SheetDefine a altura de todas as linhas a partir da posição especificada para ajustar o conteúdo.
clear()SheetLimpa o conteúdo e as informações de formatação da planilha.
clear(options)SheetLimpa o conteúdo e/ou o formato da planilha, conforme especificado nas opções avançadas.
clearConditionalFormatRules()voidRemove todas as regras de formatação condicional da planilha.
clearContents()SheetLimpa o conteúdo da planilha, preservando as informações de formatação.
clearFormats()SheetLimpa a formatação da planilha, preservando o conteúdo.
clearNotes()SheetLimpa todas as anotações da planilha.
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 origem.
createDeveloperMetadataFinder()DeveloperMetadataFinderRetorna um DeveloperMetadataFinder para encontrar metadados do desenvolvedor no escopo desta planilha.
createTextFinder(findText)TextFinderCria um localizador de texto para a planilha, que pode encontrar e substituir texto nela.
deleteColumn(columnPosition)SheetExclui a coluna na posição especificada.
deleteColumns(columnPosition, howMany)voidExclui um número de colunas a partir da posição de coluna especificada.
deleteRow(rowPosition)SheetExclui a linha na posição especificada.
deleteRows(rowPosition, howMany)voidExclui um número de linhas a partir da posição de linha especificada.
expandAllColumnGroups()SheetExpande todos os grupos de colunas na página.
expandAllRowGroups()SheetExpande todos os grupos de linhas na página.
expandColumnGroupsUpToDepth(groupDepth)SheetExpande 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 na planilha.
getActiveRange()RangeRetorna o intervalo selecionado na planilha ativa ou null se não houver um intervalo ativo.
getActiveRangeList()RangeListRetorna a lista de intervalos ativos na planilha ativa ou null se não houver intervalos ativos.
getBandings()Banding[]Retorna todas as bandas nesta planilha.
getCharts()EmbeddedChart[]Retorna uma matriz de gráficos nesta página.
getColumnGroup(columnIndex, groupDepth)GroupRetorna o grupo de colunas no índice e na profundidade de grupo especificados.
getColumnGroupControlPosition()GroupControlTogglePositionRetorna o GroupControlTogglePosition de todos os grupos de colunas na planilha.
getColumnGroupDepth(columnIndex)IntegerRetorna a profundidade do grupo da coluna no índice especificado.
getColumnWidth(columnPosition)IntegerRecebe a largura em pixels da coluna especificada.
getConditionalFormatRules()ConditionalFormatRule[]Recebe todas as regras de formatação condicional nesta planilha.
getCurrentCell()RangeRetorna a célula atual na planilha 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 de fonte de dados.
getDataSourcePivotTables()DataSourcePivotTable[]Recebe todas as tabelas dinâmicas de fonte de dados.
getDataSourceTables()DataSourceTable[]Recebe todas as tabelas de fonte de dados.
getDeveloperMetadata()DeveloperMetadata[]Recebe todos os metadados do desenvolvedor associados a esta planilha.
getDrawings()Drawing[]Retorna uma matriz de desenhos na planilha.
getFilter()FilterRetorna o filtro nesta planilha ou null se não houver um.
getFormUrl()StringRetorna o URL do formulário que envia as respostas para esta planilha ou null se a planilha não tiver um formulário associado.
getFrozenColumns()IntegerRetorna o número de colunas fixas.
getFrozenRows()IntegerRetorna o número de linhas fixadas.
getImages()OverGridImage[]Retorna todas as imagens sobrepostas na planilha.
getIndex()IntegerRecebe a posição da página na planilha mãe.
getLastColumn()IntegerRetorna a posição da última coluna com conteúdo.
getLastRow()IntegerRetorna a posição da última linha com conteúdo.
getMaxColumns()IntegerRetorna o número atual de colunas na planilha, independente do conteúdo.
getMaxRows()IntegerRetorna o número atual de linhas na planilha, independente do conteúdo.
getName()StringRetorna o nome da página.
getNamedRanges()NamedRange[]Recebe todos os intervalos nomeados nesta planilha.
getParent()SpreadsheetRetorna o Spreadsheet que contém essa planilha.
getPivotTables()PivotTable[]Retorna todas as tabelas dinâmicas na planilha.
getProtections(type)Protection[]Recebe uma matriz de objetos que representam todos os intervalos protegidos na planilha ou uma matriz de elemento único que representa a proteção na própria planilha.
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 fornecidas e com o número de linhas especificado.
getRange(row, column, numRows, numColumns)RangeRetorna o intervalo com a célula superior esquerda nas coordenadas fornecidas e com o número de linhas e colunas especificado.
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 especificados por uma lista não vazia de notações A1 ou R1C1.
getRowGroup(rowIndex, groupDepth)GroupRetorna o grupo de linhas no índice e na profundidade de grupo especificados.
getRowGroupControlPosition()GroupControlTogglePositionRetorna o GroupControlTogglePosition de todos os grupos de linhas na planilha.
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, começando nas coordenadas especificadas.
getSlicers()Slicer[]Retorna uma matriz de segmentações na planilha.
getTabColorObject()ColorRecebe a cor da guia da planilha ou null se ela não tiver uma cor.
getType()SheetTypeRetorna o tipo da planilha.
hasHiddenGridlines()BooleanRetorna true se as linhas de grade da planilha estiverem ocultas. Caso contrário, retorna false.
hideColumn(column)voidOculta a coluna ou as colunas no intervalo especificado.
hideColumns(columnIndex)voidOculta uma única coluna no índice especificado.
hideColumns(columnIndex, numColumns)voidOculta uma ou mais colunas consecutivas a partir do í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 a partir do índice especificado.
hideSheet()SheetOculta esta página.
insertChart(chart)voidAdiciona um novo gráfico à página.
insertColumnAfter(afterPosition)SheetInsere uma coluna após a posição da coluna especificada.
insertColumnBefore(beforePosition)SheetInsere uma coluna antes da posição especificada.
insertColumns(columnIndex)voidInsere uma coluna em branco em uma planilha no local especificado.
insertColumns(columnIndex, numColumns)voidInsere uma ou mais colunas em branco consecutivas em uma planilha a partir do local especificado.
insertColumnsAfter(afterPosition, howMany)SheetInsere um determinado número de colunas após a posição de coluna especificada.
insertColumnsBefore(beforePosition, howMany)SheetInsere um número de colunas antes da posição de coluna especificada.
insertImage(blobSource, column, row)OverGridImageInsere um 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 especificada.
insertRowBefore(beforePosition)SheetInsere uma linha antes da posição especificada.
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 planilha a partir do local especificado.
insertRowsAfter(afterPosition, howMany)SheetInsere um número de linhas após a posição de linha especificada.
insertRowsBefore(beforePosition, howMany)SheetInsere um número de linhas antes da posição de linha especificada.
insertSlicer(range, anchorRowPos, anchorColPos)SlicerAdiciona um novo segmentador a esta página.
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)SlicerAdiciona um novo segmentador a esta página.
isColumnHiddenByUser(columnPosition)BooleanRetorna se a coluna especificada está oculta para o usuário.
isRightToLeft()BooleanRetorna true se o layout da planilha for da direita para a esquerda.
isRowHiddenByFilter(rowPosition)BooleanRetorna se a linha especificada está oculta por um filtro (não uma visualização de filtro).
isRowHiddenByUser(rowPosition)BooleanRetorna se a linha especificada está oculta para o usuário.
isSheetHidden()BooleanRetorna true se a planilha 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 planilha.
protect()ProtectionCria um objeto que pode proteger a planilha contra edições, exceto por usuários que têm permissão.
removeChart(chart)voidRemove um gráfico da planilha principal.
setActiveRange(range)RangeDefine o intervalo especificado como o active range na planilha ativa, com a célula superior esquerda no intervalo como o current cell.
setActiveRangeList(rangeList)RangeListDefine a lista especificada de intervalos como o active ranges na página ativa.
setActiveSelection(range)RangeDefine a região de seleção ativa para esta planilha.
setActiveSelection(a1Notation)RangeDefine a seleção ativa, conforme especificado na notação A1 ou R1C1.
setColumnGroupControlPosition(position)SheetDefine a posição da alternância de controle do grupo de colunas na planilha.
setColumnWidth(columnPosition, width)SheetDefine a largura da coluna especificada em pixels.
setColumnWidths(startColumn, numColumns, width)SheetDefine a largura das colunas especificadas em pixels.
setConditionalFormatRules(rules)voidSubstitui todas as regras de formatação condicional atuais na planilha pelas regras de entrada.
setCurrentCell(cell)RangeDefine a célula especificada como current cell.
setFrozenColumns(columns)voidCongela o número de colunas especificado.
setFrozenRows(rows)voidCongela o número de linhas especificado.
setHiddenGridlines(hideGridlines)SheetOculta ou mostra as linhas de grade da página.
setName(name)SheetDefine o nome da página.
setRightToLeft(rightToLeft)SheetDefine ou remove o layout da página da direita para a esquerda.
setRowGroupControlPosition(position)SheetDefine a posição da opção de ativar/desativar o controle do grupo de linhas na planilha.
setRowHeight(rowPosition, height)SheetDefine a altura da linha especificada em pixels.
setRowHeights(startRow, numRows, height)SheetDefine a altura das linhas especificadas em pixels.
setRowHeightsForced(startRow, numRows, height)SheetDefine a altura das linhas especificadas em pixels.
setTabColor(color)SheetDefine a cor da guia da planilha.
setTabColorObject(color)SheetDefine a cor da guia da planilha.
showColumns(columnIndex)voidMostra a coluna no índice especificado.
showColumns(columnIndex, numColumns)voidMostra uma ou mais colunas consecutivas a partir do índice especificado.
showRows(rowIndex)voidMostra a linha no índice especificado.
showRows(rowIndex, numRows)voidMostra uma ou mais linhas consecutivas a partir do índice especificado.
showSheet()SheetTorna a planilha visível.
sort(columnPosition)SheetClassifica uma página por coluna, em ordem crescente.
sort(columnPosition, ascending)SheetClassifica uma página por coluna.
unhideColumn(column)voidMostra a coluna no intervalo especificado.
unhideRow(row)voidMostra a linha no intervalo especificado.
updateChart(chart)voidAtualiza o gráfico nesta planilha.

SheetType

Propriedades

PropriedadeTipoDescrição
GRIDEnumUma planilha com uma grade.
OBJECTEnumUma planilha que contém um único objeto incorporado, como um EmbeddedChart.
DATASOURCEEnumUma página que contém um DataSource.

Slicer

Métodos

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

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 plano de fundo usada para a classificação ou null se ela não estiver presente.
getDataSourceColumn()DataSourceColumnRecebe a coluna da fonte de dados em que a especificação de classificação atua.
getDimensionIndex()IntegerRetorna o índice da dimensão ou null se não estiver vinculado a um filtro local.
getForegroundColor()ColorRetorna a cor de primeiro plano usada para classificação ou null se ela não estiver presente.
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 do desenvolvedor com a chave especificada à planilha de nível superior.
addDeveloperMetadata(key, visibility)SpreadsheetAdiciona metadados do desenvolvedor com a chave e a visibilidade especificadas à planilha.
addDeveloperMetadata(key, value)SpreadsheetAdiciona metadados do 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 do Spreadsheet.
addEditor(user)SpreadsheetAdiciona o usuário especificado à lista de editores do Spreadsheet.
addEditors(emailAddresses)SpreadsheetAdiciona a matriz de usuários à lista de editores do Spreadsheet.
addMenu(name, subMenus)voidCria um novo menu na interface das Planilhas Google.
addViewer(emailAddress)SpreadsheetAdiciona o usuário especificado à lista de leitores do Spreadsheet.
addViewer(user)SpreadsheetAdiciona o usuário especificado à lista de leitores do Spreadsheet.
addViewers(emailAddresses)SpreadsheetAdiciona a matriz de usuários à lista de leitores do Spreadsheet.
appendRow(rowContents)SheetAcrescenta uma linha à parte de baixo da região de dados atual na planilha.
autoResizeColumn(columnPosition)SheetDefine a largura da coluna especificada para ajustar o 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)TextFinderCria um localizador de texto para a planilha, que pode ser usado para encontrar e substituir texto nela.
deleteActiveSheet()SheetExclui a planilha ativa no momento.
deleteColumn(columnPosition)SheetExclui a coluna na posição especificada.
deleteColumns(columnPosition, howMany)voidExclui um número de colunas a partir da posição de coluna especificada.
deleteRow(rowPosition)SheetExclui a linha na posição especificada.
deleteRows(rowPosition, howMany)voidExclui um número de linhas a partir da posição de linha especificada.
deleteSheet(sheet)voidExclui a planilha especificada.
duplicateActiveSheet()SheetDuplica a planilha ativa e a torna a planilha ativa.
getActiveCell()RangeRetorna a célula ativa na planilha.
getActiveRange()RangeRetorna o intervalo selecionado na planilha ativa ou null se não houver um intervalo ativo.
getActiveRangeList()RangeListRetorna a lista de intervalos ativos na planilha ativa ou null se não houver intervalos ativos.
getActiveSheet()SheetRecebe a página 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()BlobRetorna os dados dentro desse objeto como um blob.
getColumnWidth(columnPosition)IntegerRecebe a largura em pixels da coluna especificada.
getCurrentCell()RangeRetorna a célula atual na planilha 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 de fonte de dados.
getDataSourcePivotTables()DataSourcePivotTable[]Recebe todas as tabelas dinâmicas de fonte de dados.
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]Recebe as programações de atualização da planilha.
getDataSourceSheets()DataSourceSheet[]Retorna todas as páginas de fonte de dados na planilha.
getDataSourceTables()DataSourceTable[]Recebe todas as tabelas de fonte de dados.
getDataSources()DataSource[]Retorna todas as fontes de dados na planilha.
getDeveloperMetadata()DeveloperMetadata[]Recebe os metadados do desenvolvedor associados à planilha de nível superior.
getEditors()User[]Recebe a lista de editores para este Spreadsheet.
getFormUrl()StringRetorna o URL do formulário que envia as respostas para esta planilha ou null se a planilha não tiver um formulário associado.
getFrozenColumns()IntegerRetorna o número de colunas fixas.
getFrozenRows()IntegerRetorna o número de linhas fixadas.
getId()StringRecebe um identificador exclusivo para esta planilha.
getImages()OverGridImage[]Retorna todas as imagens sobrepostas na planilha.
getIterativeCalculationConvergenceThreshold()NumberRetorna o valor de limite usado durante o cálculo iterativo.
getLastColumn()IntegerRetorna a posição da última coluna com conteúdo.
getLastRow()IntegerRetorna a posição da última linha com 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[]Recebe todos os intervalos nomeados na planilha.
getNumSheets()IntegerRetorna o número de páginas na 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 planilhas protegidos na planilha.
getRange(a1Notation)RangeRetorna o intervalo conforme especificado na notação A1 ou R1C1.
getRangeByName(name)RangeRetorna um intervalo nomeado ou null se nenhum intervalo com o nome especificado for encontrado.
getRangeList(a1Notations)RangeListRetorna a coleção RangeList que representa os intervalos na mesma planilha especificados por uma lista não vazia de notações A1 ou R1C1.
getRecalculationInterval()RecalculationIntervalRetorna o intervalo de cálculo para esta planilha.
getRowHeight(rowPosition)IntegerRecebe a altura em pixels da linha especificada.
getSelection()SelectionRetorna o Selection atual na planilha.
getSheetById(id)SheetRecebe a página com o ID especificado.
getSheetByName(name)SheetRetorna uma planilha com o nome especificado.
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, começando nas coordenadas especificadas.
getSheets()Sheet[]Recebe todas as páginas da 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 leitores e comentaristas deste Spreadsheet.
hideColumn(column)voidOculta a coluna ou as colunas no intervalo especificado.
hideRow(row)voidOculta as linhas no intervalo especificado.
insertColumnAfter(afterPosition)SheetInsere uma coluna após a posição da coluna especificada.
insertColumnBefore(beforePosition)SheetInsere uma coluna antes da posição especificada.
insertColumnsAfter(afterPosition, howMany)SheetInsere um determinado número de colunas após a posição de coluna especificada.
insertColumnsBefore(beforePosition, howMany)SheetInsere um número de colunas antes da posição de coluna especificada.
insertDataSourceSheet(spec)DataSourceSheetInsere um novo DataSourceSheet na planilha e inicia a execução de dados.
insertImage(blobSource, column, row)OverGridImageInsere um 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 especificada.
insertRowBefore(beforePosition)SheetInsere uma linha antes da posição especificada.
insertRowsAfter(afterPosition, howMany)SheetInsere um número de linhas após a posição de linha especificada.
insertRowsBefore(beforePosition, howMany)SheetInsere um número de linhas antes da posição de linha especificada.
insertSheet()SheetInsere uma nova página na planilha usando um nome 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 padrão e argumentos avançados opcionais.
insertSheet(sheetName)SheetInsere uma nova página na planilha com o nome especificado.
insertSheet(sheetName, sheetIndex)SheetInsere uma nova página na planilha com o nome e o índice especificados.
insertSheet(sheetName, sheetIndex, options)SheetInsere uma nova planilha na planilha com o nome e o índice especificados e usa argumentos avançados opcionais.
insertSheet(sheetName, options)SheetInsere uma nova página na planilha com o nome especificado e usa argumentos avançados opcionais.
insertSheetWithDataSourceTable(spec)SheetInsere uma nova planilha na planilha, cria um DataSourceTable que abrange toda a planilha com a especificação de fonte de dados fornecida e inicia a execução de dados.
isColumnHiddenByUser(columnPosition)BooleanRetorna se a coluna especificada está oculta para o usuário.
isIterativeCalculationEnabled()BooleanRetorna se o cálculo iterativo está ativado nesta planilha.
isRowHiddenByFilter(rowPosition)BooleanRetorna se a linha especificada está oculta por um filtro (não uma visualização de filtro).
isRowHiddenByUser(rowPosition)BooleanRetorna se a linha especificada está oculta para o usuário.
moveActiveSheet(pos)voidMove a planilha ativa para a posição especificada na lista de planilhas.
moveChartToObjectSheet(chart)SheetCria uma nova planilha 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 os objetos inválidos.
removeEditor(emailAddress)SpreadsheetRemove o usuário especificado da lista de editores do Spreadsheet.
removeEditor(user)SpreadsheetRemove o usuário especificado da lista de editores do Spreadsheet.
removeMenu(name)voidRemove um menu adicionado por addMenu(name, subMenus).
removeNamedRange(name)voidExclui um intervalo nomeado com o nome especificado.
removeViewer(emailAddress)SpreadsheetRemove o usuário especificado da lista de leitores e comentaristas do Spreadsheet.
removeViewer(user)SpreadsheetRemove o usuário especificado da lista de leitores e comentaristas do Spreadsheet.
rename(newName)voidRenomeia o documento.
renameActiveSheet(newName)voidRenomeia a planilha ativa atual com o novo nome especificado.
resetSpreadsheetTheme()SpreadsheetThemeRemove o tema aplicado e define o tema padrão na planilha.
setActiveRange(range)RangeDefine o intervalo especificado como o active range na planilha ativa, com a célula superior esquerda no intervalo como o current cell.
setActiveRangeList(rangeList)RangeListDefine a lista especificada de intervalos como o active ranges na página ativa.
setActiveSelection(range)RangeDefine a região de seleção ativa para esta planilha.
setActiveSelection(a1Notation)RangeDefine a seleção ativa, conforme especificado na notação A1 ou R1C1.
setActiveSheet(sheet)SheetDefine a planilha especificada como a planilha ativa na pasta de trabalho.
setActiveSheet(sheet, restoreSelection)SheetDefine a planilha especificada como a planilha ativa na planilha, com uma opção para restaurar a seleção mais recente nessa planilha.
setColumnWidth(columnPosition, width)SheetDefine a largura da coluna especificada em pixels.
setCurrentCell(cell)RangeDefine a célula especificada como current cell.
setFrozenColumns(columns)voidCongela o número de colunas especificado.
setFrozenRows(rows)voidCongela o número de linhas especificado.
setIterativeCalculationConvergenceThreshold(minThreshold)SpreadsheetDefine o valor mínimo de limite 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 devem ser realizadas durante o cálculo iterativo.
setNamedRange(name, range)voidNomeia um intervalo.
setRecalculationInterval(recalculationInterval)SpreadsheetDefine a frequência com que a planilha precisa ser recalculada.
setRowHeight(rowPosition, height)SheetDefine a altura da linha especificada 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)voidMostra 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 especificados.
toast(msg, title, timeoutSeconds)voidMostra uma janela pop-up no canto inferior direito da planilha com o título e a mensagem especificados, que fica visível por um determinado período.
unhideColumn(column)voidMostra a coluna no intervalo especificado.
unhideRow(row)voidMostra a linha no intervalo especificado.
updateMenu(name, subMenus)voidAtualiza um cardápio adicionado por addMenu(name, subMenus).
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidAguarde até que todas as execuções atuais na planilha sejam concluídas, atingindo 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 valores preenchidos automaticamente.
BandingThemeBandingThemeUma enumeração dos possíveis temas de banding.
BooleanCriteriaBooleanCriteriaUma enumeração de critérios booleanos de formatação condicional.
BorderStyleBorderStyleUma enumeração dos estilos válidos para definir bordas em um Range.
ColorTypeColorTypeUma enumeração de possíveis tipos de cores.
CopyPasteTypeCopyPasteTypeUma enumeração dos tipos de colagem possíveis.
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 de fonte de dados.
DataSourceRefreshScopeDataSourceRefreshScopeUma enumeração dos possíveis escopos de atualização da fonte de dados.
DataSourceTypeDataSourceTypeUma enumeração dos tipos de fontes de dados possíveis.
DataValidationCriteriaDataValidationCriteriaUma enumeração que representa os critérios de validação de dados que podem ser definidos em um intervalo.
DateTimeGroupingRuleTypeDateTimeGroupingRuleTypeUma enumeração de regra de agrupamento de data e hora.
DeveloperMetadataLocationTypeDeveloperMetadataLocationTypeUma enumeração dos possíveis tipos de local de 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 direções em que é possível se mover em uma planilha usando as teclas de seta.
FrequencyTypeFrequencyTypeUma enumeração de possíveis tipos de frequência.
GroupControlTogglePositionGroupControlTogglePositionUma enumeração das posições em que a alternância de controle de grupo pode estar.
InterpolationTypeInterpolationTypeUma enumeração de tipos de interpolação de gradiente de formatação condicional.
PivotTableSummarizeFunctionPivotTableSummarizeFunctionUma enumeração das funções que podem ser usadas para resumir valores em uma tabela dinâmica.
PivotValueDisplayTypePivotValueDisplayTypeUma enumeração das maneiras como um valor de pivô 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 da planilha.
RelativeDateRelativeDateUma enumeração de opções de data relativa para calcular um valor a ser usado em BooleanCriteria com base em datas.
SheetTypeSheetTypeUma enumeração dos diferentes tipos de páginas que podem existir em uma planilha.
SortOrderSortOrderUma enumeração da ordem de classificação.
TextDirectionTextDirectionUma enumeração de rotas em texto válidas.
TextToColumnsDelimiterTextToColumnsDelimiterUma enumeração dos delimitadores predefinidos para dividir texto em colunas.
ThemeColorTypeThemeColorTypeUma enumeração de possíveis tipos de cores de tema.
ValueTypeValueTypeUma enumeração de tipos de valores retornados por Range.getValue() e Range.getValues() da classe Range do serviço de planilha.
WrapStrategyWrapStrategyUma enumeração das estratégias usadas para ajustar células.

Métodos

MétodoTipo de retornoBreve descrição
create(name)SpreadsheetCria uma planilha com o nome especificado.
create(name, rows, columns)SpreadsheetCria uma planilha com o nome e o número de linhas e colunas especificados.
enableAllDataSourcesExecution()voidAtiva a execução de dados para todos os tipos de fontes de dados.
enableBigQueryExecution()voidAtiva a execução de dados para fontes de dados do BigQuery.
enableLookerExecution()voidAtiva a execução de dados para fontes de dados do Looker.
flush()voidAplica todas as mudanças pendentes na planilha.
getActive()SpreadsheetRetorna a planilha ativa no momento ou null se não houver nenhuma.
getActiveRange()RangeRetorna o intervalo selecionado na planilha ativa ou null se não houver um intervalo ativo.
getActiveRangeList()RangeListRetorna a lista de intervalos ativos na planilha ativa ou null se não houver intervalos selecionados.
getActiveSheet()SheetRecebe a página ativa em uma planilha.
getActiveSpreadsheet()SpreadsheetRetorna a planilha ativa no momento ou null se não houver nenhuma.
getCurrentCell()RangeRetorna a célula atual (destacada) selecionada em um dos intervalos ativos na planilha ativa ou 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 ao script adicionar recursos como menus, caixas de diálogo e barras laterais.
newCellImage()CellImageBuilderCria um builder para um CellImage.
newColor()ColorBuilderCria um builder para um Color.
newConditionalFormatRule()ConditionalFormatRuleBuilderCria um builder para uma regra de formatação condicional.
newDataSourceSpec()DataSourceSpecBuilderCria um builder para um DataSourceSpec.
newDataValidation()DataValidationBuilderCria um builder para uma regra de validação de dados.
newFilterCriteria()FilterCriteriaBuilderCria um builder para um FilterCriteria.
newRichTextValue()RichTextValueBuilderCria um builder para um valor de rich text.
newTextStyle()TextStyleBuilderCria um builder para um estilo de texto.
open(file)SpreadsheetAbre a planilha que corresponde ao objeto de arquivo especificado.
openById(id)SpreadsheetAbre a planilha com o ID especificado.
openByUrl(url)SpreadsheetAbre a planilha com o URL especificado.
setActiveRange(range)RangeDefine o intervalo especificado como active range, com a célula superior esquerda no intervalo como current cell.
setActiveRangeList(rangeList)RangeListDefine a lista especificada de intervalos como o active ranges.
setActiveSheet(sheet)SheetDefine a página 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 current cell.

SpreadsheetTheme

Métodos

MétodoTipo de retornoBreve descrição
getConcreteColor(themeColorType)ColorRetorna o Color concreto para um tipo de cor de tema válido.
getFontFamily()StringRetorna a família de fontes do tema ou null se for um tema 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 para a cor especificada 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_LEFTEnumDireçã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, a pesquisa será configurada para ignorar acentos ao fazer a correspondência. Caso contrário, a pesquisa vai corresponder a acentos.
matchCase(matchCase)TextFinderSe true, configura a pesquisa para corresponder exatamente ao uso de maiúsculas e minúsculas do texto de pesquisa. Caso contrário, a pesquisa usa a correspondência sem diferenciação de maiúsculas e minúsculas.
matchEntireCell(matchEntireCell)TextFinderSe true, configura a pesquisa para corresponder a todo o conteúdo de uma célula. Caso contrário, a pesquisa usa 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 são consideradas com base no valor mostrado.
replaceAllWith(replaceText)IntegerSubstitui todas as correspondências pelo texto especificado.
replaceWith(replaceText)IntegerSubstitui o texto de pesquisa na célula correspondente atual pelo texto especificado e retorna o número de ocorrências substituídas.
startFrom(startRange)TextFinderConfigura a pesquisa para começar 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 interpreta a string de pesquisa como texto normal.

TextRotation

Métodos

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

TextStyle

Métodos

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

TextStyleBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()TextStyleCria um estilo de texto com base neste builder.
setBold(bold)TextStyleBuilderDefine se o texto está em negrito ou não.
setFontFamily(fontFamily)TextStyleBuilderDefine a família de fontes do texto, como "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 está em itálico ou não.
setStrikethrough(strikethrough)TextStyleBuilderDefine se o texto está tachado ou não.
setUnderline(underline)TextStyleBuilderDefine se o texto está sublinhado ou não.

TextToColumnsDelimiter

Propriedades

PropriedadeTipoDescrição
COMMAEnumdelimitador ",".
SEMICOLONEnumdelimitador ";".
PERIODEnumdelimitador ".".
SPACEEnumdelimitador " ".

ThemeColor

Métodos

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

ThemeColorType

Propriedades

PropriedadeTipoDescrição
UNSUPPORTEDEnumRepresenta uma cor de tema que 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 a sexta 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 linhas maiores que a largura da célula em uma nova linha.
OVERFLOWEnumTransbordam para a próxima célula, desde que ela esteja vazia.
CLIPEnumCorta linhas maiores que a largura da célula.