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 da planilha são agrupadas para melhorar o desempenho, como ao fazer várias chamadas a um método. Se você quiser garantir que todas as alterações pendentes sejam feitas imediatamente, por exemplo, para mostrar informações aos usuários durante a execução de um script, chame SpreadsheetApp.flush().

Classes

NomeBreve descrição
AutoFillSeriesUma enumeração dos tipos de séries usadas para calcular valores preenchidos automaticamente.
BandingAcessar e modificar as faixas, os padrões de cor aplicados a linhas ou colunas de um intervalo.
BandingThemeUma enumeração de temas de faixas.
BigQueryDataSourceSpecAcesse a especificação da fonte de dados atual 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 ou filtro condicional.
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 para uma cor.
ColorBuilderO builder de ColorBuilder.
ConditionalFormatRuleAcessar regras de formatação condicional.
ConditionalFormatRuleBuilderBuilder de 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.
DataExecutionStatusStatus de execução dos dados.
DataSourceAcessar e modificar a fonte de dados atual.
DataSourceChartAcessar e modificar um gráfico de fonte de dados existente.
DataSourceColumnAcessar e modificar uma coluna da fonte de dados.
DataSourceFormulaAcessar e modificar as fórmulas da fonte de dados atual
DataSourceParameterAcesse os parâmetros de fontes de dados atuais.
DataSourceParameterTypeUma enumeração de tipos de parâmetro da fonte de dados.
DataSourcePivotTableAcessar e modificar a tabela dinâmica de fonte de dados atual.
DataSourceRefreshScheduleAcessar e modificar uma programação de atualização existente.
DataSourceRefreshScheduleFrequencyAcessa a frequência de uma programação de atualização, que especifica a frequência e o momento da atualização.
DataSourceRefreshScopeUma enumeração de escopos para atualizações.
DataSourceSheetAcessar e modificar a página da fonte de dados atual.
DataSourceSheetFilterAcessar e modificar um filtro de página da fonte de dados atual.
DataSourceSpecAcesse as configurações gerais de uma especificação de fonte de dados atual.
DataSourceSpecBuilderO builder de DataSourceSpec.
DataSourceTableAcessar e modificar a tabela de fonte de dados atual.
DataSourceTableColumnAcesse e modifique uma coluna existente em um DataSourceTable.
DataSourceTableFilterAcessar e modificar um filtro de tabela da fonte de dados atual.
DataSourceTypeUma enumeração dos tipos de fontes de dados.
DataValidationAcessar regras de validação de dados.
DataValidationBuilderBuilder 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.
DateTimeGroupingRuleAcessar uma regra de agrupamento de data-hora existente.
DateTimeGroupingRuleTypeOs tipos de regra de agrupamento de data-hora.
DeveloperMetadataAcessar e modificar os metadados do desenvolvedor.
DeveloperMetadataFinderPesquise os metadados do desenvolvedor em uma planilha.
DeveloperMetadataLocationAcessar as informações de local dos metadados do desenvolvedor.
DeveloperMetadataLocationTypeUma enumeração dos tipos de local dos metadados do desenvolvedor.
DeveloperMetadataVisibilityUma enumeração dos tipos de visibilidade dos metadados do desenvolvedor.
DimensionUma enumeração de possíveis direções pelas quais os dados podem ser armazenados em uma planilha.
DirectionUma enumeração que representa as direções possíveis que se pode 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 de gráficos de barras.
EmbeddedChartRepresenta um gráfico que foi incorporado a uma planilha.
EmbeddedChartBuilderBuilder usado para editar um EmbeddedChart.
EmbeddedColumnChartBuilderBuilder para gráficos de colunas.
EmbeddedComboChartBuilderBuilder para gráficos de combinação.
EmbeddedHistogramChartBuilderBuilder de histogramas.
EmbeddedLineChartBuilderBuilder para gráficos de linhas.
EmbeddedPieChartBuilderBuilder de gráficos de pizza.
EmbeddedScatterChartBuilderBuilder de gráficos de dispersão.
EmbeddedTableChartBuilderBuilder de gráficos de tabela.
FilterUse essa classe para modificar os filtros existentes em Grid planilhas, o tipo padrão.
FilterCriteriaUse esta classe para ver informações ou copiar os critérios em filtros existentes.
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 dessa classe.
  3. Use build() para criar os critérios com as configurações especificadas.
