Spreadsheet Service

Planilha

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

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

Classes

NomeBreve descrição
AutoFillSeriesUma enumeração dos tipos de série usados para calcular os valores preenchidos automaticamente.
BandingAcessar e modificar as faixas, os padrões de cores aplicados a linhas ou colunas de um intervalo.
BandingThemeUma enumeração de temas de faixas.
BigQueryDataSourceSpecAcessar a especificação atual da fonte de dados do BigQuery.
BigQueryDataSourceSpecBuilderO builder da classe BigQueryDataSourceSpecBuilder.
BooleanConditionAcesse condições booleanas em ConditionalFormatRules.
BooleanCriteriaUma enumeração que representa os critérios booleanos que podem ser usados em formato ou filtro condicional.
BorderStyleEstilos que podem ser definidos em um intervalo usando Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style).
CellImageRepresenta uma imagem a ser adicionada a uma célula.
CellImageBuilderBuilder para a classe CellImage.
ColorUma representação para uma cor.
ColorBuilderO builder da classe ColorBuilder.
ConditionalFormatRuleAcessar regras de formatação condicional.
ConditionalFormatRuleBuilderBuilder de 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 de códigos de erro de execução de dados.
DataExecutionStateUma enumeração de estados de execução de dados.
DataExecutionStatusO status de execução dos dados.
DataSourceAcessar e modificar uma fonte de dados atual.
DataSourceChartAcessar e modificar um gráfico de fonte de dados existente.
DataSourceColumnAcessar e modificar uma coluna de fonte de dados.
DataSourceFormulaAcessar e modificar fórmulas de fontes de dados atuais.
DataSourceParameterAcessar parâmetros de fontes de dados atuais.
DataSourceParameterTypeUma enumeração de tipos de parâmetro da fonte de dados.
DataSourcePivotTableAcessar e modificar a tabela dinâmica de fonte de dados atual.
DataSourceRefreshScheduleAcessar e modificar uma programação de atualização existente.
DataSourceRefreshScheduleFrequencyAcessa a frequência de uma programação de atualização, que especifica a frequência e o momento da atualização.
DataSourceRefreshScopeUma enumeração de escopos para atualizações.
DataSourceSheetAcessar e modificar a página de fonte de dados existente.
DataSourceSheetFilterAcessar e modificar um filtro de planilha de fonte de dados existente.
DataSourceSpecAcesse as configurações gerais de uma especificação de fonte de dados atual.
DataSourceSpecBuilderO builder da classe DataSourceSpec.
DataSourceTableAcessar e modificar a tabela de fonte de dados atual.
DataSourceTableColumnAcessar e modificar uma coluna existente em um DataSourceTable.
DataSourceTableFilterAcessar e modificar um filtro de tabela de fonte de dados atual.
DataSourceTypeUma enumeração de tipos de fonte de dados.
DataValidationAcessar regras de validação de dados.
DataValidationBuilderBuilder de regras de validação de dados.
DataValidationCriteriaUma enumeração que representa os critérios de validação de dados que podem ser definidos em um intervalo.
DateTimeGroupingRuleAcessar uma regra de agrupamento de data-hora existente.
DateTimeGroupingRuleTypeOs tipos de regra de agrupamento de data e hora.
DeveloperMetadataAcessar e modificar metadados do desenvolvedor.
DeveloperMetadataFinderPesquisar metadados do desenvolvedor em uma planilha.
DeveloperMetadataLocationAcessar as informações de localização dos metadados do desenvolvedor.
DeveloperMetadataLocationTypeUma enumeração dos tipos de local dos metadados do desenvolvedor.
DeveloperMetadataVisibilityUma enumeração dos tipos de visibilidade dos metadados do desenvolvedor.
DimensionUma enumeração de possíveis direções pelas quais os dados podem ser armazenados em uma planilha.
DirectionUma enumeração que representa as direções possíveis que uma pessoa pode mover em uma planilha usando as teclas de seta.
DrawingRepresenta um desenho sobre uma folha em uma planilha.
EmbeddedAreaChartBuilderBuilder para gráficos de área.
EmbeddedBarChartBuilderBuilder de gráficos de barras.
EmbeddedChartRepresenta um gráfico que foi incorporado a uma planilha.
EmbeddedChartBuilderBuilder usado para editar um EmbeddedChart.
EmbeddedColumnChartBuilderBuilder de gráficos de colunas.
EmbeddedComboChartBuilderBuilder para gráficos de combinação.
EmbeddedHistogramChartBuilderBuilder de gráficos de histograma.
EmbeddedLineChartBuilderBuilder de gráficos de linhas.
EmbeddedPieChartBuilderBuilder de gráficos de pizza.
EmbeddedScatterChartBuilderBuilder de gráficos de dispersão.
EmbeddedTableChartBuilderBuilder de gráficos de tabela.
FilterUse essa classe para modificar os filtros existentes em páginas Grid, o tipo padrão de planilha.
FilterCriteriaUse esta classe para receber informações sobre os filtros atuais ou copiar os critérios deles.
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 combinar os critérios com as configurações especificadas.
FrequencyTypeUma enumeração de tipos de frequência.
GradientConditionAcesse condições de gradiente (cor) em ConditionalFormatRuleApis.
GroupAcessar e modificar grupos de planilhas.
GroupControlTogglePositionUma enumeração que representa as possíveis posições que um controle de alternância do grupo pode ter.
InterpolationTypeUma enumeração que representa as opções de interpolação para calcular um valor a ser usado em uma GradientCondition em um ConditionalFormatRule.
NamedRangeCriar, acessar e modificar intervalos nomeados em uma planilha.
OverGridImageRepresenta uma imagem sobre a grade em uma planilha.
PageProtectionAcessar e modificar páginas protegidas na versão antiga do Planilhas Google.
PivotFilterAcessar e modificar os filtros da tabela dinâmica.
PivotGroupAcesse e modifique grupos de tabelas dinâmicas.
PivotGroupLimitAcessar e modificar os limites dos grupos de tabelas dinâmicas.
PivotTableacessar e modificar tabelas dinâmicas;
PivotTableSummarizeFunctionUma enumeração de funções que resumem os dados da tabela dinâmica.
PivotValueAcessar e modificar grupos de valores em tabelas dinâmicas.
PivotValueDisplayTypeUma enumeração de maneiras de exibir um valor dinâmico como uma função de outro valor.
ProtectionAcessar e modificar intervalos e páginas protegidos.
ProtectionTypeUma enumeração que representa as partes de uma planilha que podem ser protegidas contra edições.
RangeAcessar e modificar intervalos da planilha.
RangeListUma coleção de uma ou mais instâncias de Range na mesma página.
RecalculationIntervalUma enumeração que representa os possíveis intervalos usados no recálculo da planilha.
RelativeDateUma enumeração que representa as opções de data relativa para calcular um valor a ser usado em BooleanCriteria com base na data.
RichTextValueUma string de texto estilizada usada para representar texto de célula.
RichTextValueBuilderUm builder para valores Rich Text.
SelectionAcessar a seleção ativa atual na planilha ativa.
SheetAcessar e modificar páginas de planilhas.
SheetTypeOs diferentes tipos de páginas que podem existir em uma planilha.
SlicerRepresenta um slicer, usado para filtrar intervalos, gráficos e tabelas dinâmicas de maneira não colaborativa.
SortOrderUma enumeração que representa a ordem de classificação.
SortSpecA especificação da classificação.
SpreadsheetAcessar e modificar arquivos do Planilhas Google.
SpreadsheetAppAcesse e crie arquivos do Planilhas Google.
SpreadsheetThemeAcessar e modificar temas existentes.
TextDirectionUma enumeração de direções de texto.
TextFinderLocalizar ou substituir texto em um intervalo, uma página ou uma planilha.
TextRotationAcesse as configurações de rotação do texto em 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.
ThemeColorTypeUm tipo enumerado que descreve várias entradas de cor com suporte nos temas.
ValueTypeUma enumeração de tipos de valor retornados por Range.getValue() e Range.getValues() da classe Range do serviço da planilha.
WrapStrategyUma enumeração das estratégias usadas para lidar com quebra de texto de célula.

