Spreadsheet Service

Planilha

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

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

Classes

NomeBreve descrição
AutoFillSeriesUma enumeração dos tipos de série usados para calcular valores preenchidos automaticamente.
BandingAcesse e modifique as faixas, que são os padrões de cores aplicados a linhas ou colunas de um intervalo.
BandingThemeUma enumeração de temas de faixas.
BigQueryDataSourceSpecAcesse a especificação da fonte de dados do BigQuery.
BigQueryDataSourceSpecBuilderO builder de BigQueryDataSourceSpecBuilder.
BooleanConditionAcesse condições booleanas em ConditionalFormatRules.
BooleanCriteriaUma enumeração que representa os critérios booleanos que podem ser usados em formato condicional ou filtro.
BorderStyleEstilos que podem ser definidos em um intervalo usando Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style).
CellImageRepresenta uma imagem a ser adicionada a uma célula.
CellImageBuilderBuilder para a classe CellImage.
ColorUma representação de uma cor.
ColorBuilderO builder de ColorBuilder.
ConditionalFormatRuleAcessar regras de formatação condicional.
ConditionalFormatRuleBuilderBuilder para regras de formatação condicional.
ContainerInfoAcesse a posição do gráfico em uma página.
CopyPasteTypeUma enumeração de possíveis tipos de colagem especiais.
DataExecutionErrorCodeUma enumeração de códigos de erro de execução de dados.
DataExecutionStateUma enumeração de estados de execução de dados.
DataExecutionStatusO status de execução dos dados.
DataSourceAcessar e modificar a fonte de dados atual.
DataSourceChartAcessar e modificar um gráfico de fonte de dados.
DataSourceColumnAcessar e modificar uma coluna da fonte de dados.
DataSourceFormulaAcessar e modificar fórmulas de fontes de dados.
DataSourceParameterAcesse os parâmetros da fonte de dados atual.
DataSourceParameterTypeUma enumeração de tipos de parâmetros da fonte de dados.
DataSourcePivotTableAcesse e modifique a tabela dinâmica da fonte de dados.
DataSourceRefreshScheduleAcesse e modifique uma programação de atualização.
DataSourceRefreshScheduleFrequencyAcessar a frequência de uma programação de atualização, que especifica com que frequência e quando atualizar.
DataSourceRefreshScopeUma enumeração de escopos para atualizações.
DataSourceSheetAcesse e modifique a página da fonte de dados.
DataSourceSheetFilterAcesse e modifique um filtro de página de fonte de dados.
DataSourceSpecAcesse as configurações gerais de uma especificação de origem de dados.
DataSourceSpecBuilderO builder de DataSourceSpec.
DataSourceTableAcessar e modificar a tabela da fonte de dados.
DataSourceTableColumnAcesse e modifique uma coluna em um DataSourceTable.
DataSourceTableFilterAcessar e modificar um filtro de tabela de fonte de dados.
DataSourceTypeUma enumeração de tipos de fontes de dados.
DataValidationAcessar regras de validação de dados.
DataValidationBuilderCriador de regras de validação de dados.
DataValidationCriteriaUma enumeração que representa os critérios de validação de dados que podem ser definidos em um intervalo.
DateTimeGroupingRuleAcesse uma regra de agrupamento de data/hora.
DateTimeGroupingRuleTypeOs tipos de regra de agrupamento de data e hora.
DeveloperMetadataAcessar e modificar metadados do desenvolvedor.
DeveloperMetadataFinderPesquise metadados do desenvolvedor em uma planilha.
DeveloperMetadataLocationAcessar informações de local dos metadados do desenvolvedor.
DeveloperMetadataLocationTypeUma enumeração dos tipos de local de metadados do desenvolvedor.
DeveloperMetadataVisibilityUma enumeração dos tipos de visibilidade de metadados do desenvolvedor.
DimensionUma enumeração de direções possíveis em que os dados podem ser armazenados em uma planilha.
DirectionUma enumeração que representa as direções possíveis em que uma pessoa pode se mover em uma planilha usando as teclas de seta.
DrawingRepresenta um desenho sobre uma página em uma planilha.
EmbeddedAreaChartBuilderBuilder para gráficos de área.
EmbeddedBarChartBuilderBuilder para gráficos de barras.
EmbeddedChartRepresenta um gráfico incorporado a uma planilha.
EmbeddedChartBuilderBuilder usado para editar um EmbeddedChart.
EmbeddedColumnChartBuilderBuilder para gráficos de colunas.
EmbeddedComboChartBuilderBuilder para gráficos de combinação.
EmbeddedHistogramChartBuilderBuilder para gráficos de histograma.
EmbeddedLineChartBuilderBuilder para gráficos de linhas.
EmbeddedPieChartBuilderBuilder para gráficos de pizza.
EmbeddedScatterChartBuilderBuilder para gráficos de dispersão.
EmbeddedTableChartBuilderBuilder para gráficos de tabela.
FilterUse essa classe para modificar os filtros existentes em planilhas Grid, o tipo padrão de planilha.
FilterCriteriaUse essa classe para receber informações sobre os critérios dos filtros ou copiá-los.
FilterCriteriaBuilderPara adicionar critérios a um filtro, faça o seguinte:
  1. Crie o builder de critérios usando SpreadsheetApp.newFilterCriteria().
  2. Adicione configurações ao builder usando os métodos desta classe.
  3. Use build() para montar os critérios com as configurações especificadas.