FrequencyTypeUma enumeração de tipos de frequência.
GradientConditionAcesse condições de gradiente (cor) em ConditionalFormatRuleApis.
GroupAcessar e modificar grupos de planilhas.
GroupControlTogglePositionUma enumeração que representa as possíveis posições que um controle de grupo pode ter.
InterpolationTypeUma enumeração que representa as opções de interpolação para calcular um valor a ser usado em uma GradientCondition em uma ConditionalFormatRule.
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 do Planilhas Google.
PivotFilterAcessar e modificar filtros da tabela dinâmica.
PivotGroupAcessar e modificar grupos temáticos de tabelas dinâmicas.
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.
PivotValueAcesse e modifique grupos de valores em tabelas dinâmicas.
PivotValueDisplayTypeUma enumeração de maneiras de exibir um valor dinâmico como uma função de outro valor.
ProtectionAcessar e modificar páginas e intervalos 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 página.
RecalculationIntervalUma enumeração que representa os possíveis intervalos usados no recálculo da planilha.
RelativeDateUma enumeração que representa as opções de data relativa para calcular um valor a ser usado em BooleanCriteria baseado em data.
RichTextValueString de texto estilizado usada para representar texto de célula.
RichTextValueBuilderUm builder para valores de rich text.
SelectionAcessar a seleção ativa atual na página ativa.
SheetAcessar e modificar páginas de planilhas.
SheetTypeOs diferentes tipos de páginas que podem existir em uma planilha.
SlicerRepresenta um slicer, 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 da classificação.
Spreadsheetacessar e modificar arquivos do Planilhas Google;
SpreadsheetAppAcessar e criar arquivos do Planilhas Google.
SpreadsheetThemeAcessar e modificar temas existentes.
TextDirectionUma enumeração de direções de texto.
TextFinderEncontrar ou substituir texto em um intervalo, uma página ou uma planilha.
TextRotationAcesse as configurações de rotação de texto em uma célula.
TextStyleO estilo de texto renderizado em uma célula.
TextStyleBuilderUm builder para estilos de texto.
TextToColumnsDelimiterUma enumeração dos tipos de delimitadores predefinidos que podem dividir uma coluna de texto em várias colunas.
ThemeColorUma representação para uma cor de tema.
ThemeColorTypeUm tipo enumerado que descreve várias entradas de cor com suporte nos 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 do 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 for definida.
getFirstRowColorObject()ColorRetorna a primeira cor de linha alternada ou null se nenhuma cor for definida.
getFooterColumnColorObject()ColorRetorna a cor da última coluna na faixa ou null se nenhuma cor for definida.
getFooterRowColorObject()ColorRetorna a cor da última linha na faixa ou null se nenhuma cor for definida.
getHeaderColumnColorObject()ColorRetorna a cor da primeira coluna na faixa ou null se nenhuma cor for definida.
getHeaderRowColorObject()ColorRetorna a cor da linha do cabeçalho ou null se nenhuma cor for definida.
getRange()RangeRetorna o intervalo dessa faixa.
getSecondColumnColorObject()ColorRetorna a segunda cor de coluna alternada na faixa etária ou null se nenhuma cor for definida.
getSecondRowColorObject()ColorRetorna a segunda cor alternada da linha ou null se nenhuma cor for definida.
remove()voidRemove essa faixa.
setFirstColumnColor(color)BandingDefine a cor da primeira coluna que é alternada.
setFirstColumnColorObject(color)BandingDefine a primeira cor de coluna alternada na faixa de cores.
setFirstRowColor(color)BandingDefine a cor da primeira linha que é alternada.
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 do cabeçalho.
setHeaderColumnColorObject(color)BandingDefine a cor da coluna do cabeçalho.
setHeaderRowColor(color)BandingDefine a cor da linha do cabeçalho.
setHeaderRowColorObject(color)BandingDefine a cor da linha do cabeçalho.
setRange(range)BandingDefine o intervalo dessa faixa.
setSecondColumnColor(color)BandingDefine a cor da segunda coluna que é alternada.
setSecondColumnColorObject(color)BandingDefine a segunda cor de coluna alternada na faixa de cores.
setSecondRowColor(color)BandingDefine a cor da segunda linha que é alternada.
setSecondRowColorObject(color)BandingDefine a segunda cor alternada na faixa.

BandingTheme

Propriedades

PropriedadeTipoDescrição
LIGHT_GREYEnumTema de faixas cinza-claro.
CYANEnumTema de faixas cianos.
GREENEnumUm tema de faixa verde.
YELLOWEnumTema de faixas amarelas.
ORANGEEnumTema de faixas laranja.
BLUEEnumTema de faixa azul.
TEALEnumTema de banda azul-petróleo.
GREYEnumTema de faixas cinza.
BROWNEnumTema de faixas marrons.
LIGHT_GREENEnumTema de faixa verde-claro.
INDIGOEnumTema de bandas anil.
PINKEnumUm tema de faixas rosa.

BigQueryDataSourceSpec

Métodos

MétodoTipo de retornoBreve descrição
copy()DataSourceSpecBuilderCria um DataSourceSpecBuilder com base nas configurações dessa fonte de dados.
getDatasetId()StringRecebe o ID do conjunto de dados do BigQuery.
getParameters()DataSourceParameter[]Recebe os parâmetros da fonte de dados.
getProjectId()StringRecebe o ID do projeto de faturamento.
getRawQuery()StringRecebe a string de consulta bruta.
getTableId()StringRecebe o ID da tabela do BigQuery.
getTableProjectId()StringRecebe o ID do projeto do BigQuery para a tabela.
getType()DataSourceTypeExtrai 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 builder.
copy()DataSourceSpecBuilderCria um DataSourceSpecBuilder com base nas configurações dessa fonte de dados.
getDatasetId()StringRecebe o ID do conjunto de dados do BigQuery.
getParameters()DataSourceParameter[]Recebe os parâmetros da fonte de dados.
getProjectId()StringRecebe o ID do projeto de faturamento.
getRawQuery()StringRecebe a string de consulta bruta.
getTableId()StringRecebe o ID da tabela do BigQuery.
getTableProjectId()StringRecebe o ID do projeto do BigQuery para a tabela.
getType()DataSourceTypeExtrai 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.
setProjectId(projectId)BigQueryDataSourceSpecBuilderDefine o ID do projeto de faturamento do BigQuery.
setRawQuery(rawQuery)BigQueryDataSourceSpecBuilderDefine a string de consulta bruta.
setTableId(tableId)BigQueryDataSourceSpecBuilderDefine o ID da tabela do BigQuery.
setTableProjectId(projectId)BigQueryDataSourceSpecBuilderDefine o ID do projeto do BigQuery para a tabela.

BooleanCondition

Métodos