AutoFillSeries

Propriedades

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

Banding

Métodos

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

BandingTheme

Propriedades

PropriedadeTipoDescrição
LIGHT_GREYEnumTema de faixas cinza-claro.
CYANEnumTema de faixas ciano.
GREENEnumTema de faixas verdes.
YELLOWEnumTema de faixas amarelas.
ORANGEEnumTema de faixas laranja.
BLUEEnumTema de faixas azuis.
TEALEnumTema de faixas na cor azul-petróleo.
GREYEnumTema de faixas cinza.
BROWNEnumTema de faixas marrons.
LIGHT_GREENEnumTema de faixas verde-claro.
INDIGOEnumTema de bandas na cor índigo.
PINKEnumTema de faixas rosa.

BigQueryDataSourceSpec

Métodos

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

BigQueryDataSourceSpecBuilder

Métodos

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

BooleanCondition

Métodos

MétodoTipo de retornoBreve descrição
getBackgroundObject()ColorRecebe a cor de fundo desta condição booleana.
getBold()BooleanRetornará true se essa condição booleana colocar o texto em negrito e retornará false se essa condição booleana remover o negrito do texto.
getCriteriaType()BooleanCriteriaRecebe o tipo de critérios da regra, conforme definido na enumeração BooleanCriteria.
getCriteriaValues()Object[]Recebe uma matriz de argumentos para os critérios da regra.
getFontColorObject()ColorRecebe a cor da fonte para essa condição booleana.
getItalic()BooleanRetorna true se essa condição booleana aplicar itálico ao texto e retornará false se essa condição booleana remover itálico do texto.
getStrikethrough()BooleanRetorna true se essa condição booleana tocar no texto e retorna false se ela remover o tachado do texto.
getUnderline()BooleanRetornará true se essa condição booleana sublinhar o texto e retornará false se essa condição booleana remover o sublinhado do texto.

BooleanCriteria

Propriedades

PropriedadeTipoDescrição
CELL_EMPTYEnumO critério é atendido quando uma célula está vazia.
CELL_NOT_EMPTYEnumOs critérios são atendidos quando uma célula não está vazia.
DATE_AFTEREnumO critério é atendido quando uma data é posterior ao valor fornecido.
DATE_BEFOREEnumO critério é atendido quando uma data é anterior ao valor fornecido.
DATE_EQUAL_TOEnumOs critérios são atendidos quando uma data é igual ao valor fornecido.
DATE_NOT_EQUAL_TOEnumOs critérios são atendidos quando uma data não é igual ao valor fornecido.
DATE_AFTER_RELATIVEEnumO critério é atendido quando uma data é posterior ao valor da data relativa.
DATE_BEFORE_RELATIVEEnumO critério é atendido quando uma data é anterior ao valor da data relativa.
DATE_EQUAL_TO_RELATIVEEnumO critério é atendido quando uma data é igual ao valor da data relativa.
NUMBER_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 fornecido.
NUMBER_GREATER_THANEnumO critério é atendido quando um número maior do que o valor fornecido.
NUMBER_GREATER_THAN_OR_EQUAL_TOEnumO critério é atendido quando um número é maior ou igual ao valor fornecido.
NUMBER_LESS_THANEnumO critério é atendido quando um número é menor que o valor fornecido.
NUMBER_LESS_THAN_OR_EQUAL_TOEnumO critério é atendido quando um número é menor ou igual ao valor fornecido.
NUMBER_NOT_BETWEENEnumOs critérios são atendidos quando um número que não está entre os valores fornecidos.
NUMBER_NOT_EQUAL_TOEnumO critério é atendido quando um número não é igual ao valor fornecido.
TEXT_CONTAINSEnumOs critérios são atendidos quando a entrada contém o valor fornecido.
TEXT_DOES_NOT_CONTAINEnumOs critérios são atendidos quando a entrada não contém o valor fornecido.
TEXT_EQUAL_TOEnumOs critérios são atendidos quando a entrada é igual ao valor fornecido.
TEXT_NOT_EQUAL_TOEnumOs critérios são atendidos quando a entrada não é igual ao valor fornecido.
TEXT_STARTS_WITHEnumO critério é atendido quando a entrada começa com o valor fornecido.
TEXT_ENDS_WITHEnumOs critérios são atendidos quando a entrada termina com o valor fornecido.
CUSTOM_FORMULAEnumOs critérios são atendidos quando a entrada faz com que a fórmula seja avaliada como true.

