Spreadsheet Service

Planilha

Esse serviço permite que os 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 o desempenho, 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.
BandingAcesse e modifique as faixas, que são os padrões de cores aplicados a linhas ou colunas de um intervalo.
BandingThemeUma enumeração de temas de faixas.
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 formato condicional ou filtro.
BorderStyleEstilos que podem ser definidos em um intervalo usando Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style).
CellImageRepresenta uma imagem a ser adicionada a uma célula.
CellImageBuilderBuilder para a classe CellImage.
ColorUma representação de uma cor.
ColorBuilderO builder de ColorBuilder.
ConditionalFormatRuleAcessar regras de formatação condicional.
ConditionalFormatRuleBuilderBuilder para regras de formatação condicional.
ContainerInfoAcesse a posição do gráfico em uma página.
CopyPasteTypeUma enumeração de possíveis tipos de colagem especiais.
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 de execução dos dados.
DataSourceAcessar e modificar a fonte de dados atual.
DataSourceChartAcesse e modifique um gráfico de fonte de dados.
DataSourceColumnAcessar e modificar uma coluna da fonte de dados.
DataSourceFormulaAcessar e modificar fórmulas de fontes de dados.
DataSourceParameterAcessar parâmetros de fontes de dados.
DataSourceParameterTypeUma enumeração de tipos de parâmetros da fonte de dados.
DataSourcePivotTableAcesse e modifique a tabela dinâmica da fonte de dados.
DataSourceRefreshScheduleAcesse e modifique 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.
DataSourceSheetAcesse e modifique a página da fonte de dados atual.
DataSourceSheetFilterAcesse e modifique um filtro de página de fonte de dados.
DataSourceSpecAcessar as configurações gerais de uma especificação de origem de dados.
DataSourceSpecBuilderO builder de DataSourceSpec.
DataSourceTableAcessar e modificar a tabela da fonte de dados.
DataSourceTableColumnAcesse e modifique 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.
DataValidationBuilderCriador de regras de validação de dados.
DataValidationCriteriaUma enumeração que representa os critérios de validação de dados que podem ser definidos em um intervalo.
DateTimeGroupingRuleAcesse uma regra de agrupamento de data/hora.
DateTimeGroupingRuleTypeOs tipos de regra de agrupamento de data e hora.
DeveloperMetadataAcessar e modificar metadados do desenvolvedor.
DeveloperMetadataFinderPesquise metadados do desenvolvedor em uma planilha.
DeveloperMetadataLocationAcessar informações de local dos metadados do desenvolvedor.
DeveloperMetadataLocationTypeUma enumeração dos tipos de local de metadados do desenvolvedor.
DeveloperMetadataVisibilityUma enumeração dos tipos de visibilidade de metadados do desenvolvedor.
DimensionUma enumeração de direções possíveis em que os dados podem ser armazenados em uma planilha.
DirectionUma enumeração que representa as direções possíveis em que uma pessoa pode se mover em uma planilha usando as teclas de seta.
DrawingRepresenta um desenho sobre uma página em 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 gráficos de histograma.
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 existentes em planilhas Grid, o tipo padrão de planilha.
FilterCriteriaUse essa classe para receber informações sobre os critérios dos filtros ou copiá-los.
FilterCriteriaBuilderPara adicionar critérios a um filtro, faça o seguinte:
  1. Crie o builder de critérios usando SpreadsheetApp.newFilterCriteria().
  2. Adicione configurações ao builder usando os métodos desta classe.
  3. Use build() para montar os critérios com as configurações especificadas.
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 de um botão de controle de grupo.
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.
NamedRangeCrie, acesse e modifique 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 tabelas dinâmicas.
PivotGroupAcessar e modificar grupos de detalhamento da tabela dinâmica.
PivotGroupLimitAcessar e modificar o limite do grupo 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 pivot como uma função de outro valor.
ProtectionAcessar e modificar intervalos e planilhas 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 intervalos possíveis usados no recalculo da planilha.
RelativeDateUma enumeração que representa as opções de data relativa para calcular um valor a ser usado em BooleanCriteria com base na data.
RichTextValueUma string de texto estilizada usada para representar o texto da célula.
RichTextValueBuilderUm builder para valores de rich text.
SelectionAcessar a seleção ativa na página ativa.
SheetAcessar e modificar planilhas.
SheetTypeOs diferentes tipos de planilhas 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.
TextDirectionUma enumeração de rotas em texto.
TextFinderEncontre ou substitua texto em um intervalo, página ou 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.
ThemeColorUma representação de uma cor de tema.
ThemeColorTypeUm tipo enumerado que descreve várias entradas de cores com suporte em temas.
ValueTypeUma enumeração de tipos de valor retornados por Range.getValue() e Range.getValues() da classe Range do serviço Planilha.
WrapStrategyUma enumeração das estratégias usadas para processar o ajuste de texto da célula.

AutoFillSeries

Propriedades

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

Banding

Métodos

MétodoTipo de retornoBreve descrição
copyTo(range)BandingCopia essa faixa para outro intervalo.
getFirstColumnColorObject()ColorRetorna a primeira cor de coluna alternada na 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 na faixa ou null se nenhuma cor estiver definida.
getFooterRowColorObject()ColorRetorna a cor da última linha na faixa ou null se nenhuma cor estiver definida.
getHeaderColumnColorObject()ColorRetorna a cor da primeira coluna na 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 dessa faixa.
getSecondColumnColorObject()ColorRetorna a segunda cor de coluna alternada na faixa ou null se nenhuma cor for definida.
getSecondRowColorObject()ColorRetorna a segunda cor de linha alternada ou null se nenhuma cor estiver definida.
remove()voidRemove essa faixa.
setFirstColumnColor(color)BandingDefine a cor da primeira coluna que está alternando.
setFirstColumnColorObject(color)BandingDefine a primeira cor de coluna alternada na faixa.
setFirstRowColor(color)BandingDefine a cor da primeira 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 na faixa.
setFooterRowColor(color)BandingDefine a cor da última linha.
setFooterRowColorObject(color)BandingDefine a cor da linha do rodapé na faixa.
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 dessa faixa.
setSecondColumnColor(color)BandingDefine a cor da segunda coluna que está alternando.
setSecondColumnColorObject(color)BandingDefine a segunda cor de coluna alternada na faixa.
setSecondRowColor(color)BandingDefine a cor da segunda 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 faixas em ciano.
GREENEnumUm tema de faixas verdes.
YELLOWEnumUm tema de faixas amarelas.
ORANGEEnumUm tema de faixas laranja.
BLUEEnumUm tema de faixas azuis.
TEALEnumUm tema de faixas azul-petróleo.
GREYEnumUm tema de faixas cinzas.
BROWNEnumUm tema de faixas marrons.
LIGHT_GREENEnumUm tema de faixas verde-claro.
INDIGOEnumUm tema de faixas em azul índigo.
PINKEnumUm tema de faixas rosa.

BigQueryDataSourceSpec

Métodos

MétodoTipo de retornoBreve descrição
copy()DataSourceSpecBuilderCria uma DataSourceSpecBuilder com base nas configurações da fonte de dados.
getDatasetId()StringExtrai 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()StringExtrai o ID da tabela do BigQuery.
getTableProjectId()StringExtrai 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 uma DataSourceSpecBuilder com base nas configurações da fonte de dados.
getDatasetId()StringExtrai 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()StringExtrai o ID da tabela do BigQuery.
getTableProjectId()StringExtrai 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 construtores de especificação de origem de dados do tipo DataSourceType.BIGQUERY.
setProjectId(projectId)BigQueryDataSourceSpecBuilderDefine o ID do projeto do BigQuery de faturamento.
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 plano de fundo para essa condição booleana.
getBold()BooleanRetorna true se essa condição booleana negritar o texto e false se essa condição booleana remover o negrito do texto.
getCriteriaType()BooleanCriteriaExtrai o tipo de critério da regra, conforme definido no tipo enumerado BooleanCriteria.
getCriteriaValues()Object[]Recebe uma matriz de argumentos para os critérios da regra.
getFontColorObject()ColorRecebe a cor da fonte para essa condição booleana.
getItalic()BooleanRetorna true se essa condição booleana itálicos o texto e retorna false se essa condição booleana remove itálicos do texto.
getStrikethrough()BooleanRetorna true se essa condição booleana riscar o texto e false se ela remover o tachado do texto.
getUnderline()BooleanRetorna true se essa condição booleana sublinhar o texto e false se essa condição booleana remover o sublinhado do texto.

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 fornecido.
DATE_BEFOREEnumO critério é atendido quando uma data é anterior ao valor fornecido.
DATE_EQUAL_TOEnumO critério é atendido quando uma data é igual ao valor fornecido.
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 fornecidos.
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 fornecido.
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 fornecido.
NUMBER_LESS_THAN_OR_EQUAL_TOEnumO critério é atendido quando um número é menor ou igual ao valor fornecido.
NUMBER_NOT_BETWEENEnumO critério é atendido quando um número não está entre os valores fornecidos.
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 fornecido.
TEXT_DOES_NOT_CONTAINEnumO critério é atendido quando a entrada não contém o valor fornecido.
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 fornecido.
TEXT_ENDS_WITHEnumO critério é atendido quando a entrada termina com o valor fornecido.
CUSTOM_FORMULAEnumO critério é atendido quando a entrada faz com que a fórmula seja avaliada como true.

BorderStyle

Propriedades

PropriedadeTipoDescrição
DOTTEDEnumBordas com linhas pontilhadas.
DASHEDEnumBordas com linhas tracejadas.
SOLIDEnumBordas de linha sólida fina.
SOLID_MEDIUMEnumBordas de linha sólida média.
SOLID_THICKEnumBordas de linhas grossas sólidas.
DOUBLEEnumDuas bordas de linha sólida.

CellImage

Propriedades

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

Métodos

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

CellImageBuilder

Propriedades

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

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 essa imagem.
getAltTextTitle()StringRetorna o título do texto alternativo para essa imagem.
getContentUrl()StringRetorna um URL hospedado pelo Google para a imagem.
getUrl()StringExtrai o URL de origem da imagem e retorna null se o URL estiver indisponível.
setAltTextDescription(description)CellImageDefine a descrição do texto alternativo para essa imagem.
setAltTextTitle(title)CellImageDefine o título do texto alternativo para essa imagem.
setSourceUrl(url)CellImageBuilderDefine o URL da origem da imagem.
toBuilder()CellImageBuilderCria um builder que transforma uma imagem em um tipo de valor de imagem para que você possa colocá-la em uma célula.

Color

Métodos

MétodoTipo de retornoBreve descrição
asRgbColor()RgbColorConverte essa cor em um RgbColor.
asThemeColor()ThemeColorConverte essa cor em um ThemeColor.
getColorType()ColorTypeReceba 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 construtor.
getColorType()ColorTypeReceba o tipo dessa cor.
setRgbColor(cssString)ColorBuilderDefine como cor RGB.
setThemeColor(themeColorType)ColorBuilderDefine a cor do tema.