MétodoTipo de retornoBreve descrição
getBackgroundObject()ColorRecebe a cor de fundo dessa condição booleana.
getBold()BooleanRetornará true se essa condição booleana aplicar negrito ao texto e retornará false se essa condição booleana remover o negrito do texto.
getCriteriaType()BooleanCriteriaRecebe o tipo de critério da regra, conforme definido na enumeração BooleanCriteria.
getCriteriaValues()Object[]Recebe uma matriz de argumentos para os critérios da regra.
getFontColorObject()ColorRecebe a cor da fonte para esta condição booleana.
getItalic()BooleanRetornará true se essa condição booleana aplicar itálico ao texto e retornará false se essa condição booleana remover itálico do texto.
getStrikethrough()BooleanRetornará true se essa condição booleana ocorrer ao longo do texto e retornará false se ela remover o tachado do texto.
getUnderline()BooleanRetornará true se essa condição booleana sublinhar o texto e retornará 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_AFTEREnumOs critérios são atendidos quando uma data é posterior ao valor fornecido.
DATE_BEFOREEnumOs critérios são atendidos quando a data é anterior ao valor fornecido.
DATE_EQUAL_TOEnumOs critérios são atendidos quando uma data é igual ao valor fornecido.
DATE_NOT_EQUAL_TOEnumOs critérios são atendidos 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 a data é anterior ao valor da data relativa.
DATE_EQUAL_TO_RELATIVEEnumOs critérios são atendidos quando uma data é igual ao valor da data relativa.
NUMBER_BETWEENEnumOs critérios são atendidos 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 do 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_BETWEENEnumOs critérios são atendidos 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_CONTAINSEnumOs critérios são atendidos quando a entrada contém o valor determinado.
TEXT_DOES_NOT_CONTAINEnumOs critérios são atendidos quando a entrada não contém o valor fornecido.
TEXT_EQUAL_TOEnumOs critérios são atendidos quando a entrada é igual ao valor informado.
TEXT_NOT_EQUAL_TOEnumOs critérios são atendidos quando a entrada não é igual ao valor informado.
TEXT_STARTS_WITHEnumOs critérios são atendidos quando a entrada começa com o valor fornecido.
TEXT_ENDS_WITHEnumOs critérios são atendidos quando a entrada termina com o valor fornecido.
CUSTOM_FORMULAEnumOs critérios são atendidos quando a entrada faz com que a fórmula seja avaliada como true.

BorderStyle

Propriedades

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

CellImage

Propriedades

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

Métodos

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

CellImageBuilder

Propriedades

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

Métodos

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

Color

Métodos

MétodoTipo de retornoBreve descrição
asRgbColor()RgbColorConverte essa cor em um RgbColor.
asThemeColor()ThemeColorConverte essa cor em um ThemeColor.
getColorType()ColorTypeDefine 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 das configurações fornecidas para o builder.
getColorType()ColorTypeDefine o tipo dessa cor.
setRgbColor(cssString)ColorBuilderDefine como cor RGB.
setThemeColor(themeColorType)ColorBuilderDefine como cor do tema.

ConditionalFormatRule

Métodos

MétodoTipo de retornoBreve descrição
copy()ConditionalFormatRuleBuilderRetorna uma predefinição do criador de regras com as configurações dessa regra.
getBooleanCondition()BooleanConditionRecupera as informações 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 aos quais esta regra de formatação condicional é aplicada.

ConditionalFormatRuleBuilder

Métodos

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

ContainerInfo

Métodos

MétodoTipo de retornoBreve descrição
getAnchorColumn()IntegerO lado esquerdo do gráfico está ancorado nessa coluna.
getAnchorRow()IntegerA parte de cima do gráfico está ancorada nessa linha.
getOffsetX()IntegerO canto superior esquerdo do gráfico está deslocado da coluna âncora em muitos pixels.
getOffsetY()IntegerO canto superior esquerdo do gráfico está deslocado da linha da âncora por muitos pixels.

CopyPasteType

Propriedades

PropriedadeTipoDescrição
PASTE_NORMALEnumColar valores, fórmulas, formatos e mesclas.
PASTE_NO_BORDERSEnumColar valores, fórmulas, formatos e mesclas, mas sem bordas.
PASTE_FORMATEnumCole apenas a formatação.
PASTE_FORMULAEnumCole apenas as fórmulas.
PASTE_DATA_VALIDATIONEnumCole apenas a validação de dados.
PASTE_VALUESEnumCole os valores APENAS, sem formatos, fórmulas ou mesclas.
PASTE_CONDITIONAL_FORMATTINGEnumCole apenas as regras de cor.
PASTE_COLUMN_WIDTHSEnumCole apenas as larguras da coluna.

DataExecutionErrorCode

Propriedades

PropriedadeTipoDescrição
DATA_EXECUTION_ERROR_CODE_UNSUPPORTEDEnumUm código de erro de execução de dados que não é compatível com o Apps Script.
NONEEnumA execução dos dados não tem erros.
TIME_OUTEnumA execução dos dados expirou.
TOO_MANY_ROWSEnumA execução dos dados retorna mais linhas do que o limite.
TOO_MANY_COLUMNSEnumA execução dos dados retorna mais colunas do que o limite.
TOO_MANY_CELLSEnumA execução dos dados retorna mais células do que o limite.
ENGINEEnumErro 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 incompatível.
DUPLICATE_COLUMN_NAMESEnumA execução dos dados retorna nomes de coluna duplicados.
INTERRUPTEDEnumA execução dos dados é interrompida.
OTHEREnumOutros erros.
TOO_MANY_CHARS_PER_CELLEnumA execução dos dados retorna valores que excedem o máximo de caracteres permitido 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_UNSUPPORTEDEnumO estado de execução de dados não é compatível com o Apps Script.
RUNNINGEnumA execução dos dados foi iniciada e está em execução.
SUCCESSEnumA execução dos dados foi concluída e bem-sucedida.
ERROREnumA execução dos dados foi concluída e contém erros.
NOT_STARTEDEnumA execução dos dados não foi iniciada.