BorderStyle

Propriedades

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

CellImage

Propriedades

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

Métodos

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

Color

Métodos

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

ColorBuilder

Métodos

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

ConditionalFormatRule

Métodos

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

ConditionalFormatRuleBuilder

Métodos

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

ContainerInfo

Métodos

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

CopyPasteType

Propriedades

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

DataExecutionErrorCode

Propriedades

PropriedadeTipoDescrição
DATA_EXECUTION_ERROR_CODE_UNSUPPORTEDEnumCódigo de erro de execução de dados incompatível com o Apps Script.
NONEEnumA execução dos dados não apresentou erros.
TIME_OUTEnumA execução dos dados expirou.
TOO_MANY_ROWSEnumA execução de dados retorna mais linhas do que o limite.
TOO_MANY_COLUMNSEnumA execução de dados retorna mais colunas do que o limite.
TOO_MANY_CELLSEnumA execução 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 dados incompatível.
DUPLICATE_COLUMN_NAMESEnumA execução dos dados retorna nomes de coluna duplicados.
INTERRUPTEDEnumA execução dos dados é interrompida.
OTHEREnumOutros erros.
TOO_MANY_CHARS_PER_CELLEnumA execução dos dados retorna valores que excedem o máximo de caracteres permitido em uma única célula.
DATA_NOT_FOUNDEnumO banco de dados referenciado pela fonte de dados não foi encontrado.
PERMISSION_DENIEDEnumO usuário não tem acesso ao banco de dados referenciado pela fonte de dados.

DataExecutionState

Propriedades

PropriedadeTipoDescrição
DATA_EXECUTION_STATE_UNSUPPORTEDEnumO Apps Script não oferece suporte ao estado de execução de dados.
RUNNINGEnumA execução dos dados foi iniciada e está em execução.
SUCCESSEnumA execução dos dados foi concluída e bem-sucedida.
ERROREnumA execução dos dados foi concluída e tem 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()DataExecutionStateExtrai o estado da execução de dados.
getLastExecutionTime()DateExtrai a hora em que a última execução de dados foi concluída, independentemente do estado de execução.
getLastRefreshedTime()DateRecebe a hora em que os dados foram atualizados pela última vez.
isTruncated()BooleanRetornará true se os dados da última execução bem-sucedida forem truncados. Caso contrário, retornará false.

DataSource

Métodos

MétodoTipo de retornoBreve descrição
cancelAllLinkedDataSourceObjectRefreshes()voidCancela todas as atualizações em execução nos objetos da fonte de dados vinculados a essa fonte.
createCalculatedColumn(name, formula)DataSourceColumnCria uma coluna calculada.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableCria uma tabela dinâmica de fonte de dados com base nessa fonte de dados na primeira célula de uma nova página.
createDataSourceTableOnNewSheet()DataSourceTableCria uma tabela de fonte de dados com base nessa fonte de dados na primeira célula de uma nova planilha.
getCalculatedColumnByName(columnName)DataSourceColumnRetorna a coluna calculada na fonte de dados que corresponde ao nome da coluna.
getCalculatedColumns()DataSourceColumn[]Retorna todas as colunas calculadas na fonte de dados.
getColumns()DataSourceColumn[]Retorna todas as colunas na fonte de dados.
getDataSourceSheets()DataSourceSheet[]Retorna as páginas da fonte de dados associadas a essa fonte de dados.
getSpec()DataSourceSpecRecebe a especificação da fonte de dados.
refreshAllLinkedDataSourceObjects()voidAtualiza todos os objetos da fonte de dados vinculados à fonte.
updateSpec(spec)DataSourceAtualiza a especificação da fonte de dados e atualiza os objetos vinculados a essa fonte com a nova especificação.
updateSpec(spec, refreshAllLinkedObjects)DataSourceAtualiza a especificação da fonte de dados e 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 vinculados, expirando após o número fornecido de segundos.

DataSourceChart

Métodos

MétodoTipo de retornoBreve descrição
cancelDataRefresh()DataSourceChartCancela a atualização de dados associada a esse objeto se ele estiver em execução.
forceRefreshData()DataSourceChartAtualiza os dados desse objeto, independentemente do estado atual.
getDataSource()DataSourceExtrai a fonte de dados à qual o objeto está vinculado.
getStatus()DataExecutionStatusRecebe o status de execução de dados do objeto.
refreshData()DataSourceChartAtualiza os dados do objeto.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda a execução atual, expirando após o número fornecido de segundos.

DataSourceColumn

Métodos

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

DataSourceFormula

Métodos

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

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()DataSourceParameterTypeExtrai o tipo de parâmetro.

DataSourceParameterType

Propriedades

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

DataSourcePivotTable

Métodos

