Spreadsheet Service

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

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

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

Aulas

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

AutoFillSeries

Propriedades

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

Banding

Métodos

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

BandingTheme

Propriedades

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

BigQueryDataSourceSpec

Métodos

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

BigQueryDataSourceSpecBuilder

Métodos

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

BooleanCondition

Métodos

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

BooleanCriteria

Propriedades

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

BorderStyle

Propriedades

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

CellImage

Propriedades

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

Métodos

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

CellImageBuilder

Propriedades

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

Métodos

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

Color

Métodos

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

ColorBuilder

Métodos

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

ConditionalFormatRule

Métodos

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

ConditionalFormatRuleBuilder

Métodos

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

ContainerInfo

Métodos

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

CopyPasteType

Propriedades

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

DataExecutionErrorCode

Propriedades

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

DataExecutionState

Propriedades

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

DataExecutionStatus

Métodos

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

DataSource

Métodos

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

DataSourceChart

Métodos

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

DataSourceColumn

Métodos

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

DataSourceFormula

Métodos

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

DataSourceParameter

Métodos

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

DataSourceParameterType

Propriedades

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

DataSourcePivotTable

Métodos

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

DataSourceRefreshSchedule

Métodos

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

DataSourceRefreshScheduleFrequency

Métodos

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

DataSourceRefreshScope

Propriedades

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

DataSourceSheet

Métodos

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

DataSourceSheetFilter

Métodos

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

DataSourceSpec

Métodos

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

DataSourceSpecBuilder

Métodos

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

DataSourceTable

Métodos

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

DataSourceTableColumn

Métodos

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

DataSourceTableFilter

Métodos

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

DataSourceType

Propriedades

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

DataValidation

Métodos

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

DataValidationBuilder

Métodos

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

DataValidationCriteria

Propriedades

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

DateTimeGroupingRule

Métodos

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

DateTimeGroupingRuleType

Propriedades

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

DeveloperMetadata

Métodos

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

DeveloperMetadataFinder

Métodos

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

DeveloperMetadataLocation

Métodos

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

DeveloperMetadataLocationType

Propriedades

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

DeveloperMetadataVisibility

Propriedades

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

Dimension

Propriedades

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

Direction

Propriedades

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

Drawing

Métodos

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

EmbeddedAreaChartBuilder

Métodos

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

EmbeddedBarChartBuilder

Métodos

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

EmbeddedChart

Métodos

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

EmbeddedChartBuilder

Métodos

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

EmbeddedColumnChartBuilder

Métodos

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

EmbeddedComboChartBuilder

Métodos

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

EmbeddedHistogramChartBuilder

Métodos

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

EmbeddedLineChartBuilder

Métodos

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

EmbeddedPieChartBuilder

Métodos

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

EmbeddedScatterChartBuilder

Métodos

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

EmbeddedTableChartBuilder

Métodos

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

Filter

Métodos

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

FilterCriteria

Métodos

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

FilterCriteriaBuilder

Métodos

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

FrequencyType

Propriedades

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

GradientCondition

Métodos

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

Group

Métodos

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

GroupControlTogglePosition

Propriedades

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

InterpolationType

Propriedades

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

NamedRange

Métodos

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

OverGridImage

Métodos

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

PageProtection

PivotFilter

Métodos

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

PivotGroup

Métodos

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

PivotGroupLimit

Métodos

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

PivotTable

Métodos

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

PivotTableSummarizeFunction

Propriedades

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

PivotValue

Métodos

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