ConditionalFormatRule

Métodos

MétodoTipo de retornoBreve descrição
copy()ConditionalFormatRuleBuilderRetorna uma regra predefinida do criador de regras com as configurações dela.
getBooleanCondition()BooleanConditionRecupera as informações BooleanCondition da regra se ela usa critérios de condição booleana.
getGradientCondition()GradientConditionRecupera as informações GradientCondition da regra, se ela usar critérios de condição de gradiente.
getRanges()Range[]Recupera os intervalos em 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 construtor.
copy()ConditionalFormatRuleBuilderRetorna uma regra predefinida do criador de regras com as configurações dela.
getBooleanCondition()BooleanConditionRecupera as informações BooleanCondition da regra se ela usa critérios de condição booleana.
getGradientCondition()GradientConditionRecupera as informações GradientCondition da regra, se ela usar critérios de condição de gradiente.
getRanges()Range[]Recupera os intervalos em que esta regra de formatação condicional é aplicada.
setBackground(color)ConditionalFormatRuleBuilderDefine a cor de plano de fundo para a formatação condicional da regra.
setBackgroundObject(color)ConditionalFormatRuleBuilderDefine a cor de plano de fundo para a regra de formatação condicional.
setBold(bold)ConditionalFormatRuleBuilderDefine o negrito do texto para a regra de formatação condicional.
setFontColor(color)ConditionalFormatRuleBuilderDefine a cor da fonte para a formatação condicional.
setFontColorObject(color)ConditionalFormatRuleBuilderDefine a cor da fonte para a formatação condicional.
setGradientMaxpoint(color)ConditionalFormatRuleBuilderLimpa o valor de ponto 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 de ponto 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 de ponto máximo do gradiente da regra de formatação condicional.
setGradientMaxpointWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos de ponto máximo do 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 de ponto 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 de ponto 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 do gradiente da regra de formatação condicional.
setGradientMinpointWithValue(color, type, value)ConditionalFormatRuleBuilderDefine os campos de ponto mínimo do 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 em que essa regra de formatação condicional é aplicada.
setStrikethrough(strikethrough)ConditionalFormatRuleBuilderDefine o sublinhado do texto para a regra de formatação condicional.
setUnderline(underline)ConditionalFormatRuleBuilderDefine o sublinhado de texto para o formato da regra de formatação condicional.
whenCellEmpty()ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando a célula estiver vazia.
whenCellNotEmpty()ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando a célula não estiver vazia.
whenDateAfter(date)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando uma data for posterior ao valor fornecido.
whenDateAfter(date)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando uma data for posterior à data relativa especificada.
whenDateBefore(date)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando uma data estiver antes da data especificada.
whenDateBefore(date)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando uma data estiver antes da data relativa especificada.
whenDateEqualTo(date)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando uma data for igual à data especificada.
whenDateEqualTo(date)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando uma data for igual à data relativa especificada.
whenFormulaSatisfied(formula)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando a fórmula for avaliada como true.
whenNumberBetween(start, end)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando um número estiver entre dois valores especificados ou for um deles.
whenNumberEqualTo(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando um número for igual ao valor fornecido.
whenNumberGreaterThan(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando um número for maior que o valor fornecido.
whenNumberGreaterThanOrEqualTo(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando um número for maior ou igual ao valor especificado.
whenNumberLessThan(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando um número for menor que o valor fornecido.
whenNumberLessThanOrEqualTo(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando um número for menor ou igual ao valor especificado.
whenNumberNotBetween(start, end)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando um número não estiver entre dois valores especificados e não for nenhum deles.
whenNumberNotEqualTo(number)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando um número não for igual ao valor fornecido.
whenTextContains(text)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando a entrada contém o valor fornecido.
whenTextDoesNotContain(text)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando a entrada não contém o valor especificado.
whenTextEndsWith(text)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando a entrada terminar com o valor fornecido.
whenTextEqualTo(text)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando a entrada for igual ao valor fornecido.
whenTextStartsWith(text)ConditionalFormatRuleBuilderDefine a regra de formatação condicional para acionar quando a entrada começar com o valor fornecido.
withCriteria(criteria, args)ConditionalFormatRuleBuilderDefine a regra de formato condicional para critérios definidos por valores BooleanCriteria, normalmente retirados do criteria e arguments de uma regra existente.

ContainerInfo

Métodos

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

CopyPasteType

Propriedades

PropriedadeTipoDescrição
PASTE_NORMALEnumCole valores, fórmulas, formatos e mesclagens.
PASTE_NO_BORDERSEnumColar valores, fórmulas, formatos e mesclagens, mas sem bordas.
PASTE_FORMATEnumColar apenas a formatação.
PASTE_FORMULAEnumCole apenas as fórmulas.
PASTE_DATA_VALIDATIONEnumCole apenas a validação de dados.
PASTE_VALUESEnumCole APENAS os valores sem formatação, 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 tem suporte no Apps Script.
NONEEnumA execução de dados não tem erros.
TIME_OUTEnumA execução dos dados expirou.
TOO_MANY_ROWSEnumA execução dos dados retorna mais linhas do que o limite.
TOO_MANY_COLUMNSEnumA execução dos dados retorna mais colunas do que o limite.
TOO_MANY_CELLSEnumA execução dos dados retorna mais células do que o limite.
ENGINEEnumErro no mecanismo de execução de dados.
PARAMETER_INVALIDEnumParâmetro de execução de dados inválido.
UNSUPPORTED_DATA_TYPEEnumA execução dos dados retorna um tipo de dados não aceito.
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 dos dados retorna valores que excedem o número máximo de caracteres permitidos em uma única célula.
DATA_NOT_FOUNDEnumO banco de dados referenciado pela fonte de dados não foi encontrado.
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 dos dados foi iniciada e está em andamento.
SUCCESSEnumA execução dos dados foi concluída.
ERROREnumA execução dos 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 a hora em que a última execução de dados foi concluída, independentemente do estado de 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 essa fonte.
createCalculatedColumn(name, formula)DataSourceColumnCria uma coluna calculada.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableCria uma tabela dinâmica da fonte de dados 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 essa fonte.
getSpec()DataSourceSpecConsegue a especificação da fonte de dados.
refreshAllLinkedDataSourceObjects()voidAtualiza todos os objetos da fonte de dados vinculados a ela.
updateSpec(spec)DataSourceAtualiza a especificação da fonte de dados e atualiza os objetos da fonte de dados vinculados a essa fonte com a nova especificação.
updateSpec(spec, refreshAllLinkedObjects)DataSourceAtualiza a especificação da fonte de dados e atualiza o data source sheets vinculado com a nova especificação.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidAguarda até que todas as execuções atuais dos objetos de origem de dados vinculados sejam concluídas, com um 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, independentemente do estado atual.
getDataSource()DataSourceRecebe a fonte de dados à qual o objeto está vinculado.
getStatus()DataExecutionStatusRecebe o status de execução de dados do objeto.
refreshData()DataSourceChartAtualiza os dados do objeto.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda até que a execução atual seja concluída e expira após o número de segundos fornecido.

DataSourceColumn

Métodos

MétodoTipo de retornoBreve descrição
getDataSource()DataSourceExtrai a fonte de dados associada à coluna da fonte de dados.
getFormula()StringRecebe a fórmula da coluna da fonte de dados.
getName()StringConsegue 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, independentemente do estado atual.
getAnchorCell()RangeRetorna a Range que representa a célula em que essa fórmula da fonte de dados está ancorada.
getDataSource()DataSourceRecebe a fonte de dados à qual o objeto está vinculado.
getDisplayValue()StringRetorna o valor de exibição da fórmula da fonte de dados.
getFormula()StringRetorna a fórmula da 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)DataExecutionStatusAguarda até que a execução atual seja concluída e expira após o número de segundos fornecido.

DataSourceParameter

Métodos

MétodoTipo de retornoBreve descrição
getName()StringConsegue 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 de origem de dados especificada.
addFilter(columnName, filterCriteria)PivotFilterAdiciona um novo filtro com base na coluna da fonte de dados especificada e nos critérios de filtro especificados.
addPivotValue(columnName)PivotValueAdiciona um novo valor dinâmico com base na coluna de origem de dados especificada sem nenhuma função de resumo.
addPivotValue(columnName, summarizeFunction)PivotValueAdiciona um novo valor de pivot com base na coluna de origem de dados especificada e na função de resumo especificada.
addRowGroup(columnName)PivotGroupAdiciona um novo grupo de linhas de pivot com base na coluna da fonte de dados especificada.
asPivotTable()PivotTableRetorna a tabela dinâmica da fonte de dados como um objeto de tabela dinâmica normal.
cancelDataRefresh()DataSourcePivotTableCancela a atualização de dados associada a esse objeto se ela estiver em execução.
forceRefreshData()DataSourcePivotTableAtualiza os dados desse objeto, independentemente do estado atual.
getDataSource()DataSourceRecebe a fonte de dados à qual o objeto está vinculado.
getStatus()DataExecutionStatusRecebe o status de execução de dados do objeto.
refreshData()DataSourcePivotTableAtualiza os dados do objeto.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda até que a execução atual seja concluída e expira 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()DataSourceRefreshScopeRetorna 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 essa 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) para atualizar a fonte de dados.
getDaysOfTheWeek()Weekday[]Recebe os dias da semana em que a fonte de dados será atualizada.
getFrequencyType()FrequencyTypeRecebe o tipo de frequência.
getStartHour()IntegerRecebe a hora de início (como um número de 0 a 23) do intervalo de tempo em que a programação de atualização é executada.

DataSourceRefreshScope

Propriedades

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

DataSourceSheet

Métodos

MétodoTipo de retornoBreve descrição
addFilter(columnName, filterCriteria)DataSourceSheetAdiciona um filtro aplicado à planilha da fonte de dados.
asSheet()SheetRetorna a página da fonte de dados como um objeto de página regular.
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, independentemente do estado atual.
getColumnWidth(columnName)IntegerRetorna a largura da coluna especificada.
getDataSource()DataSourceRecebe a fonte de dados à qual 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 da 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 de início (baseada em 1) até a numRows fornecida.
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 da fonte de dados.
removeSortSpec(columnName)DataSourceSheetRemove a especificação de classificação de 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 da fonte de dados.
setSortSpec(columnName, sortOrder)DataSourceSheetDefine a especificação de classificação em uma coluna na página da fonte de dados.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda até que a execução atual seja concluída e expira 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 este filtro se aplica.
getDataSourceSheet()DataSourceSheetRetorna a DataSourceSheet a que este filtro pertence.
getFilterCriteria()FilterCriteriaRetorna os critérios de filtro para esse filtro.
remove()voidRemove esse filtro do objeto de fonte de dados.
setFilterCriteria(filterCriteria)DataSourceSheetFilterDefine os critérios de filtro.

DataSourceSpec

Métodos

MétodoTipo de retornoBreve descrição
asBigQuery()BigQueryDataSourceSpecExtrai a especificação da fonte de dados do BigQuery.
asLooker()LookerDataSourceSpecRecebe a especificação da fonte de dados do Looker.
copy()DataSourceSpecBuilderCria uma DataSourceSpecBuilder com base nas configurações da 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()BigQueryDataSourceSpecBuilderRetorna o builder da 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 uma DataSourceSpecBuilder com base nas configurações da 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 construtores de especificação de origem de dados do tipo DataSourceType.BIGQUERY.

DataSourceTable

Métodos

MétodoTipo de retornoBreve descrição
addColumns(columnNames)DataSourceTableAdiciona colunas à tabela da fonte de dados.
addFilter(columnName, filterCriteria)DataSourceTableAdiciona um filtro aplicado à tabela da fonte 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, independentemente do estado atual.
getColumns()DataSourceTableColumn[]Recebe todas as colunas da fonte de dados adicionadas à tabela da fonte de dados.
getDataSource()DataSourceRecebe a fonte de dados à qual o objeto está vinculado.
getFilters()DataSourceTableFilter[]Retorna todos os filtros aplicados à tabela da fonte de dados.
getRange()RangeRecebe o Range que a tabela da fonte de dados abrange.
getRowLimit()IntegerRetorna o limite de linhas da 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 da fonte 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 da fonte de dados.
syncAllColumns()DataSourceTableSincronize todas as colunas atuais e futuras na fonte de dados associada com a tabela da fonte de dados.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda até que a execução atual seja concluída e expira 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 este filtro se aplica.
getDataSourceTable()DataSourceTableRetorna a DataSourceTable a que este filtro pertence.
getFilterCriteria()FilterCriteriaRetorna os critérios de filtro para esse filtro.
remove()voidRemove esse filtro do objeto de fonte de dados.
setFilterCriteria(filterCriteria)DataSourceTableFilterDefine os critérios de 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 dela.
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 completamente.
getCriteriaType()DataValidationCriteriaExtrai o tipo de critério da regra, conforme definido no tipo enumerado DataValidationCriteria.
getCriteriaValues()Object[]Recebe uma matriz de argumentos para os critérios da regra.
getHelpText()StringRecebe o texto de ajuda da regra ou null se nenhum texto de ajuda 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 construtor.
copy()DataValidationBuilderCria um builder para uma regra de validação de dados com base nas configurações dela.
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 completamente.
getCriteriaType()DataValidationCriteriaExtrai o tipo de critério da regra, conforme definido no tipo enumerado DataValidationCriteria.
getCriteriaValues()Object[]Recebe uma matriz de argumentos para os critérios da regra.
getHelpText()StringRecebe o texto de ajuda da regra ou null se nenhum texto de ajuda 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 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 após o valor fornecido.
requireDateBefore(date)DataValidationBuilderDefine a regra de validação de dados para exigir uma data antes do valor fornecido.
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 fornecido.
requireDateNotBetween(start, end)DataValidationBuilderDefine a regra de validação de dados para exigir uma data que não esteja entre duas datas especificadas e não seja nenhuma delas.
requireDateOnOrAfter(date)DataValidationBuilderDefine a regra de validação de dados para exigir uma data no valor fornecido ou posterior a ele.
requireDateOnOrBefore(date)DataValidationBuilderDefine a regra de validação de dados para exigir uma data no valor indicado ou antes dele.
requireFormulaSatisfied(formula)DataValidationBuilderDefine a regra de validação de dados para exigir que a fórmula 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 fornecido.
requireNumberGreaterThan(number)DataValidationBuilderDefine a regra de validação de dados para exigir um número maior que o valor fornecido.
requireNumberGreaterThanOrEqualTo(number)DataValidationBuilderDefine a regra de validação de dados para exigir um número maior ou igual ao valor fornecido.
requireNumberLessThan(number)DataValidationBuilderDefine a regra de validação de dados para exigir um número menor que o valor fornecido.
requireNumberLessThanOrEqualTo(number)DataValidationBuilderDefine a regra de validação de dados para exigir um número menor ou igual ao valor fornecido.
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 não seja um deles.
requireNumberNotEqualTo(number)DataValidationBuilderDefine a regra de validação de dados para exigir um número diferente do valor fornecido.
requireTextContains(text)DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada contenha o valor fornecido.
requireTextDoesNotContain(text)DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada não contenha o valor fornecido.
requireTextEqualTo(text)DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada seja igual ao valor fornecido.
requireTextIsEmail()DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada esteja no formato de um endereço de e-mail.
requireTextIsUrl()DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada esteja no formato 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 fornecido, com uma opção para ocultar o menu suspenso.
setAllowInvalid(allowInvalidData)DataValidationBuilderDefine se um aviso será mostrado quando a entrada falhar na validação de dados ou se a entrada 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á configurada.
withCriteria(criteria, args)DataValidationBuilderDefine a regra de validação de dados para critérios definidos por valores DataValidationCriteria, normalmente extraídos do criteria e arguments de uma regra atual.

DataValidationCriteria

Propriedades

PropriedadeTipoDescrição
DATE_AFTEREnumRequer uma data posterior ao valor fornecido.
DATE_BEFOREEnumRequer uma data anterior ao valor fornecido.
DATE_BETWEENEnumRequer uma data entre os valores fornecidos.
DATE_EQUAL_TOEnumRequer uma data igual ao valor fornecido.
DATE_IS_VALID_DATEEnumRequer uma data.
DATE_NOT_BETWEENEnumRequer uma data que não esteja entre os valores fornecidos.
DATE_ON_OR_AFTEREnumExija uma data igual ou posterior ao valor fornecido.
DATE_ON_OR_BEFOREEnumRequer uma data igual ou anterior ao valor fornecido.
NUMBER_BETWEENEnumRequer um número entre os valores fornecidos.
NUMBER_EQUAL_TOEnumRequer um número igual ao valor fornecido.
NUMBER_GREATER_THANEnumExija um número maior que o valor fornecido.
NUMBER_GREATER_THAN_OR_EQUAL_TOEnumRequer um número maior ou igual ao valor fornecido.
NUMBER_LESS_THANEnumRequer um número menor que o valor fornecido.
NUMBER_LESS_THAN_OR_EQUAL_TOEnumRequer um número menor ou igual ao valor fornecido.
NUMBER_NOT_BETWEENEnumRequer 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 fornecido.
TEXT_CONTAINSEnumRequer que a entrada contenha o valor fornecido.
TEXT_DOES_NOT_CONTAINEnumRequer que a entrada não contenha o valor fornecido.
TEXT_EQUAL_TOEnumRequer que a entrada seja igual ao valor fornecido.
TEXT_IS_VALID_EMAILEnumRequer que a entrada seja no formato de um endereço de e-mail.
TEXT_IS_VALID_URLEnumRequer que a entrada seja no formato de um URL.
VALUE_IN_LISTEnumRequer que a entrada seja igual a um dos valores fornecidos.
VALUE_IN_RANGEEnumRequer que a entrada seja igual a um valor no intervalo fornecido.
CUSTOM_FORMULAEnumRequer que a entrada faça com que a fórmula especificada seja avaliada como true.
CHECKBOXEnumRequer que a entrada seja um valor personalizado ou booleano, renderizado como uma caixa de seleção.

DateTimeGroupingRule

Métodos

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

DateTimeGroupingRuleType

Propriedades

PropriedadeTipoDescrição
UNSUPPORTEDEnumUm tipo de regra de agrupamento de data e hora que não tem suporte.
SECONDEnumAgrupar a data e a hora por segundo, de 0 a 59.
MINUTEEnumAgrupe a data e a hora por minuto, de 0 a 59.
HOUREnumAgrupe a data e a hora por hora usando um sistema de 24 horas, de 0 a 23.
HOUR_MINUTEEnumAgrupe a data e a hora por hora e minuto usando um sistema de 24 horas, por exemplo, 19:45.
HOUR_MINUTE_AMPMEnumAgrupe a data e a hora por hora e minuto usando um sistema de 12 horas, por exemplo, 7:45 PM.
DAY_OF_WEEKEnumAgrupe a data e a hora por dia da semana, por exemplo, Sunday.
DAY_OF_YEAREnumAgrupe a data e a hora por dia do ano, de 1 a 366.
DAY_OF_MONTHEnumAgrupe a data e a hora por dia do mês, de 1 a 31.
DAY_MONTHEnumAgrupe a data e a hora por dia e mês, por exemplo, 22-Nov.
MONTHEnumAgrupar a data e a hora por mês, por exemplo, Nov.
QUARTEREnumAgrupar a data e a hora por trimestre, por exemplo, T1 (que representa janeiro a março).
YEAREnumAgrupar a data e a hora por ano, por exemplo, 2008.
YEAR_MONTHEnumAgrupe a data e a hora por ano e mês, por exemplo, 2008-Nov.
YEAR_QUARTEREnumAgrupe a data e a hora por ano e trimestre, por exemplo, 2008 Q4 .
YEAR_MONTH_DAYEnumAgrupe a data e a 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 aos metadados do desenvolvedor.
getLocation()DeveloperMetadataLocationRetorna o local desses metadados do desenvolvedor.
getValue()StringRetorna o valor associado a esses metadados do desenvolvedor ou null se esses metadados não tiverem nenhum 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 como o valor especificado.
setValue(value)DeveloperMetadataDefine o valor associado a esses metadados do desenvolvedor como o valor especificado.
setVisibility(visibility)DeveloperMetadataDefine a visibilidade desses metadados do desenvolvedor para a visibilidade especificada.

DeveloperMetadataFinder

Métodos

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

DeveloperMetadataLocation

Métodos

MétodoTipo de retornoBreve descrição
getColumn()RangeRetorna o Range para a 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 o local da linha desses metadados ou null se o tipo de local não for DeveloperMetadataLocationType.ROW.
getSheet()SheetRetorna o local Sheet desses metadados ou null se o tipo de local não for DeveloperMetadataLocationType.SHEET.
getSpreadsheet()SpreadsheetRetorna o local Spreadsheet desses metadados ou null se o tipo de local não for DeveloperMetadataLocationType.SPREADSHEET.

DeveloperMetadataLocationType

Propriedades

PropriedadeTipoDescrição
SPREADSHEETEnumO tipo de local dos metadados do desenvolvedor associados à planilha de nível superior.
SHEETEnumO tipo de local dos metadados do desenvolvedor associados a uma planilha inteira.
ROWEnumO tipo de local dos metadados do desenvolvedor associados a uma linha.
COLUMNEnumO tipo de local dos metadados do desenvolvedor associados a uma coluna.

DeveloperMetadataVisibility

Propriedades

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

Dimension

Propriedades

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

Direction

Propriedades

PropriedadeTipoDescrição
UPEnumA direção dos índices de linhas decrescentes.
DOWNEnumA direção de aumento dos índices de linha.
PREVIOUSEnumA direção dos índices de colunas decrescentes.
NEXTEnumA direção de 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 página.
getHeight()IntegerRetorna a altura real desse desenho em pixels.
getOnAction()StringRetorna o nome da macro anexada a este desenho.
getSheet()SheetRetorna a página em que esse desenho aparece.
getWidth()IntegerRetorna a largura real desse desenho em pixels.
getZIndex()NumberRetorna o índice z desse desenho.
remove()voidExclui esse desenho da planilha.
setHeight(height)DrawingDefine a altura real desse desenho em pixels.
setOnAction(macroName)DrawingAtribui uma função de macro a este desenho.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)DrawingDefine a posição em que o desenho aparece na página.
setWidth(width)DrawingDefine a largura real desse desenho em pixels.
setZIndex(zIndex)DrawingDefine o z-index desse desenho.

EmbeddedAreaChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico modificado por este builder.
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 modificado por esse builder.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna a ContainerInfo do gráfico, que encapsula onde o gráfico aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico modificado por esse builder.
reverseCategories()EmbeddedAreaChartBuilderInverte o desenho das séries no eixo do domínio.
setBackgroundColor(cssValue)EmbeddedAreaChartBuilderDefine a cor 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 de texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando mais de um intervalo existir.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratadas 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 linhas e barras são empilhados (acumulados).
setTitle(chartTitle)EmbeddedAreaChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico são transpostas.
setXAxisTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedAreaChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedAreaChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()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 modificado por este builder.
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 modificado por esse builder.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna a ContainerInfo do gráfico, que encapsula onde o gráfico aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico modificado por esse builder.
reverseCategories()EmbeddedBarChartBuilderInverte o desenho das séries no eixo do domínio.
reverseDirection()EmbeddedBarChartBuilderInverte a direção em que as barras crescem ao longo do eixo horizontal.
setBackgroundColor(cssValue)EmbeddedBarChartBuilderDefine a cor 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 de texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando mais de um intervalo existir.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratadas 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 linhas e barras são empilhados (acumulados).
setTitle(chartTitle)EmbeddedBarChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico são transpostas.
setXAxisTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedBarChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedBarChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()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()DataSourceChartÉ convertido em uma instância de gráfico de fonte de dados se o gráfico for uma fonte de dados ou null.
getAs(contentType)BlobRetorna os dados dentro deste objeto como um blob convertido para o tipo de conteúdo especificado.
getBlob()BlobRetorne os dados dentro deste objeto como um blob.
getChartId()IntegerRetorna um identificador estável para o gráfico que é exclusivo na planilha que contém o gráfico ou null se o gráfico não estiver em uma planilha.
getContainerInfo()ContainerInfoRetorna informações sobre onde o gráfico está posicionado em uma planilha.
getHiddenDimensionStrategy()ChartHiddenDimensionStrategyRetorna a estratégia a ser usada para processar linhas e colunas ocultas.
getMergeStrategy()ChartMergeStrategyRetorna a estratégia de mesclagem usada quando mais de um intervalo existe.
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 esse gráfico usa como fonte de dados.
getTransposeRowsAndColumns()BooleanSe true, as linhas e colunas usadas para preencher o gráfico são trocadas.
modify()EmbeddedChartBuilderRetorna um EmbeddedChartBuilder que pode ser usado para modificar esse gráfico.

EmbeddedChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico modificado por este builder.
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 modificado por esse builder.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna a ContainerInfo do gráfico, que encapsula onde o gráfico aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico modificado por esse builder.
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 mais de um intervalo existir.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratadas 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 modificado por este builder.
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 modificado por esse builder.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna a ContainerInfo do gráfico, que encapsula onde o gráfico aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico modificado por esse builder.
reverseCategories()EmbeddedColumnChartBuilderInverte o desenho das séries no eixo do domínio.
setBackgroundColor(cssValue)EmbeddedColumnChartBuilderDefine a cor 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 de texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando mais de um intervalo existir.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratadas 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 linhas e barras são empilhados (acumulados).
setTitle(chartTitle)EmbeddedColumnChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico são transpostas.
setXAxisTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedColumnChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedColumnChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()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 modificado por este builder.
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 modificado por esse builder.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna a ContainerInfo do gráfico, que encapsula onde o gráfico aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico modificado por esse builder.
reverseCategories()EmbeddedComboChartBuilderInverte o desenho das séries no eixo do domínio.
setBackgroundColor(cssValue)EmbeddedComboChartBuilderDefine a cor 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 de texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando mais de um intervalo existir.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratadas 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 linhas e barras são empilhados (acumulados).
setTitle(chartTitle)EmbeddedComboChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico são transpostas.
setXAxisTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedComboChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedComboChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()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 modificado por este builder.
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 modificado por esse builder.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna a ContainerInfo do gráfico, que encapsula onde o gráfico aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico modificado por esse builder.
reverseCategories()EmbeddedHistogramChartBuilderInverte o desenho das séries no eixo do domínio.
setBackgroundColor(cssValue)EmbeddedHistogramChartBuilderDefine a cor 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 de texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando mais de um intervalo existir.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratadas 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 linhas e barras são empilhados (acumulados).
setTitle(chartTitle)EmbeddedHistogramChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico são transpostas.
setXAxisTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedHistogramChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedHistogramChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()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 modificado por este builder.
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 modificado por esse builder.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna a ContainerInfo do gráfico, que encapsula onde o gráfico aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico modificado por esse builder.
reverseCategories()EmbeddedLineChartBuilderInverte o desenho das séries no eixo do domínio.
setBackgroundColor(cssValue)EmbeddedLineChartBuilderDefine a cor 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 de texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando mais de um intervalo existir.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratadas 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 de 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 de 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 de texto do eixo vertical.
setYAxisTitle(title)EmbeddedLineChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedLineChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()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 modificado por este builder.
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 modificado por esse builder.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna a ContainerInfo do gráfico, que encapsula onde o gráfico aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico modificado por esse builder.
reverseCategories()EmbeddedPieChartBuilderInverte o desenho das séries no eixo do domínio.
set3D()EmbeddedPieChartBuilderDefine o gráfico como tridimensional.
setBackgroundColor(cssValue)EmbeddedPieChartBuilderDefine a cor 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 de texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando mais de um intervalo existir.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratadas 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 de 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 modificado por este builder.
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 modificado por esse builder.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorna a ContainerInfo do gráfico, que encapsula onde o gráfico aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico modificado por esse builder.
setBackgroundColor(cssValue)EmbeddedScatterChartBuilderDefine a cor 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 de texto da legenda do gráfico.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando mais de um intervalo existir.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratadas 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 de 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 de 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 de texto do eixo vertical.
setYAxisTitle(title)EmbeddedScatterChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedScatterChartBuilderDefine o estilo do texto do título do eixo vertical.

EmbeddedTableChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico modificado por este builder.
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 modificado por esse builder.
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 mostrada (os números de página são baseados em zero).
enableRtlTable(rtlEnabled)EmbeddedTableChartBuilderAdiciona suporte básico para idiomas da direita para a esquerda (como árabe ou hebraico) revertendo a ordem das colunas da tabela, de modo que a coluna zero seja a mais à direita e a última coluna seja 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 a ContainerInfo do gráfico, que encapsula onde o gráfico aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que estão fornecendo dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico modificado por esse builder.
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 o qual a tabela deve ser inicialmente classificada (descendente).
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando mais de um intervalo existir.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que devem ser tratadas 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 será mostrado como a primeira coluna da tabela.
useAlternatingRowStyle(alternate)EmbeddedTableChartBuilderDefine se o estilo de cor alternada é atribuído a linhas ímpares e pares de um gráfico de tabela.

Filter

Métodos

MétodoTipo de retornoBreve descrição
getColumnFilterCriteria(columnPosition)FilterCriteriaConsegue 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 em que o filtro é aplicado.
remove()voidRemove esse 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)FilterOrdena o intervalo filtrado pela coluna especificada, excluindo a primeira linha (a linha de cabeçalho) no intervalo em que o filtro é aplicado.

FilterCriteria

Métodos

MétodoTipo de retornoBreve descrição
copy()FilterCriteriaBuilderCopia esses critérios de filtro e cria um builder 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 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()FilterCriteriaMonta 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 builder 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 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 do 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 um critério de filtro que mostra 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 à especificada.
whenDateBefore(date)FilterCriteriaBuilderDefine critérios de filtro que mostram células com datas anteriores à data relativa especificada.
whenDateEqualTo(date)FilterCriteriaBuilderDefine critérios de filtro que mostram células com datas iguais à especificada.
whenDateEqualTo(date)FilterCriteriaBuilderDefine critérios de filtro que mostram células com datas iguais à data relativa especificada.
whenDateEqualToAny(dates)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com datas iguais a qualquer uma das datas especificadas.
whenDateNotEqualTo(date)FilterCriteriaBuilderDefine os critérios do filtro para mostrar as células que não são iguais à data especificada.
whenDateNotEqualToAny(dates)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com datas que não são iguais a nenhuma das datas especificadas.
whenFormulaSatisfied(formula)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com uma fórmula especificada (como =B:B<C:C) que é avaliada como true.
whenNumberBetween(start, end)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número que fica entre dois números especificados ou é 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 especificado.
whenNumberLessThan(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número menor do que o especificado.
whenNumberLessThanOrEqualTo(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número menor ou igual ao 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 e não é nenhum deles.
whenNumberNotEqualTo(number)FilterCriteriaBuilderDefine os critérios do filtro para mostrar células com um número que não é igual ao 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 contenha o texto especificado.
whenTextDoesNotContain(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto que não contenha 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 que não é igual ao 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 é aceito.
DAILYEnumAtualize diariamente.
WEEKLYEnumAtualização semanal em determinados dias da semana.
MONTHLYEnumAtualize mensalmente em determinados dias do mês.

GradientCondition

Métodos

MétodoTipo de retornoBreve descrição
getMaxColorObject()ColorRecebe a cor definida para o valor máximo dessa condição de gradiente.
getMaxType()InterpolationTypeRecebe o tipo de interpolação para o valor máximo dessa condição de gradiente.
getMaxValue()StringRetorna o valor máximo dessa condição de gradiente.
getMidColorObject()ColorExtrai 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()ColorExtrai a cor definida para o valor mínimo desta condição de gradiente.
getMinType()InterpolationTypeRecebe o tipo de interpolação para o valor mínimo dessa condição de gradiente.
getMinValue()StringRetorna o valor mínimo dessa condição de gradiente.

Group

Métodos

MétodoTipo de retornoBreve descrição
collapse()GroupFechar este grupo.
expand()GroupAbre esse grupo.
getControlIndex()IntegerRetorna o índice de alternância de controle desse grupo.
getDepth()IntegerRetorna a profundidade desse grupo.
getRange()RangeRetorna o intervalo em que esse grupo existe.
isCollapsed()BooleanRetorna true se esse 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 o botão de controle está antes do grupo (em índices mais baixos).
AFTEREnumA posição em que o botão de controle fica depois do grupo (em índices mais altos).

InterpolationType

Propriedades

PropriedadeTipoDescrição
NUMBEREnumUse o número como ponto de interpolação específico para uma condição de gradiente.
PERCENTEnumUse o número como um ponto de interpolação 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 uma DataSourceSpecBuilder com base nas configurações da 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 uma DataSourceSpecBuilder com base nas configurações da 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 construtores de especificação de origem de dados do tipo DataSourceType.BIGQUERY.

NamedRange

Métodos

MétodoTipo de retornoBreve descrição
getName()StringExtrai o nome desse intervalo nomeado.
getRange()RangeRecebe o intervalo referenciado por este intervalo nomeado.
remove()voidExclui este intervalo nomeado.
setName(name)NamedRangeDefine/atualiza o nome do intervalo nomeado.
setRange(range)NamedRangeDefine/atualiza o intervalo 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 essa imagem.
getAltTextTitle()StringRetorna o título do texto alternativo para essa imagem.
getAnchorCell()RangeRetorna a célula em que uma imagem está ancorada.
getAnchorCellXOffset()IntegerRetorna o deslocamento horizontal em pixels da célula de âncora.
getAnchorCellYOffset()IntegerRetorna o deslocamento vertical em pixels da célula de âncora.
getHeight()IntegerRetorna a altura real da imagem em pixels.
getInherentHeight()IntegerRetorna a altura inerente dessa imagem em pixels.
getInherentWidth()IntegerRetorna a altura inerente dessa imagem em pixels.
getScript()StringRetorna o nome da função atribuída a esta imagem.
getSheet()SheetRetorna a planilha em que a imagem aparece.
getUrl()StringExtrai o URL de origem da imagem e retorna null se o URL estiver indisponível.
getWidth()IntegerRetorna a largura real da imagem em pixels.
remove()voidExclui essa imagem da planilha.
replace(blob)OverGridImageSubstitui esta imagem pela especificada pelo BlobSource fornecido.
replace(url)OverGridImageSubstitui esta imagem pela do URL especificado.
resetSize()OverGridImageRedefine a imagem para as dimensões inerentes.
setAltTextDescription(description)OverGridImageDefine a descrição do texto alternativo para essa imagem.
setAltTextTitle(title)OverGridImageDefine o título do texto alternativo para essa imagem.
setAnchorCell(cell)OverGridImageDefine a célula em que uma imagem está ancorada.
setAnchorCellXOffset(offset)OverGridImageDefine o deslocamento horizontal de pixels da célula de âncora.
setAnchorCellYOffset(offset)OverGridImageDefine o deslocamento vertical em pixels da célula de âncora.
setHeight(height)OverGridImageDefine a altura real da imagem em pixels.
setWidth(width)OverGridImageDefine a largura real da imagem em pixels.

PageProtection

PivotFilter

Métodos

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

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 deste 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 abas 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 desse grupo de pivot na ordem atual.
getPivotTable()PivotTableRetorna o PivotTable ao qual esse agrupamento pertence.
getSourceDataColumn()IntegerRetorna o número da coluna de dados de origem resumida por esse grupo.
getSourceDataSourceColumn()DataSourceColumnRetorna a coluna da fonte de dados em que o grupo de abas opera.
hideRepeatedLabels()PivotGroupOculta rótulos repetidos para esse agrupamento.
isSortAscending()BooleanRetorna true se a classificação for crescente e false se a ordem de classificação for decrescente.
moveToIndex(index)PivotGroupMove esse grupo para a posição especificada na lista atual de grupos de linhas ou colunas.
remove()voidRemove esse grupo de pivots da tabela.
removeManualGroupingRule(groupName)PivotGroupRemove a regra de agrupamento manual com o groupName especificado.
resetDisplayName()PivotGroupRedefine o nome de exibição desse 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 desse 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 de pivot.
showRepeatedLabels()PivotGroupQuando há mais de um agrupamento de linhas ou colunas, esse método mostra o rótulo desse agrupamento para cada entrada do agrupamento subsequente.
showTotals(showTotals)PivotGroupDefine se os valores totais desse grupo dinâmico vão ser mostrados na tabela.
sortAscending()PivotGroupDefine a ordem de classificação como crescente.
sortBy(value, oppositeGroupValues)PivotGroupOrdena esse grupo pelo PivotValue especificado para os valores do oppositeGroupValues.
sortDescending()PivotGroupDefine a ordem de classificação como decrescente.
totalsAreShown()BooleanRetorna se os valores totais estão sendo mostrados para esse grupo de pivot.

PivotGroupLimit

Métodos

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

PivotTable

Métodos

MétodoTipo de retornoBreve descrição
addCalculatedPivotValue(name, formula)PivotValueCria um novo valor de pivot na tabela dinâmica calculado com base no formula especificado e no name especificado.
addColumnGroup(sourceDataColumn)PivotGroupDefine um novo grupo de colunas na tabela dinâmica.
addFilter(sourceDataColumn, filterCriteria)PivotFilterCria um novo filtro de tabela dinâmica para a tabela dinâmica.
addPivotValue(sourceDataColumn, summarizeFunction)PivotValueDefine um novo valor de pivot na tabela dinâmica com o summarizeFunction especificado.
addRowGroup(sourceDataColumn)PivotGroupDefine um novo grupo de linhas de pivot na tabela dinâmica.
asDataSourcePivotTable()DataSourcePivotTableRetorna a tabela dinâmica como uma tabela dinâmica da fonte de dados se ela estiver vinculada a um DataSource ou null.
getAnchorCell()RangeRetorna a Range que representa a célula em que essa 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 essa tabela dinâmica.
setValuesDisplayOrientation(dimension)PivotTableDefine o layout dessa tabela dinâmica para mostrar valores como colunas ou linhas.

PivotTableSummarizeFunction

Propriedades

PropriedadeTipoDescrição
CUSTOMEnumUma função personalizada, esse valor é válido apenas para campos calculados.
SUMEnumFunção SOMA
COUNTAEnumFunção CONT.A
COUNTEnumFunção CONT.SE
COUNTUNIQUEEnumFunção COUNTUNIQUE
AVERAGEEnumFunção MÉDIA
MAXEnumFunção MAX
MINEnumFunção MIN
MEDIANEnumFunção MEDIAN
PRODUCTEnumFunção PRODUCT
STDEVEnumFunção STDEV
STDEVPEnumFunção STDEVP
VAREnumFunção VAR
VARPEnumFunção VARP

PivotValue

Métodos

MétodoTipo de retornoBreve descrição
getDisplayType()PivotValueDisplayTypeRetorna o tipo de exibição que descreve como esse valor de pivote é mostrado na tabela.
getFormula()StringRetorna a fórmula usada para calcular esse valor.
getPivotTable()PivotTableRetorna o PivotTable ao qual este valor pertence.
getSourceDataColumn()IntegerRetorna o número da coluna de dados de origem que o valor dinâmico resume.
getSourceDataSourceColumn()DataSourceColumnRetorna a coluna da origem de dados resumida pelo valor dinâmico.
getSummarizedBy()PivotTableSummarizeFunctionRetorna a função de resumo desse 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 do campo dinâmico como uma porcentagem do total dessa linha.
PERCENT_OF_COLUMN_TOTALEnumMostra os valores do campo dinâmico como uma porcentagem do total dessa coluna.
PERCENT_OF_GRAND_TOTALEnumMostra os valores do eixo como uma porcentagem do valor total.

Protection

Métodos

MétodoTipo de retornoBreve descrição
addEditor(emailAddress)ProtectionAdiciona o usuário à lista de editores da planilha ou do intervalo protegidos.
addEditor(user)ProtectionAdiciona o usuário à lista de editores da planilha ou do intervalo protegidos.
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 que é proprietário da planilha têm permissão para editar a planilha ou o intervalo protegido.
canEdit()BooleanDetermina se o usuário tem permissão para editar a planilha ou o intervalo protegido.
getDescription()StringRetorna 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()RangeRetorna o intervalo que está sendo protegido.
getRangeName()StringExtrai 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 "com base em avisos".
remove()voidRemove a proteção do intervalo ou da página.
removeEditor(emailAddress)ProtectionRemove o usuário da lista de editores da planilha ou do intervalo protegido.
removeEditor(user)ProtectionRemove o usuário da lista de editores da planilha ou do intervalo protegido.
removeEditors(emailAddresses)ProtectionRemove a matriz de usuários da lista de editores da planilha ou do intervalo protegidos.
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 que são proprietários da planilha têm permissão para editar a folha ou o intervalo protegido.
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 de uma matriz de intervalos em uma página protegida.
setWarningOnly(warningOnly)ProtectionDefine se o intervalo protegido está usando ou não a proteção "com base em avisos".

ProtectionType

Propriedades

PropriedadeTipoDescrição
RANGEEnumProteção de um intervalo.
SHEETEnumProteção de 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 de faixas de coluna padrão ao intervalo.
applyColumnBanding(bandingTheme)BandingAplica um tema de faixas de colunas especificado ao intervalo.
applyColumnBanding(bandingTheme, showHeader, showFooter)BandingAplica um tema de faixa de coluna especificado ao intervalo com as configurações de cabeçalho e rodapé especificadas.
applyRowBanding()BandingAplica um tema de faixas de linha padrão ao intervalo.
applyRowBanding(bandingTheme)BandingAplica um tema de faixa de linha especificado ao intervalo.
applyRowBanding(bandingTheme, showHeader, showFooter)BandingAplica um tema de faixa de linhas especificado ao intervalo com as configurações de cabeçalho e rodapé especificadas.
autoFill(destination, series)voidPreenche destinationRange com dados com base nos dados nesse 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 as células de várias colunas no intervalo em células individuais novamente.
canEdit()BooleanDetermina se o usuário tem permissão para editar todas as células no intervalo.
check()RangeMuda o estado das caixas de seleção no intervalo para "marcada".
clear()RangeLimpa a variedade de conteúdos 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 para o intervalo.
clearFormat()RangeLimpa a formatação desse intervalo.
clearNote()RangeLimpa a observação na célula ou células especificadas.
collapseGroups()RangeRecolhe todos os grupos que estão 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)voidCopia o conteúdo do intervalo para o local especificado.
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)voidCopia o conteúdo do intervalo para o local especificado.
createDataSourcePivotTable(dataSource)DataSourcePivotTableCria uma tabela dinâmica de origem de dados vazia a partir da fonte de dados, ancorada na primeira célula no intervalo.
createDataSourceTable(dataSource)DataSourceTableCria uma tabela de fonte de dados vazia da fonte de dados, ancorada na primeira célula deste intervalo.
createDeveloperMetadataFinder()DeveloperMetadataFinderRetorna uma 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 ancorado na primeira célula neste intervalo.
createTextFinder(findText)TextFinderCria um localizador de texto para o intervalo, que pode encontrar e substituir o texto nesse intervalo.
deleteCells(shiftDimension)voidExclui este intervalo de células.
expandGroups()RangeAbre os grupos recolhidos cujo intervalo ou controle se cruza com esse intervalo.
getA1Notation()StringRetorna uma descrição de string do intervalo, na notação A1.
getBackground()StringRetorna a cor de plano de fundo da célula no canto superior esquerdo do intervalo (por exemplo, '#ffffff').
getBackgroundObject()ColorRetorna a cor de plano de fundo da célula no canto superior esquerdo do 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 neste intervalo.
getCell(row, column)RangeRetorna uma célula específica 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 cardeais 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 contém uma fórmula de fonte de dados.
getDataSourceFormulas()DataSourceFormula[]Retorna os DataSourceFormulas das células no intervalo.
getDataSourcePivotTables()DataSourcePivotTable[]Retorna todas as tabelas dinâmicas da fonte de dados que se cruzam com o intervalo.
getDataSourceTables()DataSourceTable[]Retorna 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 deste objeto como uma DataTable.
getDataTable(firstRowIsHeader)DataTableRetorna os dados dentro desse intervalo como uma DataTable.
getDataValidation()DataValidationRetorna a regra de validação de dados para a 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 exibido da célula superior esquerda no intervalo.
getDisplayValues()String[][]Retorna a grade retangular de valores para esse intervalo.
getFilter()FilterRetorna o filtro da planilha a que o 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()StringExtrai o estilo da linha da célula no canto superior esquerdo do intervalo ('underline', 'line-through' ou 'none').
getFontLines()String[][]Extrai 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 o peso da fonte (normal/negrito) da célula no canto superior esquerdo do intervalo.
getFontWeights()String[][]Retorna os pesos de fonte das células no intervalo.
getFormula()StringRetorna a fórmula (notação A1) da célula no canto superior esquerdo do intervalo ou uma string vazia se a célula estiver vazia ou não tiver uma fórmula.
getFormulaR1C1()StringRetorna a fórmula (notação R1C1) de uma determinada célula ou null se não houver nenhuma.
getFormulas()String[][]Retorna as fórmulas (notação A1) das células no intervalo.
getFormulasR1C1()String[][]Retorna as fórmulas (notação R1C1) das células no intervalo.
getGridId()IntegerRetorna o ID da grade da planilha pai do intervalo.
getHeight()IntegerRetorna a altura do intervalo.
getHorizontalAlignment()StringRetorna o alinhamento horizontal do texto (esquerda/centro/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 que estão totalmente no intervalo atual ou contêm pelo menos uma célula no intervalo atual.
getNextDataCell(direction)RangeComeçando na célula da primeira coluna e linha do intervalo, retorna a próxima célula na direção especificada, que é a borda de um intervalo contínuo de células com dados ou a célula na borda da planilha nessa direção.
getNote()StringRetorna a nota associada ao intervalo especificado.
getNotes()String[][]Retorna as notas associadas às células no intervalo.
getNumColumns()IntegerRetorna o número de colunas nesse intervalo.
getNumRows()IntegerRetorna o número de linhas nesse intervalo.
getNumberFormat()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 Rich Text para a célula superior esquerda do intervalo ou null se o valor da célula não for texto.
getRichTextValues()RichTextValue[][]Retorna os valores de texto enriquecido 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 este intervalo pertence.
getTextDirection()TextDirectionRetorna a direção do texto da célula superior esquerda do intervalo.
getTextDirections()TextDirection[][]Retorna as instruções de texto para as células no intervalo.
getTextRotation()TextRotationRetorna as configurações de rotação de texto para a 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 (topo/meio/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 para a célula superior esquerda do intervalo.
getWraps()Boolean[][]Retorna se o texto nas células está quebrado.
insertCells(shiftDimension)RangeInsere células vazias neste intervalo.
insertCheckboxes()RangeInsere caixas de seleção em cada célula do intervalo, configuradas com true para marcada e false para desmarcada.
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 desmarcada.
insertCheckboxes(checkedValue, uncheckedValue)RangeInsere caixas de seleção em cada célula do intervalo, configuradas com valores personalizados para os estados marcado e desmarcado.
isBlank()BooleanRetorna true se o intervalo estiver totalmente em branco.
isChecked()BooleanRetorna se todas as células no intervalo têm o estado de caixa de seleção como "marcada".
isEndColumnBounded()BooleanDetermina se o final do intervalo está vinculado a uma coluna específica.
isEndRowBounded()BooleanDetermina se o final do intervalo está vinculado a uma linha específica.
isPartOfMerge()BooleanRetorna true se as células no intervalo atual se sobrepõem 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 do intervalo em um único bloco.
mergeAcross()RangeMesclar as células do intervalo nas colunas do intervalo.
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 deslocado em relação a esse intervalo pelo número de linhas e colunas especificado, que pode ser negativo.
offset(rowOffset, columnOffset, numRows)RangeRetorna um novo intervalo relativo ao intervalo atual, cujo ponto superior esquerdo é deslocado do intervalo atual pelas linhas e colunas especificadas e com a altura especificada nas células.
offset(rowOffset, columnOffset, numRows, numColumns)RangeRetorna um novo intervalo relativo ao intervalo atual, cujo ponto superior esquerdo é deslocado do intervalo atual pelas linhas e colunas especificadas e com a altura e a largura especificadas nas células.
protect()ProtectionCria um objeto que pode impedir que o intervalo seja editado, exceto por usuários que têm permissão.
randomize()RangeOrdena aleatoriamente as linhas no intervalo especificado.
removeCheckboxes()RangeRemove todas as caixas de seleção do intervalo.
removeDuplicates()RangeRemove linhas nesse intervalo que contêm valores duplicados de valores em qualquer linha anterior.
removeDuplicates(columnsToCompare)RangeRemove linhas nesse intervalo que contêm valores nas colunas especificadas que são duplicatas de valores de qualquer linha anterior.
setBackground(color)RangeDefine a cor 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).
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 de fonte do intervalo especificado ('underline', 'line-through' ou 'none').
setFontLines(fontLines)RangeDefine uma grade retangular de estilos de linha (precisa corresponder às dimensões 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 fonte (precisa corresponder às dimensões desse intervalo).
setFontStyle(fontStyle)RangeDefine 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 fonte (precisa corresponder às dimensões desse intervalo).
setFormula(formula)RangeAtualiza a fórmula para esse intervalo.
setFormulaR1C1(formula)RangeAtualiza a fórmula para esse 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 precisa 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 de texto para as células no intervalo.
setTextRotation(rotation)RangeDefine as configurações de rotação de texto para as células no intervalo.
setTextRotations(rotations)RangeDefine uma grade retangular de rotações de texto.
setTextStyle(style)RangeDefine o estilo de texto 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 do intervalo).
setVerticalAlignment(alignment)RangeDefina o alinhamento vertical (de cima para baixo) para o intervalo especificado (topo/meio/inferior).
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 célula do intervalo especificado.
setWrapStrategies(strategies)RangeDefine uma grade retangular de estratégias de união.
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 palavras (precisa corresponder às dimensões deste intervalo).
shiftColumnGroupDepth(delta)RangeMuda a profundidade do agrupamento de colunas do intervalo pelo valor especificado.
shiftRowGroupDepth(delta)RangeMuda a profundidade do agrupamento de linhas do intervalo pelo valor especificado.
sort(sortSpecObj)RangeClassifica as células no intervalo especificado por coluna e ordem especificada.
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) de cada célula no intervalo.
uncheck()RangeMuda o estado das caixas de seleção no intervalo para "desmarcada".

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 "marcada".
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údos, formato, regras de validação de dados e comentários, conforme especificado com as opções fornecidas.
clearContent()RangeListLimpa o conteúdo de cada Range na lista de intervalos, deixando a formatação intacta.
clearDataValidations()RangeListLimpa as regras de validação de dados para cada Range na lista de intervalos.
clearFormat()RangeListLimpa a formatação de texto de cada Range na lista de intervalos.
clearNote()RangeListLimpa a observação de cada Range na lista de intervalos.
getRanges()Range[]Retorna uma lista de uma ou mais instâncias Range na mesma página.
insertCheckboxes()RangeListInsere caixas de seleção em cada célula do intervalo, configuradas com true para marcada e false para desmarcada.
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 desmarcada.
insertCheckboxes(checkedValue, uncheckedValue)RangeListInsere caixas de seleção em cada célula do intervalo, configuradas com valores personalizados para os estados marcado e desmarcado.
removeCheckboxes()RangeListRemove todas as caixas de seleção do intervalo.
setBackground(color)RangeListDefine a cor de plano de fundo para cada Range na lista de intervalos.
setBackgroundRGB(red, green, blue)RangeListDefine o plano de fundo como 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 a cor e/ou o estilo de 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 o peso da fonte para cada Range na lista de intervalos.
setFormula(formula)RangeListAtualiza a fórmula de cada Range na lista de intervalos.
setFormulaR1C1(formula)RangeListAtualiza a fórmula de cada Range na lista de intervalos.
setHorizontalAlignment(alignment)RangeListDefina o alinhamento horizontal para cada Range na lista de intervalos.
setNote(note)RangeListDefine o texto da nota 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 precisa 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 ou não.
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()RangeListCorta os espaços em branco (como espaços, tabulações ou novas linhas) em cada célula da lista de intervalos.
uncheck()RangeListMuda o estado das caixas de seleção no intervalo para "desmarcada".

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 caem no período da semana passada.
PAST_MONTHEnumDatas que se enquadram no período do mês passado.
PAST_YEAREnumDatas que se enquadram no período do ano passado.

RichTextValue

Métodos

MétodoTipo de retornoBreve descrição
copy()RichTextValueBuilderRetorna um builder para um valor de rich text inicializado com os valores desse valor de rich text.
getEndIndex()IntegerRetorna o índice final desse valor na célula.
getLinkUrl()StringRetorna o URL do link para esse valor.
getLinkUrl(startOffset, endOffset)StringRetorna o URL do link do texto de startOffset para endOffset.
getRuns()RichTextValue[]Retorna a string de texto enriquecido dividida em uma matriz de execuções, em que cada execução é a substring mais longa possível com um estilo de texto consistente.
getStartIndex()IntegerRetorna 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 substring especificada 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 existente.
setTextStyle(startOffset, endOffset, textStyle)RichTextValueBuilderAplica um estilo de texto à substring especificada desse valor.
setTextStyle(textStyle)RichTextValueBuilderAplica um estilo de texto a todo o valor.

Selection

Métodos

MétodoTipo de retornoBreve descrição
getActiveRange()RangeRetorna o intervalo selecionado na 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 planilha ativa na planilha.
getCurrentCell()RangeRetorna a célula atual (realçada) selecionada em um dos intervalos ativos ou null se não houver uma célula atual.
getNextDataRange(direction)RangeComeçando pelo current cell e active range e se movendo na direção indicada, retorna um intervalo ajustado em que a borda adequada do intervalo foi deslocada para cobrir o next data cell, mas ainda cobrindo a célula atual.

Sheet

Métodos

MétodoTipo de retornoBreve descrição
activate()SheetAtiva essa 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)SheetAnexar uma linha à parte de baixo da região de dados atual na planilha.
asDataSourceSheet()DataSourceSheetRetorna a planilha como DataSourceSheet se ela for do tipo SheetType.DATASOURCE ou null.
autoResizeColumn(columnPosition)SheetDefine a largura da coluna para ajustar o conteúdo.
autoResizeColumns(startColumn, numColumns)SheetDefine a largura de todas as colunas a partir da posição da coluna especificada para ajustar o conteúdo.
autoResizeRows(startRow, numRows)SheetDefine a altura de todas as linhas a partir da posição da linha especificada para ajustar o conteúdo.
clear()SheetLimpa a planilha de conteúdo e informações de formatação.
clear(options)SheetLimpa a página de sumário e/ou o formato, conforme especificado com as opções avançadas fornecidas.
clearConditionalFormatRules()voidRemove todas as regras de formatação condicional da planilha.
clearContents()SheetLimpa a folha de conteúdo, preservando as informações de formatação.
clearFormats()SheetLimpa a formatação da planilha, preservando o conteúdo.
clearNotes()SheetLimpa a folha de todas as anotações.
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 planilha específica, que pode ser a mesma da origem.
createDeveloperMetadataFinder()DeveloperMetadataFinderRetorna um DeveloperMetadataFinder para encontrar metadados do desenvolvedor no escopo desta folha.
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 especificada.
deleteRow(rowPosition)SheetExclui a linha na posição especificada.
deleteRows(rowPosition, howMany)voidExclui um número de linhas a partir da posição especificada.
expandAllColumnGroups()SheetAbre todos os grupos de colunas na página.
expandAllRowGroups()SheetAbre 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)SheetAbre todos os grupos de linhas até a profundidade especificada e fecha todos os outros.
getActiveCell()RangeRetorna a célula ativa nesta página.
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 faixas nesta página.
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 para 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[]Receba todas as regras de formatação condicional nesta página.
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 da fonte de dados.
getDataSourcePivotTables()DataSourcePivotTable[]Recebe todas as tabelas dinâmicas da fonte de dados.
getDataSourceTables()DataSourceTable[]Recebe todas as tabelas da fonte de dados.
getDeveloperMetadata()DeveloperMetadata[]Receba todos os metadados do desenvolvedor associados a esta página.
getDrawings()Drawing[]Retorna uma matriz de desenhos na página.
getFilter()FilterRetorna o filtro nesta página ou null se não houver um filtro.
getFormUrl()StringRetorna o URL do formulário que envia as respostas para essa página ou null se ela não tiver um formulário associado.
getFrozenColumns()IntegerRetorna o número de colunas congeladas.
getFrozenRows()IntegerRetorna o número de linhas congeladas.
getImages()OverGridImage[]Retorna todas as imagens fora da grade na página.
getIndex()IntegerConsegue a posição da planilha na planilha pai.
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, independentemente do conteúdo.
getMaxRows()IntegerRetorna o número atual de linhas na planilha, independentemente do conteúdo.
getName()StringRetorna o nome da planilha.
getNamedRanges()NamedRange[]Recebe todos os intervalos nomeados nesta página.
getParent()SpreadsheetRetorna o Spreadsheet que contém essa planilha.
getPivotTables()PivotTable[]Retorna todas as tabelas dinâmicas na página.
getProtections(type)Protection[]Recebe uma matriz de objetos que representam todos os intervalos protegidos na planilha ou uma matriz de um único elemento 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 especificadas e com o número de linhas especificado.
getRange(row, column, numRows, numColumns)RangeRetorna o intervalo com a célula superior esquerda nas coordenadas especificadas com o número de linhas e colunas indicado.
getRange(a1Notation)RangeRetorna o intervalo 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 para todos os grupos de linhas na planilha.
getRowGroupDepth(rowIndex)IntegerRetorna a profundidade do grupo da linha no índice especificado.
getRowHeight(rowPosition)IntegerConsegue 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 planilha.
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 seções na planilha.
getTabColorObject()ColorRecebe a cor da guia da página ou null se ela não tiver 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 fornecido.
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 fornecido.
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 a esta página.
insertColumnAfter(afterPosition)SheetInsere uma coluna após a posição da coluna especificada.
insertColumnBefore(beforePosition)SheetInsere uma coluna antes da posição da coluna especificada.
insertColumns(columnIndex)voidInsere uma coluna em branco em uma página no local especificado.
insertColumns(columnIndex, numColumns)voidInsere uma ou mais colunas em branco consecutivas em uma planilha, começando no local especificado.
insertColumnsAfter(afterPosition, howMany)SheetInsere um determinado número de colunas após a posição da coluna especificada.
insertColumnsBefore(beforePosition, howMany)SheetInsere um número de colunas antes da posição da 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 da linha especificada.
insertRowBefore(beforePosition)SheetInsere uma linha antes da posição da linha especificada.
insertRows(rowIndex)voidInsere uma linha em branco em uma página no local especificado.
insertRows(rowIndex, numRows)voidInsere uma ou mais linhas em branco consecutivas em uma planilha, começando no local especificado.
insertRowsAfter(afterPosition, howMany)SheetInsere um número de linhas após a posição da 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 seletor a esta página.
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)SlicerAdiciona um novo seletor a esta página.
isColumnHiddenByUser(columnPosition)BooleanRetorna se a coluna especificada está oculta pelo usuário.
isRightToLeft()BooleanRetorna true se o layout da página 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 pelo 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 por destinationIndex.
moveRows(rowSpec, destinationIndex)voidMove as linhas selecionadas pelo intervalo especificado para a posição indicada pelo destinationIndex.
newChart()EmbeddedChartBuilderRetorna um builder para criar um novo gráfico para esta página.
protect()ProtectionCria um objeto que pode impedir que a planilha seja editada, exceto por usuários que têm permissão.
removeChart(chart)voidRemove um gráfico da planilha pai.
setActiveRange(range)RangeDefine o intervalo especificado como active range na página ativa, com a célula superior esquerda do intervalo como current cell.
setActiveRangeList(rangeList)RangeListDefine a lista especificada de intervalos como active ranges na folha ativa.
setActiveSelection(range)RangeDefine a região de seleção ativa para esta página.
setActiveSelection(a1Notation)RangeDefine a seleção ativa, conforme especificado na notação A1 ou R1C1.
setColumnGroupControlPosition(position)SheetDefine a posição do controle de 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 na planilha pelas regras de entrada.
setCurrentCell(cell)RangeDefine a célula especificada como current cell.
setFrozenColumns(columns)voidCongelar o número especificado de colunas.
setFrozenRows(rows)voidCongelar o número especificado de linhas.
setHiddenGridlines(hideGridlines)SheetOculta ou mostra as linhas de grade da página.
setName(name)SheetDefine o nome da planilha.
setRightToLeft(rightToLeft)SheetDefine ou desativa o layout da página da direita para a esquerda.
setRowGroupControlPosition(position)SheetDefine a posição do controle de grupo de linhas na planilha.
setRowHeight(rowPosition, height)SheetDefine a altura da linha 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 fornecido.
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 página visível.
sort(columnPosition)SheetClassifica uma página por coluna, em ordem crescente.
sort(columnPosition, ascending)SheetOrdena 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 página.