DataExecutionStatus

Métodos

MétodoTipo de retornoBreve descrição
getErrorCode()DataExecutionErrorCodeRecebe o código de erro da execução de dados.
getErrorMessage()StringRecebe a mensagem de erro da execução de dados.
getExecutionState()DataExecutionStateRecebe o estado da execução de dados.
getLastExecutionTime()DateExtrai a hora em que a última execução de dados foi concluída, independentemente do estado de execução.
getLastRefreshedTime()DateExtrai 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. Caso contrário, retorna false.

DataSource

Métodos

MétodoTipo de retornoBreve descrição
createCalculatedColumn(name, formula)DataSourceColumnCria uma coluna calculada.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableCria uma tabela dinâmica de fonte de dados com base nessa fonte de dados na primeira célula de uma nova página.
createDataSourceTableOnNewSheet()DataSourceTableCria uma tabela de fonte de dados com base nessa fonte de dados 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 páginas da fonte de dados associadas a essa fonte.
getSpec()DataSourceSpecRecebe a especificação da fonte de dados.
refreshAllLinkedDataSourceObjects()voidAtualiza todos os objetos da fonte de dados vinculados a ela.
updateSpec(spec)DataSourceAtualiza a especificação da fonte de dados e atualiza os objetos vinculados a essa fonte com a nova especificação.
updateSpec(spec, refreshAllLinkedObjects)DataSourceAtualiza a especificação da fonte de dados e o data source sheets vinculado com a nova especificação.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidAguarda até que todas as execuções atuais dos objetos da fonte de dados vinculados sejam concluídas, expirando após o número de segundos fornecido.

DataSourceChart

Métodos

MétodoTipo de retornoBreve descriçã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, expirando após o número de segundos fornecido.

DataSourceColumn

Métodos

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

DataSourceFormula

Métodos

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

DataSourceParameter

Métodos

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

DataSourceParameterType

Propriedades