MétodoTipo de retornoBreve descrição
addColumnGroup(columnName)PivotGroupAdiciona um novo grupo de colunas dinâmicas com base na coluna da fonte de dados especificada.
addFilter(columnName, filterCriteria)PivotFilterAdiciona um novo filtro com base na coluna da fonte de dados especificada com os critérios de filtro especificados.
addPivotValue(columnName, summarizeFunction)PivotValueAdiciona um novo valor dinâmico com base na coluna da 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 da fonte de dados especificada.
asPivotTable()PivotTableRetorna a tabela dinâmica da fonte de dados como um objeto de tabela dinâmica normal.
cancelDataRefresh()DataSourcePivotTableCancela a atualização de dados associada a esse objeto se ele estiver em execução.
forceRefreshData()DataSourcePivotTableAtualiza os dados desse objeto, independentemente do estado atual.
getDataSource()DataSourceExtrai a fonte de dados à qual o objeto está vinculado.
getStatus()DataExecutionStatusRecebe o status de execução de dados do objeto.
refreshData()DataSourcePivotTableAtualiza os dados do objeto.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda a execução atual, expirando após o número fornecido de segundos.

DataSourceRefreshSchedule

Métodos

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

DataSourceRefreshScheduleFrequency

Métodos

MétodoTipo de retornoBreve descrição
getDaysOfTheMonth()Integer[]Recebe os dias do mês como números (1 a 28) para atualizar a fonte de dados.
getDaysOfTheWeek()Weekday[]Recebe os dias da semana em que a fonte de dados é atualizada.
getFrequencyType()FrequencyTypeExtrai 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 é aceito.
ALL_DATA_SOURCESEnumA atualização se aplica a todas as fontes de dados na planilha.

DataSourceSheet

Métodos

MétodoTipo de retornoBreve descrição
addFilter(columnName, filterCriteria)DataSourceSheetAdiciona um filtro aplicado à página da fonte de dados.
asSheet()SheetRetorna a página da fonte de dados como um objeto de planilha normal.
autoResizeColumn(columnName)DataSourceSheetRedimensiona automaticamente a largura da coluna especificada.
autoResizeColumns(columnNames)DataSourceSheetRedimensiona automaticamente a largura das colunas especificadas.
cancelDataRefresh()DataSourceSheetCancela a atualização de dados associada a esse objeto se ele estiver em execução.
forceRefreshData()DataSourceSheetAtualiza os dados desse objeto, independentemente do estado atual.
getColumnWidth(columnName)IntegerRetorna a largura da coluna especificada.
getDataSource()DataSourceExtrai a fonte de dados à qual o objeto está vinculado.
getFilters()DataSourceSheetFilter[]Retorna todos os filtros aplicados à página da fonte de dados.
getSheetValues(columnName)Object[]Retorna todos os valores da planilha da fonte de dados para o nome de coluna fornecido.
getSheetValues(columnName, startRow, numRows)Object[]Retorna todos os valores da página de fonte de dados referentes ao nome de coluna fornecido, desde a linha inicial (baseada em 1) até o numRows fornecido.
getSortSpecs()SortSpec[]Recebe todas as especificações de classificação na planilha da fonte de dados.
getStatus()DataExecutionStatusRecebe o status de execução de dados do objeto.
refreshData()DataSourceSheetAtualiza os dados do objeto.
removeFilters(columnName)DataSourceSheetRemove todos os filtros aplicados à coluna da página da fonte de dados.
removeSortSpec(columnName)DataSourceSheetRemove a especificação de classificação em uma coluna na planilha da fonte de dados.
setColumnWidth(columnName, width)DataSourceSheetDefine a largura da coluna especificada.
setColumnWidths(columnNames, width)DataSourceSheetDefine a largura das colunas especificadas.
setSortSpec(columnName, ascending)DataSourceSheetDefine a especificação de classificação em uma coluna na planilha da fonte de dados.
setSortSpec(columnName, sortOrder)DataSourceSheetDefine a especificação de classificação em uma coluna na planilha da fonte de dados.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda a execução atual, expirando após o número fornecido de segundos.

DataSourceSheetFilter

Métodos

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

DataSourceSpec

Métodos

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

DataSourceSpecBuilder

Métodos

MétodoTipo de retornoBreve descrição
asBigQuery()BigQueryDataSourceSpecBuilderRecebe o builder da fonte de dados do BigQuery.
build()DataSourceSpecCria uma especificação de fonte de dados com base nas configurações desse builder.
copy()DataSourceSpecBuilderCria um DataSourceSpecBuilder com base nas configurações dessa fonte de dados.
getParameters()DataSourceParameter[]Extrai os parâmetros da fonte de dados.
getType()DataSourceTypeExtrai o tipo da fonte de dados.
removeAllParameters()DataSourceSpecBuilderRemove todos os parâmetros.
removeParameter(parameterName)DataSourceSpecBuilderRemove o parâmetro especificado.
setParameterFromCell(parameterName, sourceCell)DataSourceSpecBuilderAdiciona um parâmetro ou, se o parâmetro com o nome já existir, atualiza sua 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 a uma coluna na tabela de fonte de dados.
addSortSpec(columnName, sortOrder)DataSourceTableAdiciona uma especificação de classificação a uma coluna na tabela de fonte de dados.
cancelDataRefresh()DataSourceTableCancela a atualização de dados associada a esse objeto se ele estiver em execução.
forceRefreshData()DataSourceTableAtualiza os dados desse objeto, independentemente do estado atual.
getColumns()DataSourceTableColumn[]Recebe todas as colunas de fonte de dados adicionadas à tabela de fonte de dados.
getDataSource()DataSourceExtrai a fonte de dados à qual o objeto está vinculado.
getFilters()DataSourceTableFilter[]Retorna todos os filtros aplicados à tabela de fonte de dados.
getRange()RangeRecebe o Range que esta tabela de fonte de dados abrange.
getRowLimit()IntegerRetorna o limite de linhas da tabela de fonte de dados.
getSortSpecs()SortSpec[]Recebe todas as especificações de classificação na tabela de fonte de dados.
getStatus()DataExecutionStatusRecebe o status de execução de dados do objeto.
isSyncingAllColumns()BooleanRetorna se a tabela de fonte de dados está sincronizando todas as colunas na fonte de dados associada.
refreshData()DataSourceTableAtualiza os dados do objeto.
removeAllColumns()DataSourceTableRemove todas as colunas 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()DataSourceTableSincronize todas as colunas atuais e futuras da fonte de dados associada com a tabela de fontes de dados.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda a execução atual, expirando após o número fornecido de segundos.