FrequencyTypeUma enumeração de tipos de frequência.
GradientConditionAcesse as condições de gradiente (cor) em ConditionalFormatRuleApis.
GroupAcessar e modificar grupos de planilhas.
GroupControlTogglePositionUma enumeração que representa as posições possíveis de um botão de controle de grupo.
InterpolationTypeUma enumeração que representa as opções de interpolação para calcular um valor a ser usado em um GradientCondition em um ConditionalFormatRule.
LookerDataSourceSpecUm DataSourceSpec usado para acessar especificamente as especificações da fonte de dados do Looker.
LookerDataSourceSpecBuilderO builder de LookerDataSourceSpecBuilder.
NamedRangeCrie, acesse e modifique intervalos nomeados em uma planilha.
OverGridImageRepresenta uma imagem sobre a grade em uma planilha.
PageProtectionAcessar e modificar páginas protegidas na versão mais antiga das Planilhas Google.
PivotFilterAcessar e modificar filtros de tabelas dinâmicas.
PivotGroupAcessar e modificar grupos de detalhamento da tabela dinâmica.
PivotGroupLimitAcessar e modificar o limite do grupo de tabelas dinâmicas.
PivotTableAcessar e modificar tabelas dinâmicas.
PivotTableSummarizeFunctionUma enumeração de funções que resumem os dados da tabela dinâmica.
PivotValueAcessar e modificar grupos de valores em tabelas dinâmicas.
PivotValueDisplayTypeUma enumeração de maneiras de mostrar um valor de pivot como uma função de outro valor.
ProtectionAcessar e modificar intervalos e páginas protegidas.
ProtectionTypeUma enumeração que representa as partes de uma planilha que podem ser protegidas contra edições.
RangeAcessar e modificar intervalos de planilhas.
RangeListUma coleção de uma ou mais instâncias de Range na mesma planilha.
RecalculationIntervalUma enumeração que representa os intervalos possíveis usados no recalculo da planilha.
RelativeDateUma enumeração que representa as opções de data relativa para calcular um valor a ser usado em BooleanCriteria baseado em data.
RichTextValueUma string de texto estilizada usada para representar o texto da célula.
RichTextValueBuilderUm builder para valores de rich text.
SelectionAcessar a seleção ativa na página ativa.
SheetAcessar e modificar planilhas.
SheetTypeOs diferentes tipos de planilhas que podem existir em uma planilha.
SlicerRepresenta um controle de filtros, que é usado para filtrar intervalos, gráficos e tabelas dinâmicas de maneira não colaborativa.
SortOrderUma enumeração que representa a ordem de classificação.
SortSpecA especificação de classificação.
SpreadsheetAcessar e modificar arquivos das Planilhas Google.
SpreadsheetAppAcessar e criar arquivos das Planilhas Google.
SpreadsheetThemeAcessar e modificar temas.
TextDirectionUma enumeração de rotas em texto.
TextFinderEncontre ou substitua texto em um intervalo, página ou planilha.
TextRotationAcessar as configurações de rotação de texto de uma célula.
TextStyleO estilo renderizado do texto em uma célula.
TextStyleBuilderUm builder para estilos de texto.
TextToColumnsDelimiterUma enumeração dos tipos de delimitadores predefinidos que podem dividir uma coluna de texto em várias.
ThemeColorUma representação de uma cor de tema.
ThemeColorTypeUm tipo enumerado que descreve várias entradas de cores com suporte em temas.
ValueTypeUma enumeração de tipos de valor retornados por Range.getValue() e Range.getValues() da classe Range do serviço Planilha.
WrapStrategyUma enumeração das estratégias usadas para processar o recuo de texto da célula.