PropriedadeTipoDescrição
DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTEDEnumUm tipo de parâmetro da 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 fonte de dados especificada.
addFilter(columnName, filterCriteria)PivotFilterAdiciona um novo filtro com base na coluna de fonte de dados especificada com os critérios de filtro especificados.
addPivotValue(columnName, summarizeFunction)PivotValueAdiciona um novo valor dinâmico com base na coluna de fonte de dados especificada com a função summarize especificada.
addRowGroup(columnName)PivotGroupAdiciona um novo grupo de linhas dinâmicas com base na coluna de fonte de dados especificada.
asPivotTable()PivotTableRetorna a tabela dinâmica de fonte de dados como um objeto de tabela dinâmica normal.
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, expirando 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 isso será feito.
getScope()DataSourceRefreshScopeRecebe o escopo dessa programação de atualização.
getTimeIntervalOfNextRun()TimeIntervalRecebe a janela de tempo da próxima execução dessa programação de atualização.
isEnabled()BooleanDetermina se 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[]Extrai os dias da semana em que a fonte de dados é 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 à página da fonte de dados.
asSheet()SheetRetorna a planilha de fonte de dados como um objeto de planilha normal.
autoResizeColumn(columnName)DataSourceSheetRedimensiona automaticamente a largura da coluna especificada.
autoResizeColumns(columnNames)DataSourceSheetRedimensiona automaticamente a largura das colunas especificadas.
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 da fonte de dados referente ao nome da coluna fornecido.
getSheetValues(columnName, startRow, numRows)Object[]Retorna todos os valores da página de fonte de dados referentes ao nome da coluna fornecido a partir da linha inicial fornecida (base-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 página 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 planilha da fonte de dados.
setSortSpec(columnName, sortOrder)DataSourceSheetDefine a especificação de classificação em uma coluna na planilha da fonte de dados.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda até que a execução atual seja concluída, expirando após o número de segundos fornecido.

DataSourceSheetFilter

Métodos

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

DataSourceSpec

Métodos

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

DataSourceSpecBuilder

Métodos

MétodoTipo de retornoBreve descrição
asBigQuery()BigQueryDataSourceSpecBuilderRecebe o builder da fonte de dados do BigQuery.
build()DataSourceSpecCria uma especificação de fonte de dados com base nas configurações deste builder.
copy()DataSourceSpecBuilderCria um DataSourceSpecBuilder com base nas configurações dessa fonte de dados.
getParameters()DataSourceParameter[]Recebe os parâmetros da fonte de dados.
getType()DataSourceTypeExtrai 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.

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 de fonte de dados.
addSortSpec(columnName, ascending)DataSourceTableAdiciona uma especificação de classificação a uma coluna na tabela de fonte de dados.
addSortSpec(columnName, sortOrder)DataSourceTableAdiciona uma especificação de classificação a uma coluna na tabela de fonte de dados.
forceRefreshData()DataSourceTableAtualiza os dados desse objeto, independentemente do estado atual.
getColumns()DataSourceTableColumn[]Extrai 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 de fonte de dados.
getRange()RangeRecebe o Range que esta tabela de fonte de dados abrange.
getRowLimit()IntegerRetorna o limite de linhas da tabela de fonte de dados.
getSortSpecs()SortSpec[]Recebe todas as especificações de classificação na tabela de fonte de dados.
getStatus()DataExecutionStatusRecebe o status de execução de dados do objeto.
isSyncingAllColumns()BooleanRetorna se a tabela de 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 de fonte de dados.
setRowLimit(rowLimit)DataSourceTableAtualiza o limite de linhas da tabela de fonte de dados.
syncAllColumns()DataSourceTableSincronize todas as colunas atuais e futuras na fonte de dados associada com a tabela de fonte de dados.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda até que a execução atual seja concluída, expirando após o número de segundos fornecido.

DataSourceTableColumn

Métodos

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

DataSourceTableFilter

Métodos

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

DataSourceType

Propriedades

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

DataValidation

Métodos

MétodoTipo de retornoBreve descrição
copy()DataValidationBuilderCria um builder para uma regra de validação de dados com base nas configurações dessa regra.
getAllowInvalid()BooleanRetorna true se a regra mostrar um aviso quando a entrada falha na validação de dados ou false se ela rejeita totalmente a entrada.
getCriteriaType()DataValidationCriteriaRecebe o tipo de critério da regra, conforme definido na enumeração DataValidationCriteria.
getCriteriaValues()Object[]Recebe uma matriz de argumentos para os critérios da regra.
getHelpText()StringRecebe o texto de ajuda da regra ou null se nenhum texto de ajuda foi definido.

DataValidationBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()DataValidationCria uma regra de validação de dados com base nas configurações aplicadas ao builder.
copy()DataValidationBuilderCria um builder para uma regra de validação de dados com base nas configurações dessa regra.
getAllowInvalid()BooleanRetorna true se a regra mostrar um aviso quando a entrada falha na validação de dados ou false se ela rejeita totalmente a entrada.
getCriteriaType()DataValidationCriteriaRecebe o tipo de critério da regra, conforme definido na enumeração DataValidationCriteria.
getCriteriaValues()Object[]Recebe uma matriz de argumentos para os critérios da regra.
getHelpText()StringRecebe o texto de ajuda da regra ou null se nenhum texto de ajuda foi 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 posterior ao valor especificado.
requireDateBefore(date)DataValidationBuilderDefine a regra de validação de dados para exigir uma data antes do valor determinado.
requireDateBetween(start, end)DataValidationBuilderDefine a regra de validação de dados para exigir uma data que esteja entre as duas datas especificadas.
requireDateEqualTo(date)DataValidationBuilderDefine a regra de validação de dados para exigir uma data igual ao valor informado.
requireDateNotBetween(start, end)DataValidationBuilderDefine a regra de validação de dados para exigir uma data que não fique entre duas datas especificadas e não seja nenhuma das duas.
requireDateOnOrAfter(date)DataValidationBuilderDefine a regra de validação de dados para exigir uma data igual ou posterior ao valor fornecido.
requireDateOnOrBefore(date)DataValidationBuilderDefine a regra de validação de dados para exigir uma data igual ou anterior ao valor fornecido.
requireFormulaSatisfied(formula)DataValidationBuilderDefine a regra de validação 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 do 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 do 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 fique entre dois números especificados e não seja de nenhum dos dois.
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 determinado.
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 na forma de um endereço de e-mail.
requireTextIsUrl()DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada esteja na forma de um URL.
requireValueInList(values)DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada seja igual a um dos valores fornecidos.
requireValueInList(values, showDropdown)DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada seja igual a um dos valores fornecidos, com uma opção para ocultar o menu suspenso.
requireValueInRange(range)DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada seja igual a um valor no intervalo determinado.
requireValueInRange(range, showDropdown)DataValidationBuilderDefine a regra de validação de dados para exigir que a entrada seja igual a um valor no intervalo especificado, com 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 ela será totalmente rejeitada.
setHelpText(helpText)DataValidationBuilderDefine o texto de ajuda que aparece quando o usuário passa o cursor sobre a célula em que a validação de dados está definida.
withCriteria(criteria, args)DataValidationBuilderDefine a regra de validação de dados para os critérios definidos por valores DataValidationCriteria, normalmente retirados de 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 informado.
DATE_IS_VALID_DATEEnumRequer uma data.
DATE_NOT_BETWEENEnumRequer uma data que não esteja entre os valores fornecidos.
DATE_ON_OR_AFTEREnumExige 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_THANEnumExige um número maior do 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 do 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_TOEnumExige que a entrada seja igual ao valor informado.
TEXT_IS_VALID_EMAILEnumRequer que a entrada esteja na forma de um endereço de e-mail.
TEXT_IS_VALID_URLEnumRequer que a entrada esteja na forma de um URL.
VALUE_IN_LISTEnumRequer que a entrada seja igual a um dos valores fornecidos.
VALUE_IN_RANGEEnumRequer que a entrada seja igual a um valor no intervalo fornecido.
CUSTOM_FORMULAEnumExige que a entrada faça a fórmula especificada ser avaliada como true.
CHECKBOXEnumRequer que a entrada seja um valor personalizado ou um booleano, renderizado como uma caixa de seleção.

DateTimeGroupingRule

Métodos

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

DateTimeGroupingRuleType

Propriedades

PropriedadeTipoDescrição
UNSUPPORTEDEnumUm tipo de regra de agrupamento de data-hora que não é compatível.
SECONDEnumAgrupar data-hora por segundo, de 0 a 59.
MINUTEEnumAgrupar data-hora por minuto, de 0 a 59.
HOUREnumAgrupe data-hora por hora usando um sistema 24 horas, de 0 a 23.
HOUR_MINUTEEnumAgrupe data-hora por hora e minuto usando um sistema de 24 horas, por exemplo, 19:45.
HOUR_MINUTE_AMPMEnumAgrupe data-hora por hora e minuto usando um sistema de 12 horas, por exemplo, 7:45 PM.
DAY_OF_WEEKEnumAgrupar data-hora pelo dia da semana, por exemplo, Sunday.
DAY_OF_YEAREnumAgrupar data-hora por dia do ano, de 1 a 366.
DAY_OF_MONTHEnumAgrupe data-hora por dia do mês, de 1 a 31.
DAY_MONTHEnumAgrupe a data-hora por dia e mês, por exemplo, 22-Nov.
MONTHEnumAgrupar data-hora por mês, por exemplo, Nov.
QUARTEREnumAgrupe data-hora por trimestre, por exemplo, T1 (que representa de janeiro a março).
YEAREnumAgrupar data-hora por ano, por exemplo, 2008.
YEAR_MONTHEnumAgrupe data-hora por ano e mês, por exemplo, 2008-Nov.
YEAR_QUARTEREnumAgrupe data-hora por ano e trimestre, por exemplo, 2008 Q4 .
YEAR_MONTH_DAYEnumAgrupe data-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 aos metadados desse desenvolvedor.
getKey()StringRetorna a chave associada aos metadados desse desenvolvedor.
getLocation()DeveloperMetadataLocationRetorna o local desses metadados do desenvolvedor.
getValue()StringRetorna o valor associado aos metadados do desenvolvedor ou null caso esses metadados não tenham valor.
getVisibility()DeveloperMetadataVisibilityRetorna a visibilidade dos metadados desse desenvolvedor.
moveToColumn(column)DeveloperMetadataMove os metadados do desenvolvedor para a coluna especificada.
moveToRow(row)DeveloperMetadataMove os metadados do desenvolvedor para a linha especificada.
moveToSheet(sheet)DeveloperMetadataMove os metadados do desenvolvedor para a página especificada.
moveToSpreadsheet()DeveloperMetadataMove os metadados do desenvolvedor para a planilha de nível superior.
remove()voidExclui esses metadados.
setKey(key)DeveloperMetadataDefine a chave dos metadados deste desenvolvedor para o valor especificado.
setValue(value)DeveloperMetadataDefine o valor associado aos metadados deste desenvolvedor como o valor especificado.
setVisibility(visibility)DeveloperMetadataDefine a visibilidade dos metadados do desenvolvedor como a visibilidade especificada.

DeveloperMetadataFinder

Métodos

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

DeveloperMetadataLocation

Métodos

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

DeveloperMetadataLocationType

Propriedades

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

DeveloperMetadataVisibility

Propriedades

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

Dimension

Propriedades

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

Direction

Propriedades

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

Drawing

Métodos

MétodoTipo de retornoBreve descrição
getContainerInfo()ContainerInfoRecebe informações sobre onde o desenho está posicionado na página.
getHeight()IntegerRetorna a altura real 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 Z-index desse desenho.
remove()voidExclui este desenho da planilha.
setHeight(height)DrawingDefine a altura real deste 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 deste desenho em pixels.
setZIndex(zIndex)DrawingDefine o Z-index do desenho.

EmbeddedAreaChartBuilder

Métodos

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

EmbeddedBarChartBuilder

Métodos

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

EmbeddedChart

Métodos

MétodoTipo de retornoBreve descrição
asDataSourceChart()DataSourceChartConverte para uma instância de gráfico da fonte de dados se o gráfico for de fonte de dados. Caso contrário, o resultado será null.
getAs(contentType)BlobRetorne os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBlob()BlobRetorne os dados dentro desse objeto como um blob.
getChartId()IntegerRetorna um identificador estável para o gráfico que é exclusivo em toda a 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 página.
getHiddenDimensionStrategy()ChartHiddenDimensionStrategyRetorna a estratégia a ser usada para lidar com linhas e colunas ocultas.
getMergeStrategy()ChartMergeStrategyRetorna a estratégia de mesclagem usada quando há mais de um intervalo.
getNumHeaders()IntegerRetorna o número de linhas ou colunas do intervalo que são tratadas como cabeçalhos.
getOptions()ChartOptionsRetorna as opções desse gráfico, como altura, cores e eixos.
getRanges()Range[]Retorna os intervalos que este gráfico usa como fonte de dados.
getTransposeRowsAndColumns()BooleanSe for true, as linhas e colunas usadas para preencher o gráfico serão alteradas.
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 que o criador modifica.
asAreaChart()EmbeddedAreaChartBuilderDefine o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderDefine o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderDefine o tipo de gráfico como ColumnChart e retorna EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderDefine o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderDefine o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderDefine o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderDefine o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderDefine o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderDefine o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder.
build()EmbeddedChartCria o gráfico para refletir todas as alterações feitas nele.
clearRanges()EmbeddedChartBuilderRemove todos os intervalos do gráfico que este construtor modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que o gráfico aparece na página.
getRanges()Range[]Retorna uma cópia da lista de intervalos que disponibilizam dados para o gráfico no momento.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que este criador modifica.
setChartType(type)EmbeddedChartBuilderMuda o tipo de gráfico.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderDefine a estratégia a ser usada para linhas e colunas ocultas.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de combinação a ser usada quando houver mais de um intervalo.
setNumHeaders(headers)EmbeddedChartBuilderDefine o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos.
setOption(option, value)EmbeddedChartBuilderDefine opções avançadas para este gráfico.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDefine a posição, alterando onde o gráfico aparece na página.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico serão transpostas.

EmbeddedColumnChartBuilder

Métodos

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

EmbeddedComboChartBuilder

Métodos

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

EmbeddedHistogramChartBuilder

Métodos

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

EmbeddedLineChartBuilder

Métodos

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

EmbeddedPieChartBuilder

Métodos

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

EmbeddedScatterChartBuilder

Métodos

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

EmbeddedTableChartBuilder

Métodos

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

Filter

Métodos

MétodoTipo de retornoBreve descrição
getColumnFilterCriteria(columnPosition)FilterCriteriaRecebe os critérios de filtro na coluna especificada ou null quando a coluna não tem critérios de filtro aplicados a ela.
getRange()RangeRecebe o intervalo ao qual este filtro se aplica.
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)FilterClassifica o intervalo filtrado pela coluna especificada, excluindo a primeira linha (a linha de cabeçalho) no intervalo a que esse filtro se aplica.