SheetType

Propriedades

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

Slicer

Métodos

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

SortOrder

Propriedades

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

SortSpec

Métodos

MétodoTipo de retornoBreve descrição
getBackgroundColor()ColorRetorna a cor de plano de fundo usada para classificação ou null se ela estiver ausente.
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 a classificação ou null se ela estiver ausente.
getSortOrder()SortOrderRetorna a ordem de classificação.
isAscending()BooleanRetorna se a ordem de classificação é crescente.

Spreadsheet

Métodos

MétodoTipo de retornoBreve descrição
addDeveloperMetadata(key)SpreadsheetAdiciona metadados 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 à lista de editores do Spreadsheet.
addEditor(user)SpreadsheetAdiciona o usuário à lista de editores do Spreadsheet.
addEditors(emailAddresses)SpreadsheetAdiciona o array de usuários à lista de editores do Spreadsheet.
addMenu(name, subMenus)voidCria um novo menu na interface da planilha.
addViewer(emailAddress)SpreadsheetAdiciona o usuário à lista de espectadores do Spreadsheet.
addViewer(user)SpreadsheetAdiciona o usuário à lista de espectadores do Spreadsheet.
addViewers(emailAddresses)SpreadsheetAdiciona a matriz de usuários à lista de espectadores do Spreadsheet.
appendRow(rowContents)SheetAnexar uma linha à parte de baixo da região de dados atual na planilha.
autoResizeColumn(columnPosition)SheetDefine a largura da coluna 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 na planilha.
deleteActiveSheet()SheetExclui a planilha ativa.
deleteColumn(columnPosition)SheetExclui a coluna na posição especificada.
deleteColumns(columnPosition, howMany)voidExclui um número de colunas a partir da posição especificada.
deleteRow(rowPosition)SheetExclui a linha na posição especificada.
deleteRows(rowPosition, howMany)voidExclui um número de linhas a partir da posição especificada.
deleteSheet(sheet)voidExclui a planilha especificada.
duplicateActiveSheet()SheetDuplica a planilha ativa e a torna a planilha ativa.
getActiveCell()RangeRetorna a célula ativa nesta página.
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 em uma planilha.
getAs(contentType)BlobRetorna os dados dentro deste objeto como um blob convertido para o tipo de conteúdo especificado.
getBandings()Banding[]Retorna todas as faixas nesta planilha.
getBlob()BlobRetorne os dados dentro deste 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 da fonte de dados.
getDataSourcePivotTables()DataSourcePivotTable[]Recebe todas as tabelas dinâmicas da fonte de dados.
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]Consegue as programações de atualização desta planilha.
getDataSourceSheets()DataSourceSheet[]Retorna todas as planilhas de origem de dados na planilha.
getDataSourceTables()DataSourceTable[]Recebe todas as tabelas da 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 ela não tiver um formulário associado.
getFrozenColumns()IntegerRetorna o número de colunas congeladas.
getFrozenRows()IntegerRetorna o número de linhas congeladas.
getId()StringRecebe um identificador exclusivo para esta planilha.
getImages()OverGridImage[]Retorna todas as imagens fora da grade na página.
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()StringExtrai o nome do documento.
getNamedRanges()NamedRange[]Recebe todos os intervalos nomeados nesta planilha.
getNumSheets()IntegerRetorna o número de planilhas 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 especificado na notação A1 ou R1C1.
getRangeByName(name)RangeRetorna um intervalo nomeado ou null se nenhum intervalo com o nome fornecido for encontrado.
getRangeList(a1Notations)RangeListRetorna a coleção RangeList que representa os intervalos na mesma planilha especificados por uma lista não vazia de notações A1 ou R1C1.
getRecalculationInterval()RecalculationIntervalRetorna o intervalo de cálculo para essa planilha.
getRowHeight(rowPosition)IntegerConsegue a altura em pixels da linha especificada.
getSelection()SelectionRetorna o Selection atual na planilha.
getSheetById(id)SheetRecebe a página com o ID fornecido.
getSheetByName(name)SheetRetorna uma planilha com o nome fornecido.
getSheetId()IntegerRetorna o ID da planilha representada por este objeto.
getSheetName()StringRetorna o nome da planilha.
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 planilhas.
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[]Mostra a lista de leitores e comentaristas desse 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 da coluna especificada.
insertColumnsAfter(afterPosition, howMany)SheetInsere um determinado número de colunas após a posição da coluna especificada.
insertColumnsBefore(beforePosition, howMany)SheetInsere um número de colunas antes da posição da 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 da linha especificada.
insertRowBefore(beforePosition)SheetInsere uma linha antes da posição da linha especificada.
insertRowsAfter(afterPosition, howMany)SheetInsere um número de linhas após a posição da linha especificada.
insertRowsBefore(beforePosition, howMany)SheetInsere um número de linhas antes da posição de linha especificada.
insertSheet()SheetInsere uma nova planilha 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 de página padrão e argumentos avançados opcionais.
insertSheet(sheetName)SheetInsere uma nova página na planilha com o nome fornecido.
insertSheet(sheetName, sheetIndex)SheetInsere uma nova página na planilha com o nome especificado no índice especificado.
insertSheet(sheetName, sheetIndex, options)SheetInsere uma nova planilha na planilha com o nome fornecido no índice fornecido e usa argumentos avançados opcionais.
insertSheet(sheetName, options)SheetInsere uma nova página na planilha com o nome fornecido 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 da fonte de dados especificada e inicia a execução de dados.
isColumnHiddenByUser(columnPosition)BooleanRetorna se a coluna especificada está oculta pelo 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 pelo 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 com suporte e os objetos de fonte de dados vinculados, ignorando os objetos de fonte de dados inválidos.
removeEditor(emailAddress)SpreadsheetRemove o usuário da lista de editores do Spreadsheet.
removeEditor(user)SpreadsheetRemove o usuário 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 fornecido.
removeViewer(emailAddress)SpreadsheetRemove o usuário da lista de espectadores e comentaristas do Spreadsheet.
removeViewer(user)SpreadsheetRemove o usuário da lista de espectadores e comentaristas do Spreadsheet.
rename(newName)voidRenomeia o documento.
renameActiveSheet(newName)voidRenomeia a planilha ativa atual para o novo nome fornecido.
resetSpreadsheetTheme()SpreadsheetThemeRemove o tema aplicado e define o tema padrão na planilha.
setActiveRange(range)RangeDefine o intervalo especificado como active range na página ativa, com a célula superior esquerda do intervalo como current cell.
setActiveRangeList(rangeList)RangeListDefine a lista especificada de intervalos como active ranges na folha ativa.
setActiveSelection(range)RangeDefine a região de seleção ativa para esta página.
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.
setActiveSheet(sheet, restoreSelection)SheetDefine a planilha especificada como a 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)voidCongelar o número especificado de colunas.
setFrozenRows(rows)voidCongelar o número especificado de linhas.
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 precisam ser realizadas durante o cálculo iterativo.
setNamedRange(name, range)voidNomeia um intervalo.
setRecalculationInterval(recalculationInterval)SpreadsheetDefine com que frequência essa planilha precisa ser recalculada.
setRowHeight(rowPosition, height)SheetDefine a altura da linha em pixels.
setSpreadsheetLocale(locale)voidDefine a localidade da planilha.
setSpreadsheetTheme(theme)SpreadsheetThemeDefine um tema na planilha.
setSpreadsheetTimeZone(timezone)voidDefine o fuso horário da planilha.
show(userInterface)voidMostra um componente de interface do usuário personalizado em uma caixa de diálogo centralizada na viewport do navegador do usuário.
sort(columnPosition)SheetClassifica uma página por coluna, em ordem crescente.
sort(columnPosition, ascending)SheetOrdena uma página por coluna.
toast(msg)voidMostra uma janela pop-up no canto inferior direito da planilha com a mensagem.
toast(msg, title)voidMostra uma janela pop-up no canto inferior direito da planilha com a mensagem e o título fornecidos.
toast(msg, title, timeoutSeconds)voidMostra uma janela pop-up no canto inferior direito da planilha com o título e a mensagem fornecidos, que permanecem visíveis 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 menu adicionado por addMenu(name, subMenus).
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidAguarda até que todas as execuções atuais na planilha sejam concluídas, com um 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 faixas.
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 possíveis tipos de colagem.
DataExecutionErrorCodeDataExecutionErrorCodeUma enumeração dos possíveis códigos de erro de execução de dados.
DataExecutionStateDataExecutionStateUma enumeração dos possíveis estados de execução de dados.
DataSourceParameterTypeDataSourceParameterTypeUma enumeração dos possíveis tipos de parâmetros da fonte de dados.
DataSourceRefreshScopeDataSourceRefreshScopeUma enumeração de possíveis escopos de atualização da fonte de dados.
DataSourceTypeDataSourceTypeUma enumeração dos possíveis tipos de fontes de dados.
DataValidationCriteriaDataValidationCriteriaUma enumeração que representa os critérios de validação de dados que podem ser definidos em um intervalo.
DateTimeGroupingRuleTypeDateTimeGroupingRuleTypeUma enumeração de regras de agrupamento de data e hora.
DeveloperMetadataLocationTypeDeveloperMetadataLocationTypeUma enumeração de possíveis tipos de local de metadados do desenvolvedor.
DeveloperMetadataVisibilityDeveloperMetadataVisibilityUma enumeração das possíveis visibilidades de metadados do desenvolvedor.
DimensionDimensionUma enumeração das dimensões possíveis de uma planilha.
DirectionDirectionUma enumeração das direções possíveis em que uma pessoa pode 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 o botão 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 pivot pode ser mostrado.
ProtectionTypeProtectionTypeUma enumeração que representa as partes de uma planilha que podem ser protegidas contra edições.
RecalculationIntervalRecalculationIntervalUma enumeração dos intervalos possíveis que podem ser usados no recalculo da planilha.
RelativeDateRelativeDateUma enumeração de opções de data relativa para calcular um valor a ser usado em BooleanCriteria com base na data.
SheetTypeSheetTypeUma enumeração dos diferentes tipos de planilhas 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 o texto em colunas.
ThemeColorTypeThemeColorTypeUma enumeração de possíveis tipos de cores de tema.
ValueTypeValueTypeUma enumeração de tipos de valor retornados por Range.getValue() e Range.getValues() da classe Range do serviço Planilha.
WrapStrategyWrapStrategyUma enumeração das estratégias usadas para unir células.