AutoFillSeries

Propriedades

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

Banding

Métodos

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

BandingTheme

Propriedades

PropriedadeTipoDescrição
LIGHT_GREYEnumUm tema de faixas cinza claro.
CYANEnumUm tema de faixas em ciano.
GREENEnumUm tema de faixas verdes.
YELLOWEnumUm tema de faixas amarelas.
ORANGEEnumUm tema de faixas laranja.
BLUEEnumUm tema de faixas azuis.
TEALEnumUm tema de faixas azul-petróleo.
GREYEnumUm tema de faixas cinzas.
BROWNEnumUm tema de faixas marrons.
LIGHT_GREENEnumUm tema de faixas verde-claro.
INDIGOEnumUm tema de faixas em azul índigo.
PINKEnumUm tema de faixas rosa.

BigQueryDataSourceSpec

Métodos

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

BigQueryDataSourceSpecBuilder

Métodos

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

BooleanCondition

Métodos

MétodoTipo de retornoBreve descrição
getBackgroundObject()ColorRecebe a cor de plano de fundo para essa condição booleana.
getBold()BooleanRetorna true se essa condição booleana negritar o texto e false se essa condição booleana remover o negrito do texto.
getCriteriaType()BooleanCriteriaExtrai o tipo de critério da regra, conforme definido no tipo enumerado BooleanCriteria.
getCriteriaValues()Object[]Recebe uma matriz de argumentos para os critérios da regra.
getFontColorObject()ColorRecebe a cor da fonte para essa condição booleana.
getItalic()BooleanRetorna true se essa condição booleana itálicos o texto e retorna false se essa condição booleana remove itálicos do texto.
getStrikethrough()BooleanRetorna true se essa condição booleana riscar o texto e false se ela remover o sublinhado do texto.
getUnderline()BooleanRetorna true se essa condição booleana sublinhar o texto e false se essa condição booleana remover o sublinhado do texto.

BooleanCriteria

Propriedades

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

BorderStyle

Propriedades

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

CellImage

Propriedades

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

Métodos

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

CellImageBuilder

Propriedades

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

Métodos

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

Color

Métodos

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

ColorBuilder

Métodos

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

ConditionalFormatRule

Métodos

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

ConditionalFormatRuleBuilder

Métodos

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

ContainerInfo

Métodos

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

CopyPasteType

Propriedades

PropriedadeTipoDescrição
PASTE_NORMALEnumCole valores, fórmulas, formatos e mesclagens.
PASTE_NO_BORDERSEnumColar valores, fórmulas, formatos e mesclagens, mas sem bordas.
PASTE_FORMATEnumColar apenas a formatação.
PASTE_FORMULAEnumCole apenas as fórmulas.
PASTE_DATA_VALIDATIONEnumCole apenas a validação de dados.
PASTE_VALUESEnumCole APENAS os valores sem formatos, fórmulas ou mesclagens.
PASTE_CONDITIONAL_FORMATTINGEnumCole apenas as regras de cor.
PASTE_COLUMN_WIDTHSEnumCole apenas as larguras das colunas.

DataExecutionErrorCode

Propriedades

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

DataExecutionState

Propriedades

PropriedadeTipoDescrição
DATA_EXECUTION_STATE_UNSUPPORTEDEnumNão há suporte para um estado de execução de dados no Apps Script.
RUNNINGEnumA execução dos dados foi iniciada e está em andamento.
SUCCESSEnumA execução dos dados foi concluída.
ERROREnumA execução dos dados foi concluída e tem erros.
NOT_STARTEDEnumA execução de dados não foi iniciada.

DataExecutionStatus

Métodos

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

DataSource

Métodos

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

DataSourceChart

Métodos

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

DataSourceColumn

Métodos

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

DataSourceFormula

Métodos

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

DataSourceParameter

Métodos

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

DataSourceParameterType

Propriedades

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