FilterCriteria

Métodos

MétodoTipo de retornoBreve descrição
copy()FilterCriteriaBuilderCopia esses critérios de filtro e cria um criador de critérios que você pode aplicar 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 fundo usada como critérios de filtro.
getVisibleForegroundColor()ColorRetorna a cor do primeiro plano usada como critério de filtro.
getVisibleValues()String[]Retorna os valores exibidos 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 que você adiciona ao criador de critérios.
copy()FilterCriteriaBuilderCopia esses critérios de filtro e cria um criador de critérios que você pode aplicar 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 fundo usada como critérios de filtro.
getVisibleForegroundColor()ColorRetorna a cor do primeiro plano usada como critério de filtro.
getVisibleValues()String[]Retorna os valores exibidos pelo filtro da tabela dinâmica.
setHiddenValues(values)FilterCriteriaBuilderDefine os valores a serem ocultados.
setVisibleBackgroundColor(visibleBackgroundColor)FilterCriteriaBuilderDefine a cor do plano de fundo usada como critério de filtro.
setVisibleForegroundColor(visibleForegroundColor)FilterCriteriaBuilderDefine a cor do primeiro plano usada como critério de filtro.
setVisibleValues(values)FilterCriteriaBuilderDefine os valores a serem mostrados em uma tabela dinâmica.
whenCellEmpty()FilterCriteriaBuilderDefine os critérios do filtro para mostrar células vazias.
whenCellNotEmpty()FilterCriteriaBuilderDefine os critérios de filtro para mostrar as células que não estão vazias.
whenDateAfter(date)FilterCriteriaBuilderDefine os critérios de filtro que mostram as células com datas posteriores à data especificada.
whenDateAfter(date)FilterCriteriaBuilderDefine os critérios de filtro que mostram as células com datas posteriores à data relativa especificada.
whenDateBefore(date)FilterCriteriaBuilderDefine os critérios de filtro que mostram as células com datas anteriores à data especificada.
whenDateBefore(date)FilterCriteriaBuilderDefine os critérios de filtro que mostram as células com datas anteriores à data relativa especificada.
whenDateEqualTo(date)FilterCriteriaBuilderDefine os critérios de filtro que mostram as células com datas iguais à data especificada.
whenDateEqualTo(date)FilterCriteriaBuilderDefine os critérios de filtro que mostram as células com datas iguais à data relativa especificada.
whenDateEqualToAny(dates)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com datas iguais a qualquer uma das datas especificadas.
whenDateNotEqualTo(date)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células que não sejam iguais à data especificada.
whenDateNotEqualToAny(dates)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com datas 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 esteja entre dois números especificados ou seja um dos dois.
whenNumberEqualTo(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número igual ao especificado.
whenNumberEqualToAny(numbers)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número igual a qualquer um dos números especificados.
whenNumberGreaterThan(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número maior que o especificado.
whenNumberGreaterThanOrEqualTo(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número maior ou igual ao número especificado.
whenNumberLessThan(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número menor que o especificado.
whenNumberLessThanOrEqualTo(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número menor ou igual ao número especificado.
whenNumberNotBetween(start, end)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número que não esteja entre os dois números especificados.
whenNumberNotEqualTo(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número diferente do especificado.
whenNumberNotEqualToAny(numbers)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número que não é igual a nenhum dos números especificados.
whenTextContains(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto que contenha o texto especificado.
whenTextDoesNotContain(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto que não contém o texto especificado.
whenTextEndsWith(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto que termine com o texto especificado.
whenTextEqualTo(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto igual ao texto especificado.
whenTextEqualToAny(texts)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto igual a qualquer um dos valores de texto especificados.
whenTextNotEqualTo(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto diferente do texto especificado.
whenTextNotEqualToAny(texts)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto diferente de nenhum dos valores especificados.
whenTextStartsWith(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto que comece com o texto especificado.
withCriteria(criteria, args)FilterCriteriaBuilderDefine os critérios de filtro como uma condição booleana definida por valores BooleanCriteria, como CELL_EMPTY ou NUMBER_GREATER_THAN.

FrequencyType

Propriedades

PropriedadeTipoDescrição
FREQUENCY_TYPE_UNSUPPORTEDEnumO tipo de frequência não é aceito.
DAILYEnumAtualizar diariamente.
WEEKLYEnumAtualizadas semanalmente em determinados dias da semana.
MONTHLYEnumÉ atualizado mensalmente, em determinados dias do mês.

GradientCondition

Métodos

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

Group

Métodos

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

GroupControlTogglePosition

Propriedades

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

InterpolationType

Propriedades

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

NamedRange

Métodos

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

OverGridImage

Métodos

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

PageProtection

PivotFilter

Métodos

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

PivotGroup

Métodos

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

PivotGroupLimit

Métodos

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

PivotTable

Métodos

MétodoTipo de retornoBreve descrição
addCalculatedPivotValue(name, formula)PivotValueCria um novo valor dinâmico na tabela dinâmica calculado a partir do formula especificado com o name especificado.
addColumnGroup(sourceDataColumn)PivotGroupDefine um novo agrupamento 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 dinâmico na tabela dinâmica com o summarizeFunction especificado.
addRowGroup(sourceDataColumn)PivotGroupDefine um novo agrupamento de linhas dinâmicas na tabela dinâmica.
asDataSourcePivotTable()DataSourcePivotTableRetornará a tabela dinâmica como tabela dinâmica de fonte de dados se estiver vinculada a uma DataSource. Caso contrário, retornará null.
getAnchorCell()RangeRetorna o 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 exibidos como linhas ou colunas.
remove()voidExclui esta tabela dinâmica.
setValuesDisplayOrientation(dimension)PivotTableDefine o layout dessa tabela dinâmica para exibir valores como colunas ou linhas.

PivotTableSummarizeFunction

Propriedades

PropriedadeTipoDescrição
CUSTOMEnumUma função personalizada. Esse valor só é válido para campos calculados.
SUMEnumA função SUM
COUNTAEnumA função CONT.VALORES
COUNTEnumA função COUNT
COUNTUNIQUEEnumA função COUNTUNIQUE
AVERAGEEnumA função AVERAGE
MAXEnumA função MAX
MINEnumA função MÍNIMO
MEDIANEnumA função MEDIAN
PRODUCTEnumA função PRODUCT
STDEVEnumA função DESVPAD
STDEVPEnumA função DESVPADP
VAREnumA função VAR
VARPEnumA função VARP

PivotValue

Métodos

MétodoTipo de retornoBreve descrição
getDisplayType()PivotValueDisplayTypeRetorna o tipo de exibição que descreve como esse valor dinâmico é exibido na tabela.
getFormula()StringRetorna a fórmula usada para calcular esse valor.
getPivotTable()PivotTableRetorna o PivotTable ao qual esse valor pertence.
getSourceDataColumn()IntegerRetorna o número da coluna de dados de origem resumido pelo valor dinâmico.
getSourceDataSourceColumn()DataSourceColumnRetorna a coluna de fonte 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)PivotValueExibe esse valor na tabela dinâmica como uma função de outro valor.
summarizeBy(summarizeFunction)PivotValueDefine a função de resumo.

PivotValueDisplayType

Propriedades

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

Protection

Métodos

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

ProtectionType

Propriedades

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

Range

Métodos

MétodoTipo de retornoBreve descrição
activate()RangeDefine o intervalo especificado como 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 de 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 banda de coluna padrão ao intervalo.
applyColumnBanding(bandingTheme)BandingAplica um tema de faixa de coluna especificado ao intervalo.
applyColumnBanding(bandingTheme, showHeader, showFooter)BandingAplica um tema de faixa de coluna especificado ao intervalo com configurações específicas de cabeçalho e rodapé.
applyRowBanding()BandingAplica um tema de faixa de linhas padrão ao intervalo.
applyRowBanding(bandingTheme)BandingAplica um tema de faixa de linhas especificado ao intervalo.
applyRowBanding(bandingTheme, showHeader, showFooter)BandingAplica um tema de faixa de linhas especificado ao intervalo com configurações de cabeçalho e rodapé especificadas.
autoFill(destination, series)voidPreenche o destinationRange com dados baseados nos dados desse intervalo.
autoFillToNeighbor(series)voidCalcula um intervalo a ser preenchido com novos dados com base em células vizinhas e preenche automaticamente esse intervalo com novos valores com base nos dados contidos nesse intervalo.
breakApart()RangeDivida todas as células de várias colunas no intervalo em células individuais novamente.
canEdit()BooleanDetermina se o usuário tem permissão para editar cada célula no intervalo.
check()RangeAltera o estado das caixas de seleção no intervalo para "marcada".
clear()RangeLimpa o intervalo de conteúdo e formatos.
clear(options)RangeLimpa o intervalo de conteúdo, formato, regras de validação de dados e/ou comentários, conforme especificado com as opções avançadas fornecidas.
clearContent()RangeLimpa o conteúdo do intervalo, deixando a formatação intacta.
clearDataValidations()RangeLimpa as regras de validação de dados para o intervalo.
clearFormat()RangeLimpa a formatação deste intervalo.
clearNote()RangeLimpa a nota em uma ou mais células específicas.
collapseGroups()RangeRecolhe todos os grupos contidos totalmente no intervalo.
copyFormatToRange(gridId, column, columnEnd, row, rowEnd)voidCopie a formatação do intervalo para o local especificado.
copyFormatToRange(sheet, column, columnEnd, row, rowEnd)voidCopie a formatação do intervalo para o local especificado.
copyTo(destination)voidCopia os dados de um intervalo de células para outro intervalo de células.
copyTo(destination, copyPasteType, transposed)voidCopia os dados de um intervalo de células para outro intervalo de células.
copyTo(destination, options)voidCopia os dados de um intervalo de células para outro intervalo de células.
copyValuesToRange(gridId, column, columnEnd, row, rowEnd)voidCopie o conteúdo do intervalo para o local especificado.
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)voidCopie o conteúdo do intervalo para o local especificado.
createDataSourcePivotTable(dataSource)DataSourcePivotTableCria uma tabela dinâmica de fonte de dados vazia a partir da fonte de dados, ancorada na primeira célula desse intervalo.
createDataSourceTable(dataSource)DataSourceTableCria uma tabela de fonte de dados vazia a partir da fonte de dados, ancorada na primeira célula desse intervalo.
createDeveloperMetadataFinder()DeveloperMetadataFinderRetorna uma DeveloperMetadataFinderApi para enc