DataSourceTableColumn

Métodos

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

DataSourceTableFilter

Métodos

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

DataSourceType

Propriedades

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

DataValidation

Métodos

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

DataValidationBuilder

Métodos

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

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_AFTEREnumExige uma data igual ou posterior ao valor informado.
DATE_ON_OR_BEFOREEnumRequer uma data igual ou anterior ao valor informado.
NUMBER_BETWEENEnumRequer um número que esteja entre os valores fornecidos.
NUMBER_EQUAL_TOEnumRequer um número igual ao valor fornecido.
NUMBER_GREATER_THANEnumExigem um número maior do que o valor fornecido.
NUMBER_GREATER_THAN_OR_EQUAL_TOEnumRequer um número maior ou igual ao valor fornecido.
NUMBER_LESS_THANEnumRequer um número menor do que o valor fornecido.
NUMBER_LESS_THAN_OR_EQUAL_TOEnumRequer um número menor ou igual ao valor fornecido.
NUMBER_NOT_BETWEENEnumRequer um número que não esteja entre os valores fornecidos.
NUMBER_NOT_EQUAL_TOEnumRequer um número diferente do valor fornecido.
TEXT_CONTAINSEnumExige que a entrada contenha o valor informado.
TEXT_DOES_NOT_CONTAINEnumRequer que a entrada não contenha o valor informado.
TEXT_EQUAL_TOEnumExige que a entrada seja igual ao valor informado.
TEXT_IS_VALID_EMAILEnumExige que a entrada seja na forma de um endereço de e-mail.
TEXT_IS_VALID_URLEnumRequer que a entrada esteja na forma de um URL.
VALUE_IN_LISTEnumExige que a entrada seja igual a um dos valores fornecidos.
VALUE_IN_RANGEEnumExige que a entrada seja igual a um valor no intervalo informado.
CUSTOM_FORMULAEnumRequer que a entrada faça a fórmula especificada ser avaliada como true.
CHECKBOXEnumExige que a entrada seja um valor personalizado ou booleano; renderizado como uma caixa de seleção.

DateTimeGroupingRule

Métodos

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

DateTimeGroupingRuleType

Propriedades

PropriedadeTipoDescrição
UNSUPPORTEDEnumUm tipo de regra de agrupamento de data e hora não compatível.
SECONDEnumAgrupar data-hora por segundo, de 0 a 59.
MINUTEEnumAgrupar data-hora por minuto, de 0 a 59.
HOUREnumAgrupar data-hora por hora usando um sistema 24 horas, de 0 a 23.
HOUR_MINUTEEnumAgrupe data-hora por hora e minuto usando um sistema de 24 horas, por exemplo, 19:45.
HOUR_MINUTE_AMPMEnumAgrupe data-hora por hora e minuto usando um sistema de 12 horas, por exemplo, 7:45 PM.
DAY_OF_WEEKEnumAgrupar data-hora por dia da semana, por exemplo: Sunday.
DAY_OF_YEAREnumAgrupar data-hora por dia do ano, de 1 a 366.
DAY_OF_MONTHEnumAgrupar data-hora por dia do mês, de 1 a 31.
DAY_MONTHEnumAgrupe data-hora por dia e mês, por exemplo, 22-Nov.
MONTHEnumAgrupar data-hora por mês, por exemplo, Nov.
QUARTEREnumAgrupe data e hora por trimestre, por exemplo, Q1 (que representa de janeiro a março).
YEAREnumAgrupar data-hora por ano, por exemplo, 2008.
YEAR_MONTHEnumAgrupe data-hora por ano e mês, por exemplo, 2008-Nov.
YEAR_QUARTEREnumAgrupe data-hora por ano e trimestre, por exemplo, 2008 Q4 .
YEAR_MONTH_DAYEnumAgrupe data-hora por ano, mês e dia, por exemplo, 2008-11-22.

DeveloperMetadata

Métodos

MétodoTipo de retornoBreve descrição
getId()IntegerRetorna o ID exclusivo associado a esses metadados do desenvolvedor.
getKey()StringRetorna a chave associada aos metadados do desenvolvedor.
getLocation()DeveloperMetadataLocationRetorna o local dos metadados do desenvolvedor.
getValue()StringRetorna o valor associado a esses 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 página especificada.
moveToSpreadsheet()DeveloperMetadataMove os metadados do desenvolvedor para a planilha de nível superior.
remove()voidExclui esses metadados.
setKey(key)DeveloperMetadataDefine a chave dos metadados do desenvolvedor como o valor especificado.
setValue(value)DeveloperMetadataDefine o valor associado a estes 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 locais de interseção que têm metadados.
withId(id)DeveloperMetadataFinderLimita esta pesquisa para considerar apenas metadados que correspondem ao ID especificado.
withKey(key)DeveloperMetadataFinderLimita esta pesquisa para considerar apenas metadados que correspondem à chave especificada.
withLocationType(locationType)DeveloperMetadataFinderLimita esta pesquisa para considerar apenas metadados que correspondem ao tipo de local especificado.
withValue(value)DeveloperMetadataFinderLimita esta pesquisa para considerar apenas metadados que correspondem ao valor especificado.
withVisibility(visibility)DeveloperMetadataFinderLimita esta pesquisa para considerar apenas os metadados que correspondem à visibilidade especificada.

DeveloperMetadataLocation

Métodos