Métodos

MétodoTipo de retornoBreve descrição
create(name)SpreadsheetCria uma nova planilha com o nome fornecido.
create(name, rows, columns)SpreadsheetCria uma 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 as 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()SheetRetorna 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 (realçada) selecionada em um dos intervalos ativos na folha 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 que o script adicione recursos como menus, caixas de diálogo e barras laterais.
newCellImage()CellImageBuilderCria um builder para uma CellImage.
newColor()ColorBuilderCria um builder para uma Color.
newConditionalFormatRule()ConditionalFormatRuleBuilderCria um builder para uma regra de formatação condicional.
newDataSourceSpec()DataSourceSpecBuilderCria um builder para uma DataSourceSpec.
newDataValidation()DataValidationBuilderCria um builder para uma regra de validação de dados.
newFilterCriteria()FilterCriteriaBuilderCria um builder para uma 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 correspondente ao objeto File fornecido.
openById(id)SpreadsheetAbre a planilha com o ID fornecido.
openByUrl(url)SpreadsheetAbre a planilha com o URL fornecido.
setActiveRange(range)RangeDefine o intervalo especificado como active range, com a célula superior esquerda no intervalo como current cell.
setActiveRangeList(rangeList)RangeListDefine a lista especificada de intervalos como 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 nesta 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 específico 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 para 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, configura a pesquisa para ignorar acentos durante a correspondência. Caso contrário, a pesquisa corresponde aos acentos.
matchCase(matchCase)TextFinderSe true, configura a pesquisa para corresponder exatamente ao caso do texto de pesquisa. Caso contrário, a pesquisa será padrão para correspondência sem distinção entre 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 será parcial.
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 exibido.
replaceAllWith(replaceText)IntegerSubstitui todas as correspondências pelo texto especificado.
replaceWith(replaceText)IntegerSubstitui o texto de pesquisa na célula correspondente com o 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 padrão do texto e a orientação atual do texto.
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 builder de estilo de texto inicializado com os valores desse estilo.
getFontFamily()StringConsegue 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()BooleanVerifica se o texto está em negrito.
isItalic()BooleanRetorna se a célula está em itálico ou não.
isStrikethrough()BooleanRecebe se a célula tem ou não tachado.
isUnderline()BooleanVerifica 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 é 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 é itálico ou não.
setStrikethrough(strikethrough)TextStyleBuilderDefine se o texto tem ou não tachado.
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()ColorTypeReceba 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 tem suporte.
TEXTEnumRepresenta a cor do texto.
BACKGROUNDEnumRepresenta a cor a ser usada para o 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
WRAPEnumUne linhas mais longas que a largura da célula em uma nova linha.
OVERFLOWEnumLinhas de transbordo na próxima célula, desde que ela esteja vazia.
CLIPEnumCortar linhas que são mais longas que a largura da célula.