DataSourcePivotTable

Métodos

MétodoTipo de retornoBreve descrição
addColumnGroup(columnName)PivotGroupAdiciona um novo grupo de colunas dinâmicas com base na coluna de origem de dados especificada.
addFilter(columnName, filterCriteria)PivotFilterAdiciona um novo filtro com base na coluna da fonte de dados especificada e nos critérios de filtro especificados.
addPivotValue(columnName)PivotValueAdiciona um novo valor dinâmico com base na coluna de origem de dados especificada sem nenhuma função de resumo.
addPivotValue(columnName, summarizeFunction)PivotValueAdiciona um novo valor de pivot com base na coluna de origem de dados especificada e na função de resumo especificada.
addRowGroup(columnName)PivotGroupAdiciona um novo grupo de linhas de pivot com base na coluna da fonte de dados especificada.
asPivotTable()PivotTableRetorna a tabela dinâmica da fonte de dados como um objeto de tabela dinâmica normal.
cancelDataRefresh()DataSourcePivotTableCancela a atualização de dados associada a esse objeto se ela estiver em execução.
forceRefreshData()DataSourcePivotTableAtualiza os dados desse objeto, independentemente do estado atual.
getDataSource()DataSourceRecebe a fonte de dados à qual o objeto está vinculado.
getStatus()DataExecutionStatusRecebe o status de execução de dados do objeto.
refreshData()DataSourcePivotTableAtualiza os dados do objeto.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda até a conclusão da execução atual e expira após o número de segundos fornecido.

DataSourceRefreshSchedule

Métodos

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

DataSourceRefreshScheduleFrequency

Métodos

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

DataSourceRefreshScope

Propriedades

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

DataSourceSheet

Métodos

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

DataSourceSheetFilter

Métodos

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

DataSourceSpec

Métodos

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

DataSourceSpecBuilder

Métodos

MétodoTipo de retornoBreve descrição
asBigQuery()BigQueryDataSourceSpecBuilderRetorna o builder da fonte de dados do BigQuery.
asLooker()LookerDataSourceSpecBuilderRecebe o builder da origem de dados do Looker.
build()DataSourceSpecCria uma especificação de fonte de dados com base nas configurações deste criador.
copy()DataSourceSpecBuilderCria uma DataSourceSpecBuilder com base nas configurações da fonte de dados.
getParameters()DataSourceParameter[]Recebe os parâmetros da fonte de dados.
getType()DataSourceTypeRecebe o tipo da fonte de dados.
removeAllParameters()DataSourceSpecBuilderRemove todos os parâmetros.
removeParameter(parameterName)DataSourceSpecBuilderRemove o parâmetro especificado.
setParameterFromCell(parameterName, sourceCell)DataSourceSpecBuilderAdiciona um parâmetro ou, se o parâmetro com o nome existir, atualiza a célula de origem para construtores de especificação de origem de dados do tipo DataSourceType.BIGQUERY.

DataSourceTable

Métodos

MétodoTipo de retornoBreve descrição
addColumns(columnNames)DataSourceTableAdiciona colunas à tabela da fonte de dados.
addFilter(columnName, filterCriteria)DataSourceTableAdiciona um filtro aplicado à tabela da fonte de dados.
addSortSpec(columnName, ascending)DataSourceTableAdiciona uma especificação de classificação a uma coluna na tabela de origem de dados.
addSortSpec(columnName, sortOrder)DataSourceTableAdiciona uma especificação de classificação a uma coluna na tabela de origem de dados.
cancelDataRefresh()DataSourceTableCancela a atualização de dados associada a esse objeto se ela estiver em execução.
forceRefreshData()DataSourceTableAtualiza os dados desse objeto, independentemente do estado atual.
getColumns()DataSourceTableColumn[]Recebe todas as colunas da fonte de dados adicionadas à tabela da fonte de dados.
getDataSource()DataSourceRecebe a fonte de dados à qual o objeto está vinculado.
getFilters()DataSourceTableFilter[]Retorna todos os filtros aplicados à tabela da fonte de dados.
getRange()RangeRecebe o Range que a tabela da fonte de dados abrange.
getRowLimit()IntegerRetorna o limite de linhas da tabela da fonte de dados.
getSortSpecs()SortSpec[]Recebe todas as especificações de classificação na tabela da fonte de dados.
getStatus()DataExecutionStatusRecebe o status de execução de dados do objeto.
isSyncingAllColumns()BooleanRetorna se a tabela da fonte de dados está sincronizando todas as colunas na fonte de dados associada.
refreshData()DataSourceTableAtualiza os dados do objeto.
removeAllColumns()DataSourceTableRemove todas as colunas da tabela da fonte de dados.
removeAllSortSpecs()DataSourceTableRemove todas as especificações de classificação na tabela da fonte de dados.
setRowLimit(rowLimit)DataSourceTableAtualiza o limite de linhas da tabela da fonte de dados.
syncAllColumns()DataSourceTableSincronize todas as colunas atuais e futuras na fonte de dados associada com a tabela da fonte de dados.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda até a conclusão da execução atual e expira após o número de segundos fornecido.