MétodoTipo de retornoBreve descrição
getColumn()RangeRetorna 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 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.
ROWEnumÉ o tipo de local dos metadados do desenvolvedor associados a uma linha.
COLUMNEnumO tipo de local dos metadados do desenvolvedor associados a uma coluna.

DeveloperMetadataVisibility

Propriedades

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

Dimension

Propriedades

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

Direction

Propriedades

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

Drawing

Métodos

MétodoTipo de retornoBreve descrição
getContainerInfo()ContainerInfoExtrai informações sobre onde o desenho está posicionado na folha.
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 desse desenho.
remove()voidExclui este desenho da planilha.
setHeight(height)DrawingDefine a altura real do desenho em pixels.
setOnAction(macroName)DrawingAtribui uma função macro a este desenho.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)DrawingDefine a posição em que o desenho aparece na folha.
setWidth(width)DrawingDefine a largura real do desenho em pixels.
setZIndex(zIndex)DrawingDefine o Z-index do desenho.

EmbeddedAreaChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que 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 criador modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que o criador modifica.
reverseCategories()EmbeddedAreaChartBuilderInverte o desenho da série no eixo de domínio.
setBackgroundColor(cssValue)EmbeddedAreaChartBuilderDefine a cor 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 mesclagem a ser usada quando há 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, o que significa que os valores da linha e da barra são empilhados (acumulados).
setTitle(chartTitle)EmbeddedAreaChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico serão transpostas.
setXAxisTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedAreaChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedAreaChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedAreaChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()EmbeddedAreaChartBuilderTransforma o eixo do intervalo em uma escala logarítmica (requer que todos os valores sejam positivos).

EmbeddedBarChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que 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 criador modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que o criador modifica.
reverseCategories()EmbeddedBarChartBuilderInverte o desenho da série no eixo de domínio.
reverseDirection()EmbeddedBarChartBuilderInverte a direção em que as barras crescem ao longo do eixo horizontal.
setBackgroundColor(cssValue)EmbeddedBarChartBuilderDefine a cor 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 mesclagem a ser usada quando há 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, o que significa que os valores da linha e da barra são empilhados (acumulados).
setTitle(chartTitle)EmbeddedBarChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico serão transpostas.
setXAxisTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedBarChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedBarChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedBarChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()EmbeddedBarChartBuilderTransforma o eixo do intervalo em uma escala logarítmica (requer que todos os valores sejam positivos).

EmbeddedChart

Métodos

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

EmbeddedChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que 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 criador modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que o criador 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 mesclagem a ser usada quando há 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 colunas do gráfico serão transpostas.

EmbeddedColumnChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que 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 criador modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que o criador modifica.
reverseCategories()EmbeddedColumnChartBuilderInverte o desenho da série no eixo de domínio.
setBackgroundColor(cssValue)EmbeddedColumnChartBuilderDefine a cor 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 mesclagem a ser usada quando há 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, o que significa que os valores da linha e da barra são empilhados (acumulados).
setTitle(chartTitle)EmbeddedColumnChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico serão transpostas.
setXAxisTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedColumnChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedColumnChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedColumnChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()EmbeddedColumnChartBuilderTransforma o eixo do intervalo em uma escala logarítmica (requer que todos os valores sejam positivos).

EmbeddedComboChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que 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 criador modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que o criador modifica.
reverseCategories()EmbeddedComboChartBuilderInverte o desenho da série no eixo de domínio.
setBackgroundColor(cssValue)EmbeddedComboChartBuilderDefine a cor 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 mesclagem a ser usada quando há 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, o que significa que os valores da linha e da barra são empilhados (acumulados).
setTitle(chartTitle)EmbeddedComboChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico serão transpostas.
setXAxisTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedComboChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedComboChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedComboChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()EmbeddedComboChartBuilderTransforma o eixo do intervalo em uma escala logarítmica (requer que todos os valores sejam positivos).

EmbeddedHistogramChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que 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 criador modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que o criador modifica.
reverseCategories()EmbeddedHistogramChartBuilderInverte o desenho da série no eixo de domínio.
setBackgroundColor(cssValue)EmbeddedHistogramChartBuilderDefine a cor 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 mesclagem a ser usada quando há 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, o que significa que os valores da linha e da barra são empilhados (acumulados).
setTitle(chartTitle)EmbeddedHistogramChartBuilderDefine o título do gráfico.
setTitleTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo de texto do título do gráfico.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderDefine se as linhas e colunas do gráfico serão transpostas.
setXAxisTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedHistogramChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedHistogramChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedHistogramChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()EmbeddedHistogramChartBuilderTransforma o eixo do intervalo em uma escala logarítmica (requer que todos os valores sejam positivos).

EmbeddedLineChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que 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 criador modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que o criador modifica.
reverseCategories()EmbeddedLineChartBuilderInverte o desenho da série no eixo de domínio.
setBackgroundColor(cssValue)EmbeddedLineChartBuilderDefine a cor 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 mesclagem a ser usada quando há 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 colunas do gráfico serão transpostas.
setXAxisTextStyle(textStyle)EmbeddedLineChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedLineChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedLineChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisTextStyle(textStyle)EmbeddedLineChartBuilderDefine o estilo de texto do eixo vertical.
setYAxisTitle(title)EmbeddedLineChartBuilderAdiciona um título ao eixo vertical.
setYAxisTitleTextStyle(textStyle)EmbeddedLineChartBuilderDefine o estilo do texto do título do eixo vertical.
useLogScale()EmbeddedLineChartBuilderTransforma o eixo do intervalo em uma escala logarítmica (requer que todos os valores sejam positivos).

EmbeddedPieChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que 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 criador modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que o criador modifica.
reverseCategories()EmbeddedPieChartBuilderInverte o desenho da série no eixo de domínio.
set3D()EmbeddedPieChartBuilderDefine o gráfico como tridimensional.
setBackgroundColor(cssValue)EmbeddedPieChartBuilderDefine a cor 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 mesclagem a ser usada quando há 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 colunas do gráfico serão transpostas.

EmbeddedScatterChartBuilder

Métodos

MétodoTipo de retornoBreve descrição
addRange(range)EmbeddedChartBuilderAdiciona um intervalo ao gráfico que 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 criador modifica.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que o criador modifica.
setBackgroundColor(cssValue)EmbeddedScatterChartBuilderDefine a cor 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 mesclagem a ser usada quando há 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 colunas do gráfico serão transpostas.
setXAxisLogScale()EmbeddedScatterChartBuilderTorna o eixo horizontal em uma escala logarítmica (exige que todos os valores sejam positivos).
setXAxisRange(start, end)EmbeddedScatterChartBuilderDefine o intervalo do eixo horizontal do gráfico.
setXAxisTextStyle(textStyle)EmbeddedScatterChartBuilderDefine o estilo de texto do eixo horizontal.
setXAxisTitle(title)EmbeddedScatterChartBuilderAdiciona um título ao eixo horizontal.
setXAxisTitleTextStyle(textStyle)EmbeddedScatterChartBuilderDefine o estilo do texto do título do eixo horizontal.
setYAxisLogScale()EmbeddedScatterChartBuilderTorna 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 criador modifica.
enablePaging(enablePaging)EmbeddedTableChartBuilderDefine se a paginação pelos dados será ativada.
enablePaging(pageSize)EmbeddedTableChartBuilderAtiva a paginação e define o número de linhas em cada página.
enablePaging(pageSize, startPage)EmbeddedTableChartBuilderAtiva a paginação, define o número de linhas em cada página e a primeira página da tabela a ser exibida (os números da página são baseados em zero).
enableRtlTable(rtlEnabled)EmbeddedTableChartBuilderAdiciona suporte básico a idiomas escritos da direita para a esquerda (como árabe ou hebraico) invertendo a ordem das colunas da tabela, de modo que a coluna zero seja a mais à direita e a última coluna seja a coluna mais à esquerda.
enableSorting(enableSorting)EmbeddedTableChartBuilderDefine se as colunas serão classificadas quando o usuário clicar no cabeçalho de uma coluna.
getChartType()ChartTypeRetorna o tipo de gráfico atual.
getContainer()ContainerInfoRetorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na planilha.
getRanges()Range[]Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico.
removeRange(range)EmbeddedChartBuilderRemove o intervalo especificado do gráfico que o criador 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 de acordo com o qual a tabela deve ser inicialmente classificada (crescente).
setInitialSortingDescending(column)EmbeddedTableChartBuilderDefine o índice da coluna de acordo com o qual a tabela será inicialmente classificada (decrescente).
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDefine a estratégia de mesclagem a ser usada quando há 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 colunas do gráfico serão transpostas.
showRowNumberColumn(showRowNumber)EmbeddedTableChartBuilderDefine se o número da linha será mostrado como a primeira coluna da tabela.
useAlternatingRowStyle(alternate)EmbeddedTableChartBuilderDefine se o estilo de cores alternadas será atribuído às 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 quando a coluna não tem critérios de filtro aplicados.
getRange()RangeExtrai o intervalo ao qual este filtro se aplica.
remove()voidRemove esse filtro.
removeColumnFilterCriteria(columnPosition)FilterRemove os critérios de filtro da coluna especificada.
setColumnFilterCriteria(columnPosition, filterCriteria)FilterDefine os critérios de filtro na coluna especificada.
sort(columnPosition, ascending)FilterClassifica o intervalo filtrado pela coluna especificada, excluindo a primeira linha (a linha de cabeçalho) no intervalo a que esse filtro se aplica.

FilterCriteria

Métodos

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

FilterCriteriaBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()FilterCriteriaMonta os critérios de filtro usando as configurações adicionadas ao criador de critérios.
copy()FilterCriteriaBuilderOs critérios deste filtro são copiados e um criador de critérios é criado que você pode aplicar a outro filtro.
getCriteriaType()BooleanCriteriaRetorna o tipo booleano dos critérios, por exemplo, CELL_EMPTY.
getCriteriaValues()Object[]Retorna uma matriz de argumentos para critérios booleanos.
getHiddenValues()String[]Retorna os valores que o filtro oculta.
getVisibleBackgroundColor()ColorRetorna a cor de fundo usada como critério de filtro.
getVisibleForegroundColor()ColorRetorna a cor do primeiro plano usada como critério de filtro.
getVisibleValues()String[]Retorna os valores exibidos pelo filtro da tabela dinâmica.
setHiddenValues(values)FilterCriteriaBuilderDefine os valores a serem ocultados.
setVisibleBackgroundColor(visibleBackgroundColor)FilterCriteriaBuilderDefine a cor do plano de fundo usada como critério de filtro.
setVisibleForegroundColor(visibleForegroundColor)FilterCriteriaBuilderDefine a cor do primeiro plano usada como critério de filtro.
setVisibleValues(values)FilterCriteriaBuilderDefine os valores que serão mostrados em uma tabela dinâmica.
whenCellEmpty()FilterCriteriaBuilderDefine os critérios de filtro para mostrar células vazias.
whenCellNotEmpty()FilterCriteriaBuilderDefine os critérios de filtro para mostrar células que não estão vazias.
whenDateAfter(date)FilterCriteriaBuilderDefine os critérios de filtro que mostram células com datas posteriores à data especificada.
whenDateAfter(date)FilterCriteriaBuilderDefine os critérios de filtro que mostram células com datas posteriores à data relativa especificada.
whenDateBefore(date)FilterCriteriaBuilderDefine os critérios de filtro que mostram células com datas anteriores à data especificada.
whenDateBefore(date)FilterCriteriaBuilderDefine os critérios de filtro que mostram células com datas anteriores à data relativa especificada.
whenDateEqualTo(date)FilterCriteriaBuilderDefine os critérios de filtro que mostram células com datas iguais à data especificada.
whenDateEqualTo(date)FilterCriteriaBuilderDefine os 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 que sejam iguais a qualquer uma das datas especificadas.
whenDateNotEqualTo(date)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células que não são iguais à data especificada.
whenDateNotEqualToAny(dates)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com datas que não são iguais a nenhuma das datas especificadas.
whenFormulaSatisfied(formula)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com uma fórmula especificada (como =B:B<C:C) que é avaliada como true.
whenNumberBetween(start, end)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número que esteja entre dois números especificados ou seja um deles.
whenNumberEqualTo(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número 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 número 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 número 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 que as células com um número são iguais e não são nenhum dos dois números especificados.
whenNumberNotEqualTo(number)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número diferente do especificado.
whenNumberNotEqualToAny(numbers)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com um número que não seja igual a nenhum dos números especificados.
whenTextContains(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto que contenha o texto especificado.
whenTextDoesNotContain(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto que não contenha o texto especificado.
whenTextEndsWith(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto que termina com o texto especificado.
whenTextEqualTo(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto igual ao texto especificado.
whenTextEqualToAny(texts)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto igual a qualquer um dos valores de texto especificados.
whenTextNotEqualTo(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto diferente do texto especificado.
whenTextNotEqualToAny(texts)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto diferente de qualquer um dos valores especificados.
whenTextStartsWith(text)FilterCriteriaBuilderDefine os critérios de filtro para mostrar células com texto que comece com o texto especificado.
withCriteria(criteria, args)FilterCriteriaBuilderDefine os critérios de filtro como uma condição booleana definida por valores BooleanCriteria, como CELL_EMPTY ou NUMBER_GREATER_THAN.

FrequencyType

Propriedades

PropriedadeTipoDescrição
FREQUENCY_TYPE_UNSUPPORTEDEnumO tipo de frequência não é aceito.
DAILYEnumAtualizar diariamente.
WEEKLYEnumSão atualizados toda semana, em determinados dias da semana.
MONTHLYEnumAtualizar mensalmente, em determinados dias do mês.

GradientCondition

Métodos

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

Group

Métodos

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

GroupControlTogglePosition

Propriedades

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

InterpolationType

Propriedades

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

NamedRange

Métodos

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

OverGridImage

Métodos

MétodoTipo de retornoBreve descrição
assignScript(functionName)OverGridImageAtribui a função com o nome de função especificado à imagem.
getAltTextDescription()StringRetorna a descrição do texto alternativo para esta imagem.
getAltTextTitle()StringRetorna o título do texto alternativo para esta imagem.
getAnchorCell()RangeRetorna a célula em que uma imagem está ancorada.
getAnchorCellXOffset()IntegerRetorna o deslocamento horizontal do pixel 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 dessa imagem em pixels.
getInherentWidth()IntegerRetorna a altura inerente dessa imagem em pixels.
getScript()StringRetorna o nome da função atribuída a essa imagem.
getSheet()SheetRetorna a página em que essa imagem aparece.
getUrl()StringRecebe o URL de origem da imagem. Retorna null se o URL não está disponível.
getWidth()IntegerRetorna a largura real dessa imagem em pixels.
remove()voidExclui a imagem da planilha.
replace(blob)OverGridImageSubstitui essa imagem pela especificada pelo BlobSource fornecido.
replace(url)OverGridImageSubstitui essa imagem pela do URL especificado.
resetSize()OverGridImageRedefine a imagem para as dimensões inerentes.
setAltTextDescription(description)OverGridImageDefine a descrição de texto alternativo para esta imagem.
setAltTextTitle(title)OverGridImageDefine o título do texto alternativo para esta imagem.
setAnchorCell(cell)OverGridImageDefine a célula onde uma imagem está ancorada.
setAnchorCellXOffset(offset)OverGridImageDefine o deslocamento horizontal do pixel a partir da célula âncora.
setAnchorCellYOffset(offset)OverGridImageDefine o deslocamento vertical do pixel 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 de filtro para este filtro dinâmico.
getPivotTable()PivotTableRetorna o PivotTable ao qual esse filtro pertence.
getSourceDataColumn()IntegerRetorna o número da coluna de dados de origem em que esse filtro opera.
getSourceDataSourceColumn()DataSourceColumnRetorna a coluna da fonte de dados em que o filtro opera.
remove()voidRemove o filtro dinâmico da tabela.
setFilterCriteria(filterCriteria)PivotFilterDefine os critérios de filtro para este filtro dinâmico.

PivotGroup

Métodos

MétodoTipo de retornoBreve descrição
addManualGroupingRule(groupName, groupMembers)PivotGroupAdiciona uma regra de agrupamento manual 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-hora estiver definida.
getDimension()DimensionRetorna se este é um grupo de linhas ou colunas.
getGroupLimit()PivotGroupLimitRetorna o limite do grupo dinâmico.
getIndex()IntegerRetorna o índice desse grupo dinâmico na ordem de grupo atual.
getPivotTable()PivotTableRetorna o PivotTable ao qual esse agrupamento pertence.
getSourceDataColumn()IntegerRetorna o número da coluna de dados de origem resumido por este grupo.
getSourceDataSourceColumn()DataSourceColumnRetorna a coluna de fonte de dados na qual o grupo dinâmico opera.
hideRepeatedLabels()PivotGroupOculta os rótulos repetidos deste agrupamento.
isSortAscending()BooleanRetorna true se a classificação for crescente, retorna false se a ordem de classificação for decrescente.
moveToIndex(index)PivotGroupMove este grupo para a posição especificada na lista atual de grupos de linhas ou colunas.
remove()voidRemove o 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 regr