DataSourceTableColumn

Métodos

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

DataSourceTableFilter

Métodos

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

DataSourceType

Propriedades

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

DataValidation

Métodos

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

DataValidationBuilder

Métodos

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

DataValidationCriteria

Propriedades

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

DateTimeGroupingRule

Métodos

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

DateTimeGroupingRuleType

Propriedades

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

DeveloperMetadata

Métodos

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

DeveloperMetadataFinder

Métodos

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

DeveloperMetadataLocation

Métodos

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

DeveloperMetadataLocationType

Propriedades

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

DeveloperMetadataVisibility

Propriedades

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

Dimension

Propriedades

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

Direction

Propriedades

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

Drawing

Métodos

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

EmbeddedAreaChartBuilder

Métodos

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

EmbeddedBarChartBuilder

Métodos

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

EmbeddedChart

Métodos

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

EmbeddedChartBuilder

Métodos

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

EmbeddedColumnChartBuilder

Métodos

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

EmbeddedComboChartBuilder

Métodos

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

EmbeddedHistogramChartBuilder

Métodos

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

EmbeddedLineChartBuilder

Métodos

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

EmbeddedPieChartBuilder

Métodos

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

EmbeddedScatterChartBuilder

Métodos

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

EmbeddedTableChartBuilder

Métodos

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

Filter

Métodos

MétodoTipo de retornoBreve descrição
getColumnFilterCriteria(columnPosition)FilterCriteriaConsegue os critérios de filtro na coluna especificada ou null se a coluna não tiver critérios de filtro aplicados.
getRange()RangeRecebe o intervalo em que o filtro é aplicado.
remove()voidRemove esse filtro.
removeColumnFilterCriteria(columnPosition)FilterRemove os critérios de filtro da coluna especificada.
setColumnFilterCriteria(columnPosition, filterCriteria)FilterDefine os critérios de filtro na coluna especificada.
sort(columnPosition, ascending)FilterOrdena o intervalo filtrado pela coluna especificada, excluindo a primeira linha (a linha de cabeçalho) no intervalo em que o filtro é aplicado.

FilterCriteria

Métodos

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

FilterCriteriaBuilder

Métodos

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

FrequencyType

Propriedades

PropriedadeTipoDescrição
FREQUENCY_TYPE_UNSUPPORTEDEnumO tipo de frequência não é aceito.
DAILYEnumAtualize diariamente.
WEEKLYEnumAtualização semanal em determinados dias da semana.
MONTHLYEnumAtualize mensalmente em determinados dias do mês.

GradientCondition

Métodos

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

Group

Métodos

MétodoTipo de retornoBreve descrição
collapse()GroupFechar este grupo.
expand()GroupAbre esse grupo.
getControlIndex()IntegerRetorna o índice de alternância de controle desse grupo.
getDepth()IntegerRetorna a profundidade desse grupo.
getRange()RangeRetorna o intervalo em que esse grupo existe.
isCollapsed()BooleanRetorna true se esse grupo estiver fechado.
remove()voidRemove esse grupo da planilha, reduzindo a profundidade do grupo do range em um.

GroupControlTogglePosition

Propriedades

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

InterpolationType

Propriedades

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

LookerDataSourceSpec

Métodos

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

LookerDataSourceSpecBuilder

Métodos

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

NamedRange

Métodos

MétodoTipo de retornoBreve descrição
getName()StringExtrai o nome desse intervalo nomeado.
getRange()RangeEncontra o intervalo referenciado por este intervalo nomeado.
remove()void