Esse serviço permite que os scripts criem, acessem e modifiquem arquivos das Planilhas Google. Consulte também o guia para armazenar dados em planilhas.
Às vezes, as operações da planilha são agrupadas para melhorar o desempenho, como ao
fazer várias chamadas a um método. Se você quiser garantir que todas as alterações
pendentes sejam feitas imediatamente, por exemplo, para mostrar informações aos usuários durante a execução de um script,
chame SpreadsheetApp.flush()
.
Classes
Nome | Breve descrição |
---|---|
AutoFillSeries | Uma enumeração dos tipos de séries usadas para calcular valores preenchidos automaticamente. |
Banding | Acessar e modificar as faixas, os padrões de cor aplicados a linhas ou colunas de um intervalo. |
BandingTheme | Uma enumeração de temas de faixas. |
BigQueryDataSourceSpec | Acesse a especificação da fonte de dados atual do BigQuery. |
BigQueryDataSourceSpecBuilder | O builder de BigQueryDataSourceSpecBuilder . |
BooleanCondition | Acesse condições booleanas em ConditionalFormatRules . |
BooleanCriteria | Uma enumeração que representa os critérios booleanos que podem ser usados em formato ou filtro condicional. |
BorderStyle | Estilos que podem ser definidos em um intervalo usando Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style) . |
CellImage | Representa uma imagem a ser adicionada a uma célula. |
CellImageBuilder | Builder para a classe CellImage . |
Color | Uma representação para uma cor. |
ColorBuilder | O builder de ColorBuilder . |
ConditionalFormatRule | Acessar regras de formatação condicional. |
ConditionalFormatRuleBuilder | Builder de regras de formatação condicional. |
ContainerInfo | Acesse a posição do gráfico em uma página. |
CopyPasteType | Uma enumeração de possíveis tipos de colagem especiais. |
DataExecutionErrorCode | Uma enumeração de códigos de erro de execução de dados. |
DataExecutionState | Uma enumeração de estados de execução de dados. |
DataExecutionStatus | Status de execução dos dados. |
DataSource | Acessar e modificar a fonte de dados atual. |
DataSourceChart | Acessar e modificar um gráfico de fonte de dados existente. |
DataSourceColumn | Acessar e modificar uma coluna da fonte de dados. |
DataSourceFormula | Acessar e modificar as fórmulas da fonte de dados atual |
DataSourceParameter | Acesse os parâmetros de fontes de dados atuais. |
DataSourceParameterType | Uma enumeração de tipos de parâmetro da fonte de dados. |
DataSourcePivotTable | Acessar e modificar a tabela dinâmica de fonte de dados atual. |
DataSourceRefreshSchedule | Acessar e modificar uma programação de atualização existente. |
DataSourceRefreshScheduleFrequency | Acessa a frequência de uma programação de atualização, que especifica a frequência e o momento da atualização. |
DataSourceRefreshScope | Uma enumeração de escopos para atualizações. |
DataSourceSheet | Acessar e modificar a página da fonte de dados atual. |
DataSourceSheetFilter | Acessar e modificar um filtro de página da fonte de dados atual. |
DataSourceSpec | Acesse as configurações gerais de uma especificação de fonte de dados atual. |
DataSourceSpecBuilder | O builder de DataSourceSpec . |
DataSourceTable | Acessar e modificar a tabela de fonte de dados atual. |
DataSourceTableColumn | Acesse e modifique uma coluna existente em um DataSourceTable . |
DataSourceTableFilter | Acessar e modificar um filtro de tabela da fonte de dados atual. |
DataSourceType | Uma enumeração dos tipos de fontes de dados. |
DataValidation | Acessar regras de validação de dados. |
DataValidationBuilder | Builder de regras de validação de dados. |
DataValidationCriteria | Uma enumeração que representa os critérios de validação de dados que podem ser definidos em um intervalo. |
DateTimeGroupingRule | Acessar uma regra de agrupamento de data-hora existente. |
DateTimeGroupingRuleType | Os tipos de regra de agrupamento de data-hora. |
DeveloperMetadata | Acessar e modificar os metadados do desenvolvedor. |
DeveloperMetadataFinder | Pesquise os metadados do desenvolvedor em uma planilha. |
DeveloperMetadataLocation | Acessar as informações de local dos metadados do desenvolvedor. |
DeveloperMetadataLocationType | Uma enumeração dos tipos de local dos metadados do desenvolvedor. |
DeveloperMetadataVisibility | Uma enumeração dos tipos de visibilidade dos metadados do desenvolvedor. |
Dimension | Uma enumeração de possíveis direções pelas quais os dados podem ser armazenados em uma planilha. |
Direction | Uma enumeração que representa as direções possíveis que se pode mover em uma planilha usando as teclas de seta. |
Drawing | Representa um desenho sobre uma página em uma planilha. |
EmbeddedAreaChartBuilder | Builder para gráficos de área. |
EmbeddedBarChartBuilder | Builder de gráficos de barras. |
EmbeddedChart | Representa um gráfico que foi incorporado a uma planilha. |
EmbeddedChartBuilder | Builder usado para editar um EmbeddedChart . |
EmbeddedColumnChartBuilder | Builder para gráficos de colunas. |
EmbeddedComboChartBuilder | Builder para gráficos de combinação. |
EmbeddedHistogramChartBuilder | Builder de histogramas. |
EmbeddedLineChartBuilder | Builder para gráficos de linhas. |
EmbeddedPieChartBuilder | Builder de gráficos de pizza. |
EmbeddedScatterChartBuilder | Builder de gráficos de dispersão. |
EmbeddedTableChartBuilder | Builder de gráficos de tabela. |
Filter | Use essa classe para modificar os filtros existentes em Grid planilhas, o tipo padrão. |
FilterCriteria | Use esta classe para ver informações ou copiar os critérios em filtros existentes. |
FilterCriteriaBuilder | Para adicionar critérios a um filtro, faça o seguinte:
|
FrequencyType | Uma enumeração de tipos de frequência. |
GradientCondition | Acesse condições de gradiente (cor) em ConditionalFormatRuleApis . |
Group | Acessar e modificar grupos de planilhas. |
GroupControlTogglePosition | Uma enumeração que representa as possíveis posições que um controle de grupo pode ter. |
InterpolationType | Uma enumeração que representa as opções de interpolação para calcular um valor a ser usado em uma
GradientCondition em uma ConditionalFormatRule . |
NamedRange | Crie, acesse e modifique intervalos nomeados em uma planilha. |
OverGridImage | Representa uma imagem sobre a grade em uma planilha. |
| Acessar e modificar páginas protegidas na versão mais antiga do Planilhas Google. |
PivotFilter | Acessar e modificar filtros da tabela dinâmica. |
PivotGroup | Acessar e modificar grupos temáticos de tabelas dinâmicas. |
PivotGroupLimit | Acessar e modificar o limite do grupo de tabelas dinâmicas. |
PivotTable | Acessar e modificar tabelas dinâmicas. |
PivotTableSummarizeFunction | Uma enumeração de funções que resumem os dados da tabela dinâmica. |
PivotValue | Acesse e modifique grupos de valores em tabelas dinâmicas. |
PivotValueDisplayType | Uma enumeração de maneiras de exibir um valor dinâmico como uma função de outro valor. |
Protection | Acessar e modificar páginas e intervalos protegidos. |
ProtectionType | Uma enumeração que representa as partes de uma planilha que podem ser protegidas contra edições. |
Range | Acessar e modificar intervalos de planilhas. |
RangeList | Uma coleção de uma ou mais instâncias de Range na mesma página. |
RecalculationInterval | Uma enumeração que representa os possíveis intervalos usados no recálculo da planilha. |
RelativeDate | Uma enumeração que representa as opções de data relativa para calcular um valor a ser usado em BooleanCriteria baseado em data. |
RichTextValue | String de texto estilizado usada para representar texto de célula. |
RichTextValueBuilder | Um builder para valores de rich text. |
Selection | Acessar a seleção ativa atual na página ativa. |
Sheet | Acessar e modificar páginas de planilhas. |
SheetType | Os diferentes tipos de páginas que podem existir em uma planilha. |
Slicer | Representa um slicer, que é usado para filtrar intervalos, gráficos e tabelas dinâmicas de maneira não colaborativa. |
SortOrder | Uma enumeração que representa a ordem de classificação. |
SortSpec | A especificação da classificação. |
Spreadsheet | acessar e modificar arquivos do Planilhas Google; |
SpreadsheetApp | Acessar e criar arquivos do Planilhas Google. |
SpreadsheetTheme | Acessar e modificar temas existentes. |
TextDirection | Uma enumeração de direções de texto. |
TextFinder | Encontrar ou substituir texto em um intervalo, uma página ou uma planilha. |
TextRotation | Acesse as configurações de rotação de texto em uma célula. |
TextStyle | O estilo de texto renderizado em uma célula. |
TextStyleBuilder | Um builder para estilos de texto. |
TextToColumnsDelimiter | Uma enumeração dos tipos de delimitadores predefinidos que podem dividir uma coluna de texto em várias colunas. |
ThemeColor | Uma representação para uma cor de tema. |
ThemeColorType | Um tipo enumerado que descreve várias entradas de cor com suporte nos temas. |
ValueType | Uma enumeração de tipos de valor retornados por Range.getValue() e Range.getValues() da classe Range do serviço Planilha. |
WrapStrategy | Uma enumeração das estratégias usadas para processar o ajuste de texto da célula. |
AutoFillSeries
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
DEFAULT_SERIES | Enum | Padrão. |
ALTERNATE_SERIES | Enum | O preenchimento automático com essa configuração faz com que as células vazias do intervalo expandido sejam preenchidas com cópias dos valores existentes. |
Banding
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copyTo(range) | Banding | Copia essa faixa para outro intervalo. |
getFirstColumnColorObject() | Color | Retorna a primeira cor de coluna alternada na faixa ou null se nenhuma cor for definida. |
getFirstRowColorObject() | Color | Retorna a primeira cor de linha alternada ou null se nenhuma cor for definida. |
getFooterColumnColorObject() | Color | Retorna a cor da última coluna na faixa ou null se nenhuma cor for definida. |
getFooterRowColorObject() | Color | Retorna a cor da última linha na faixa ou null se nenhuma cor for definida. |
getHeaderColumnColorObject() | Color | Retorna a cor da primeira coluna na faixa ou null se nenhuma cor for definida. |
getHeaderRowColorObject() | Color | Retorna a cor da linha do cabeçalho ou null se nenhuma cor for definida. |
getRange() | Range | Retorna o intervalo dessa faixa. |
getSecondColumnColorObject() | Color | Retorna a segunda cor de coluna alternada na faixa etária ou null se nenhuma cor for definida. |
getSecondRowColorObject() | Color | Retorna a segunda cor alternada da linha ou null se nenhuma cor for definida. |
remove() | void | Remove essa faixa. |
setFirstColumnColor(color) | Banding | Define a cor da primeira coluna que é alternada. |
setFirstColumnColorObject(color) | Banding | Define a primeira cor de coluna alternada na faixa de cores. |
setFirstRowColor(color) | Banding | Define a cor da primeira linha que é alternada. |
setFirstRowColorObject(color) | Banding | Define a primeira cor de linha alternada na faixa. |
setFooterColumnColor(color) | Banding | Define a cor da última coluna. |
setFooterColumnColorObject(color) | Banding | Define a cor da última coluna na faixa. |
setFooterRowColor(color) | Banding | Define a cor da última linha. |
setFooterRowColorObject(color) | Banding | Define a cor da linha do rodapé na faixa. |
setHeaderColumnColor(color) | Banding | Define a cor da coluna do cabeçalho. |
setHeaderColumnColorObject(color) | Banding | Define a cor da coluna do cabeçalho. |
setHeaderRowColor(color) | Banding | Define a cor da linha do cabeçalho. |
setHeaderRowColorObject(color) | Banding | Define a cor da linha do cabeçalho. |
setRange(range) | Banding | Define o intervalo dessa faixa. |
setSecondColumnColor(color) | Banding | Define a cor da segunda coluna que é alternada. |
setSecondColumnColorObject(color) | Banding | Define a segunda cor de coluna alternada na faixa de cores. |
setSecondRowColor(color) | Banding | Define a cor da segunda linha que é alternada. |
setSecondRowColorObject(color) | Banding | Define a segunda cor alternada na faixa. |
BandingTheme
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
LIGHT_GREY | Enum | Tema de faixas cinza-claro. |
CYAN | Enum | Tema de faixas cianos. |
GREEN | Enum | Um tema de faixa verde. |
YELLOW | Enum | Tema de faixas amarelas. |
ORANGE | Enum | Tema de faixas laranja. |
BLUE | Enum | Tema de faixa azul. |
TEAL | Enum | Tema de banda azul-petróleo. |
GREY | Enum | Tema de faixas cinza. |
BROWN | Enum | Tema de faixas marrons. |
LIGHT_GREEN | Enum | Tema de faixa verde-claro. |
INDIGO | Enum | Tema de bandas anil. |
PINK | Enum | Um tema de faixas rosa. |
BigQueryDataSourceSpec
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | DataSourceSpecBuilder | Cria um DataSourceSpecBuilder com base nas configurações dessa fonte de dados. |
getDatasetId() | String | Recebe o ID do conjunto de dados do BigQuery. |
getParameters() | DataSourceParameter[] | Recebe os parâmetros da fonte de dados. |
getProjectId() | String | Recebe o ID do projeto de faturamento. |
getRawQuery() | String | Recebe a string de consulta bruta. |
getTableId() | String | Recebe o ID da tabela do BigQuery. |
getTableProjectId() | String | Recebe o ID do projeto do BigQuery para a tabela. |
getType() | DataSourceType | Extrai o tipo da fonte de dados. |
BigQueryDataSourceSpecBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
build() | DataSourceSpec | Cria uma especificação de fonte de dados com base nas configurações deste builder. |
copy() | DataSourceSpecBuilder | Cria um DataSourceSpecBuilder com base nas configurações dessa fonte de dados. |
getDatasetId() | String | Recebe o ID do conjunto de dados do BigQuery. |
getParameters() | DataSourceParameter[] | Recebe os parâmetros da fonte de dados. |
getProjectId() | String | Recebe o ID do projeto de faturamento. |
getRawQuery() | String | Recebe a string de consulta bruta. |
getTableId() | String | Recebe o ID da tabela do BigQuery. |
getTableProjectId() | String | Recebe o ID do projeto do BigQuery para a tabela. |
getType() | DataSourceType | Extrai o tipo da fonte de dados. |
removeAllParameters() | BigQueryDataSourceSpecBuilder | Remove todos os parâmetros. |
removeParameter(parameterName) | BigQueryDataSourceSpecBuilder | Remove o parâmetro especificado. |
setDatasetId(datasetId) | BigQueryDataSourceSpecBuilder | Define o ID do conjunto de dados do BigQuery. |
setParameterFromCell(parameterName, sourceCell) | BigQueryDataSourceSpecBuilder | Adiciona um parâmetro ou, se o parâmetro com o nome existir, atualiza a célula de origem. |
setProjectId(projectId) | BigQueryDataSourceSpecBuilder | Define o ID do projeto de faturamento do BigQuery. |
setRawQuery(rawQuery) | BigQueryDataSourceSpecBuilder | Define a string de consulta bruta. |
setTableId(tableId) | BigQueryDataSourceSpecBuilder | Define o ID da tabela do BigQuery. |
setTableProjectId(projectId) | BigQueryDataSourceSpecBuilder | Define o ID do projeto do BigQuery para a tabela. |
BooleanCondition
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getBackgroundObject() | Color | Recebe a cor de fundo dessa condição booleana. |
getBold() | Boolean | Retornará true se essa condição booleana aplicar negrito ao texto e retornará false se essa
condição booleana remover o negrito do texto. |
getCriteriaType() | BooleanCriteria | Recebe o tipo de critério da regra, conforme definido na enumeração BooleanCriteria . |
getCriteriaValues() | Object[] | Recebe uma matriz de argumentos para os critérios da regra. |
getFontColorObject() | Color | Recebe a cor da fonte para esta condição booleana. |
getItalic() | Boolean | Retornará true se essa condição booleana aplicar itálico ao texto e retornará false se
essa condição booleana remover itálico do texto. |
getStrikethrough() | Boolean | Retornará true se essa condição booleana ocorrer ao longo do texto e retornará false se ela remover o tachado do texto. |
getUnderline() | Boolean | Retornará true se essa condição booleana sublinhar o texto e retornará false se
essa condição booleana remover o sublinhado do texto. |
BooleanCriteria
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
CELL_EMPTY | Enum | O critério é atendido quando uma célula está vazia. |
CELL_NOT_EMPTY | Enum | O critério é atendido quando uma célula não está vazia. |
DATE_AFTER | Enum | Os critérios são atendidos quando uma data é posterior ao valor fornecido. |
DATE_BEFORE | Enum | Os critérios são atendidos quando a data é anterior ao valor fornecido. |
DATE_EQUAL_TO | Enum | Os critérios são atendidos quando uma data é igual ao valor fornecido. |
DATE_NOT_EQUAL_TO | Enum | Os critérios são atendidos quando uma data não é igual ao valor fornecido. |
DATE_AFTER_RELATIVE | Enum | O critério é atendido quando uma data é posterior ao valor da data relativa. |
DATE_BEFORE_RELATIVE | Enum | O critério é atendido quando a data é anterior ao valor da data relativa. |
DATE_EQUAL_TO_RELATIVE | Enum | Os critérios são atendidos quando uma data é igual ao valor da data relativa. |
NUMBER_BETWEEN | Enum | Os critérios são atendidos quando um número está entre os valores fornecidos. |
NUMBER_EQUAL_TO | Enum | O critério é atendido quando um número é igual ao valor fornecido. |
NUMBER_GREATER_THAN | Enum | O critério é atendido quando um número é maior do que o valor fornecido. |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | O critério é atendido quando um número é maior ou igual ao valor fornecido. |
NUMBER_LESS_THAN | Enum | O critério é atendido quando um número é menor que o valor fornecido. |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | O critério é atendido quando um número é menor ou igual ao valor fornecido. |
NUMBER_NOT_BETWEEN | Enum | Os critérios são atendidos quando um número não está entre os valores fornecidos. |
NUMBER_NOT_EQUAL_TO | Enum | O critério é atendido quando um número não é igual ao valor fornecido. |
TEXT_CONTAINS | Enum | Os critérios são atendidos quando a entrada contém o valor determinado. |
TEXT_DOES_NOT_CONTAIN | Enum | Os critérios são atendidos quando a entrada não contém o valor fornecido. |
TEXT_EQUAL_TO | Enum | Os critérios são atendidos quando a entrada é igual ao valor informado. |
TEXT_NOT_EQUAL_TO | Enum | Os critérios são atendidos quando a entrada não é igual ao valor informado. |
TEXT_STARTS_WITH | Enum | Os critérios são atendidos quando a entrada começa com o valor fornecido. |
TEXT_ENDS_WITH | Enum | Os critérios são atendidos quando a entrada termina com o valor fornecido. |
CUSTOM_FORMULA | Enum | Os critérios são atendidos quando a entrada faz com que a fórmula seja avaliada como true . |
BorderStyle
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
DOTTED | Enum | Bordas de linha pontilhada. |
DASHED | Enum | Bordas de linha tracejada. |
SOLID | Enum | Bordas de linha sólida fina. |
SOLID_MEDIUM | Enum | Bordas de linha sólida média. |
SOLID_THICK | Enum | Bordas de linha sólida grossa. |
DOUBLE | Enum | Duas bordas de linha sólida. |
CellImage
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
valueType | ValueType | Um campo definido como ValueType.IMAGE , representando o tipo de valor da imagem. |
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getAltTextDescription() | String | Retorna a descrição do texto alternativo para esta imagem. |
getAltTextTitle() | String | Retorna o título do texto alternativo para esta imagem. |
getContentUrl() | String | Retorna um URL hospedado pelo Google para a imagem. |
getUrl() | String | Recebe o URL de origem da imagem. Retorna null se o URL não estiver disponível. |
toBuilder() | CellImageBuilder | Cria 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
Propriedade | Tipo | Descrição |
---|---|---|
valueType | ValueType | Um campo definido como ValueType.IMAGE , representando o tipo de valor da imagem. |
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
build() | CellImage | Cria o tipo de valor de imagem necessário para adicionar uma imagem a uma célula. |
getAltTextDescription() | String | Retorna a descrição do texto alternativo para esta imagem. |
getAltTextTitle() | String | Retorna o título do texto alternativo para esta imagem. |
getContentUrl() | String | Retorna um URL hospedado pelo Google para a imagem. |
getUrl() | String | Recebe o URL de origem da imagem. Retorna null se o URL não estiver disponível. |
setAltTextDescription(description) | CellImage | Define a descrição do texto alternativo para a imagem. |
setAltTextTitle(title) | CellImage | Define o título do texto alternativo para a imagem. |
setSourceUrl(url) | CellImageBuilder | Define o URL de origem da imagem. |
toBuilder() | CellImageBuilder | Cria 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étodo | Tipo de retorno | Breve descrição |
---|---|---|
asRgbColor() | RgbColor | Converte essa cor em um RgbColor . |
asThemeColor() | ThemeColor | Converte essa cor em um ThemeColor . |
getColorType() | ColorType | Define o tipo dessa cor. |
ColorBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
asRgbColor() | RgbColor | Converte essa cor em um RgbColor . |
asThemeColor() | ThemeColor | Converte essa cor em um ThemeColor . |
build() | Color | Cria um objeto de cor das configurações fornecidas para o builder. |
getColorType() | ColorType | Define o tipo dessa cor. |
setRgbColor(cssString) | ColorBuilder | Define como cor RGB. |
setThemeColor(themeColorType) | ColorBuilder | Define como cor do tema. |
ConditionalFormatRule
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | ConditionalFormatRuleBuilder | Retorna uma predefinição do criador de regras com as configurações dessa regra. |
getBooleanCondition() | BooleanCondition | Recupera as informações BooleanCondition da regra se ela usa
critérios de condição booleana. |
getGradientCondition() | GradientCondition | Recupera as informações GradientCondition da regra se ela
usar critérios de condição de gradiente. |
getRanges() | Range[] | Recupera os intervalos aos quais esta regra de formatação condicional é aplicada. |
ConditionalFormatRuleBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
build() | ConditionalFormatRule | Cria uma regra de formatação condicional das configurações aplicadas ao builder. |
copy() | ConditionalFormatRuleBuilder | Retorna uma predefinição do criador de regras com as configurações dessa regra. |
getBooleanCondition() | BooleanCondition | Recupera as informações BooleanCondition da regra se ela usa
critérios de condição booleana. |
getGradientCondition() | GradientCondition | Recupera as informações GradientCondition da regra se ela
usar critérios de condição de gradiente. |
getRanges() | Range[] | Recupera os intervalos aos quais esta regra de formatação condicional é aplicada. |
setBackground(color) | ConditionalFormatRuleBuilder | Define a cor do plano de fundo para o formato da regra de formatação condicional. |
setBackgroundObject(color) | ConditionalFormatRuleBuilder | Define a cor do plano de fundo para o formato da regra de formatação condicional. |
setBold(bold) | ConditionalFormatRuleBuilder | Define o negrito para o formato da regra de formatação condicional. |
setFontColor(color) | ConditionalFormatRuleBuilder | Define a cor da fonte para o formato da regra de formatação condicional. |
setFontColorObject(color) | ConditionalFormatRuleBuilder | Define a cor da fonte para o formato da regra de formatação condicional. |
setGradientMaxpoint(color) | ConditionalFormatRuleBuilder | Limpa o valor máximo de ponto máximo do gradiente da regra de formatação condicional e, em vez disso, usa o valor máximo nos intervalos da regra. |
setGradientMaxpointObject(color) | ConditionalFormatRuleBuilder | Limpa o valor máximo de ponto máximo do gradiente da regra de formatação condicional e, em vez disso, usa o valor máximo nos intervalos da regra. |
setGradientMaxpointObjectWithValue(color, type, value) | ConditionalFormatRuleBuilder | Define os campos maxpoint do gradiente da regra de formatação condicional. |
setGradientMaxpointWithValue(color, type, value) | ConditionalFormatRuleBuilder | Define os campos maxpoint do gradiente da regra de formatação condicional. |
setGradientMidpointObjectWithValue(color, type, value) | ConditionalFormatRuleBuilder | Define os campos médios do gradiente da regra de formatação condicional. |
setGradientMidpointWithValue(color, type, value) | ConditionalFormatRuleBuilder | Define os campos de ponto médio do gradiente da regra de formatação condicional. |
setGradientMinpoint(color) | ConditionalFormatRuleBuilder | Limpa o valor mínimo do ponto mínimo do gradiente da regra de formatação condicional e, em vez disso, usa o valor mínimo nos intervalos da regra. |
setGradientMinpointObject(color) | ConditionalFormatRuleBuilder | Limpa o valor mínimo do ponto mínimo do gradiente da regra de formatação condicional e, em vez disso, usa o valor mínimo nos intervalos da regra. |
setGradientMinpointObjectWithValue(color, type, value) | ConditionalFormatRuleBuilder | Define os campos de pontos mínimos de gradiente da regra de formatação condicional. |
setGradientMinpointWithValue(color, type, value) | ConditionalFormatRuleBuilder | Define os campos de pontos mínimos de gradiente da regra de formatação condicional. |
setItalic(italic) | ConditionalFormatRuleBuilder | Define o itálico do texto para o formato da regra de formatação condicional. |
setRanges(ranges) | ConditionalFormatRuleBuilder | Define um ou mais intervalos aos quais esta regra de formato condicional é aplicada. |
setStrikethrough(strikethrough) | ConditionalFormatRuleBuilder | Define o tachado para o formato da regra de formatação condicional. |
setUnderline(underline) | ConditionalFormatRuleBuilder | Define o sublinhado do texto para o formato da regra de formatação condicional. |
whenCellEmpty() | ConditionalFormatRuleBuilder | Define a regra de formatação condicional a ser acionada quando a célula estiver vazia. |
whenCellNotEmpty() | ConditionalFormatRuleBuilder | Define a regra de formatação condicional a ser acionada quando a célula não estiver vazia. |
whenDateAfter(date) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional a ser acionada quando uma data for posterior ao valor informado. |
whenDateAfter(date) | ConditionalFormatRuleBuilder | Define a regra de formato condicional a ser acionada quando uma data for posterior à data relativa especificada. |
whenDateBefore(date) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional a ser acionada quando a data for anterior à data especificada. |
whenDateBefore(date) | ConditionalFormatRuleBuilder | Define a regra de formato condicional a ser acionada quando uma data for anterior à data relativa especificada. |
whenDateEqualTo(date) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional a ser acionada quando uma data for igual à data especificada. |
whenDateEqualTo(date) | ConditionalFormatRuleBuilder | Define a regra de formato condicional a ser acionada quando uma data for igual à data relativa especificada. |
whenFormulaSatisfied(formula) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional a ser acionada quando a fórmula especificada for avaliada como true . |
whenNumberBetween(start, end) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional a ser acionada quando um número estiver entre dois valores especificados. |
whenNumberEqualTo(number) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional que será acionada quando um número for igual ao valor informado. |
whenNumberGreaterThan(number) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional a ser acionada quando um número for maior que o valor fornecido. |
whenNumberGreaterThanOrEqualTo(number) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional a ser acionada quando um número for maior ou igual ao valor fornecido. |
whenNumberLessThan(number) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional a ser acionada quando um número menor que o valor fornecido. |
whenNumberLessThanOrEqualTo(number) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional a ser acionada quando um número menor ou igual ao valor fornecido. |
whenNumberNotBetween(start, end) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional a ser acionada quando um número não estiver entre dois valores especificados e não estiver entre dois valores. |
whenNumberNotEqualTo(number) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional que será acionada quando um número não for igual ao valor informado. |
whenTextContains(text) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional a ser acionada quando a entrada contiver o valor especificado. |
whenTextDoesNotContain(text) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional a ser acionada quando a entrada não contiver o valor fornecido. |
whenTextEndsWith(text) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional a ser acionada quando a entrada terminar com o valor fornecido. |
whenTextEqualTo(text) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional que será acionada quando a entrada for igual ao valor informado. |
whenTextStartsWith(text) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional a ser acionada quando a entrada começar com o valor especificado. |
withCriteria(criteria, args) | ConditionalFormatRuleBuilder | Define a regra de formatação condicional para os critérios definidos por valores BooleanCriteria , normalmente retirados de criteria e arguments de uma regra existente. |
ContainerInfo
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getAnchorColumn() | Integer | O lado esquerdo do gráfico está ancorado nessa coluna. |
getAnchorRow() | Integer | A parte de cima do gráfico está ancorada nessa linha. |
getOffsetX() | Integer | O canto superior esquerdo do gráfico está deslocado da coluna âncora em muitos pixels. |
getOffsetY() | Integer | O canto superior esquerdo do gráfico está deslocado da linha da âncora por muitos pixels. |
CopyPasteType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
PASTE_NORMAL | Enum | Colar valores, fórmulas, formatos e mesclas. |
PASTE_NO_BORDERS | Enum | Colar valores, fórmulas, formatos e mesclas, mas sem bordas. |
PASTE_FORMAT | Enum | Cole apenas a formatação. |
PASTE_FORMULA | Enum | Cole apenas as fórmulas. |
PASTE_DATA_VALIDATION | Enum | Cole apenas a validação de dados. |
PASTE_VALUES | Enum | Cole os valores APENAS, sem formatos, fórmulas ou mesclas. |
PASTE_CONDITIONAL_FORMATTING | Enum | Cole apenas as regras de cor. |
PASTE_COLUMN_WIDTHS | Enum | Cole apenas as larguras da coluna. |
DataExecutionErrorCode
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
DATA_EXECUTION_ERROR_CODE_UNSUPPORTED | Enum | Um código de erro de execução de dados que não é compatível com o Apps Script. |
NONE | Enum | A execução dos dados não tem erros. |
TIME_OUT | Enum | A execução dos dados expirou. |
TOO_MANY_ROWS | Enum | A execução dos dados retorna mais linhas do que o limite. |
TOO_MANY_COLUMNS | Enum | A execução dos dados retorna mais colunas do que o limite. |
TOO_MANY_CELLS | Enum | A execução dos dados retorna mais células do que o limite. |
ENGINE | Enum | Erro no mecanismo de execução de dados. |
PARAMETER_INVALID | Enum | Parâmetro de execução de dados inválido. |
UNSUPPORTED_DATA_TYPE | Enum | A execução dos dados retorna um tipo de dados incompatível. |
DUPLICATE_COLUMN_NAMES | Enum | A execução dos dados retorna nomes de coluna duplicados. |
INTERRUPTED | Enum | A execução dos dados é interrompida. |
OTHER | Enum | Outros erros. |
TOO_MANY_CHARS_PER_CELL | Enum | A execução dos dados retorna valores que excedem o máximo de caracteres permitido em uma única célula. |
DATA_NOT_FOUND | Enum | O banco de dados referenciado pela fonte de dados não foi encontrado. |
PERMISSION_DENIED | Enum | O usuário não tem acesso ao banco de dados referenciado pela fonte de dados. |
DataExecutionState
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
DATA_EXECUTION_STATE_UNSUPPORTED | Enum | O estado de execução de dados não é compatível com o Apps Script. |
RUNNING | Enum | A execução dos dados foi iniciada e está em execução. |
SUCCESS | Enum | A execução dos dados foi concluída e bem-sucedida. |
ERROR | Enum | A execução dos dados foi concluída e contém erros. |
NOT_STARTED | Enum | A execução dos dados não foi iniciada. |
DataExecutionStatus
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getErrorCode() | DataExecutionErrorCode | Recebe o código de erro da execução de dados. |
getErrorMessage() | String | Recebe a mensagem de erro da execução de dados. |
getExecutionState() | DataExecutionState | Recebe o estado da execução de dados. |
getLastExecutionTime() | Date | Extrai a hora em que a última execução de dados foi concluída, independentemente do estado de execução. |
getLastRefreshedTime() | Date | Extrai a hora em que os dados foram atualizados pela última vez. |
isTruncated() | Boolean | Retorna true se os dados da última execução bem-sucedida forem truncados. Caso contrário, retorna false . |
DataSource
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
createCalculatedColumn(name, formula) | DataSourceColumn | Cria uma coluna calculada. |
createDataSourcePivotTableOnNewSheet() | DataSourcePivotTable | Cria uma tabela dinâmica de fonte de dados com base nessa fonte de dados na primeira célula de uma nova página. |
createDataSourceTableOnNewSheet() | DataSourceTable | Cria uma tabela de fonte de dados com base nessa fonte de dados na primeira célula de uma nova planilha. |
getCalculatedColumnByName(columnName) | DataSourceColumn | Retorna a coluna calculada na fonte de dados que corresponde ao nome da coluna. |
getCalculatedColumns() | DataSourceColumn[] | Retorna todas as colunas calculadas na fonte de dados. |
getColumns() | DataSourceColumn[] | Retorna todas as colunas na fonte de dados. |
getDataSourceSheets() | DataSourceSheet[] | Retorna as páginas da fonte de dados associadas a essa fonte. |
getSpec() | DataSourceSpec | Recebe a especificação da fonte de dados. |
refreshAllLinkedDataSourceObjects() | void | Atualiza todos os objetos da fonte de dados vinculados a ela. |
updateSpec(spec) | DataSource | Atualiza a especificação da fonte de dados e atualiza os objetos vinculados a essa fonte com a nova especificação. |
updateSpec(spec, refreshAllLinkedObjects) | DataSource | Atualiza a especificação da fonte de dados e o data
source sheets vinculado com a nova especificação. |
waitForAllDataExecutionsCompletion(timeoutInSeconds) | void | Aguarda até que todas as execuções atuais dos objetos da fonte de dados vinculados sejam concluídas, expirando após o número de segundos fornecido. |
DataSourceChart
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
forceRefreshData() | DataSourceChart | Atualiza os dados desse objeto, independentemente do estado atual. |
getDataSource() | DataSource | Recebe a fonte de dados à qual o objeto está vinculado. |
getStatus() | DataExecutionStatus | Recebe o status de execução de dados do objeto. |
refreshData() | DataSourceChart | Atualiza os dados do objeto. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Aguarda até que a execução atual seja concluída, expirando após o número de segundos fornecido. |
DataSourceColumn
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getDataSource() | DataSource | Recebe a fonte de dados associada à coluna da fonte de dados. |
getFormula() | String | Recebe a fórmula da coluna da fonte de dados. |
getName() | String | Recebe o nome da coluna da fonte de dados. |
hasArrayDependency() | Boolean | Retorna se a coluna tem uma dependência de matriz. |
isCalculatedColumn() | Boolean | Retorna indicando se a coluna é calculada. |
remove() | void | Remove a coluna da fonte de dados. |
setFormula(formula) | DataSourceColumn | Define a fórmula para a coluna de fonte de dados. |
setName(name) | DataSourceColumn | Define o nome da coluna da fonte de dados. |
DataSourceFormula
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
forceRefreshData() | DataSourceFormula | Atualiza os dados desse objeto, independentemente do estado atual. |
getAnchorCell() | Range | Retorna o Range que representa a célula em que essa fórmula de fonte de dados está ancorada. |
getDataSource() | DataSource | Recebe a fonte de dados à qual o objeto está vinculado. |
getDisplayValue() | String | Retorna o valor de exibição da fórmula da fonte de dados. |
getFormula() | String | Retorna a fórmula dessa fórmula de fonte de dados. |
getStatus() | DataExecutionStatus | Recebe o status de execução de dados do objeto. |
refreshData() | DataSourceFormula | Atualiza os dados do objeto. |
setFormula(formula) | DataSourceFormula | Atualiza a fórmula. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Aguarda até que a execução atual seja concluída, expirando após o número de segundos fornecido. |
DataSourceParameter
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getName() | String | Recebe o nome do parâmetro. |
getSourceCell() | String | Recebe 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() | DataSourceParameterType | Recebe o tipo de parâmetro. |
DataSourceParameterType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTED | Enum | Um tipo de parâmetro da fonte de dados que não é compatível com o Apps Script. |
CELL | Enum | O parâmetro da fonte de dados é avaliado com base em uma célula. |
DataSourcePivotTable
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addColumnGroup(columnName) | PivotGroup | Adiciona um novo grupo de colunas dinâmicas com base na coluna de fonte de dados especificada. |
addFilter(columnName, filterCriteria) | PivotFilter | Adiciona um novo filtro com base na coluna de fonte de dados especificada com os critérios de filtro especificados. |
addPivotValue(columnName, summarizeFunction) | PivotValue | Adiciona um novo valor dinâmico com base na coluna de fonte de dados especificada com a função summarize especificada. |
addRowGroup(columnName) | PivotGroup | Adiciona um novo grupo de linhas dinâmicas com base na coluna de fonte de dados especificada. |
asPivotTable() | PivotTable | Retorna a tabela dinâmica de fonte de dados como um objeto de tabela dinâmica normal. |
forceRefreshData() | DataSourcePivotTable | Atualiza os dados desse objeto, independentemente do estado atual. |
getDataSource() | DataSource | Recebe a fonte de dados à qual o objeto está vinculado. |
getStatus() | DataExecutionStatus | Recebe o status de execução de dados do objeto. |
refreshData() | DataSourcePivotTable | Atualiza os dados do objeto. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Aguarda até que a execução atual seja concluída, expirando após o número de segundos fornecido. |
DataSourceRefreshSchedule
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getFrequency() | DataSourceRefreshScheduleFrequency | Recebe a frequência da programação de atualização, que especifica com que frequência e quando isso será feito. |
getScope() | DataSourceRefreshScope | Recebe o escopo dessa programação de atualização. |
getTimeIntervalOfNextRun() | TimeInterval | Recebe a janela de tempo da próxima execução dessa programação de atualização. |
isEnabled() | Boolean | Determina se essa programação de atualização está ativada. |
DataSourceRefreshScheduleFrequency
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getDaysOfTheMonth() | Integer[] | Recebe os dias do mês como números (1 a 28) para atualizar a fonte de dados. |
getDaysOfTheWeek() | Weekday[] | Extrai os dias da semana em que a fonte de dados é atualizada. |
getFrequencyType() | FrequencyType | Recebe o tipo de frequência. |
getStartHour() | Integer | Recebe 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
Propriedade | Tipo | Descrição |
---|---|---|
DATA_SOURCE_REFRESH_SCOPE_UNSUPPORTED | Enum | O escopo de atualização da fonte de dados não é compatível. |
ALL_DATA_SOURCES | Enum | A atualização se aplica a todas as fontes de dados na planilha. |
DataSourceSheet
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addFilter(columnName, filterCriteria) | DataSourceSheet | Adiciona um filtro aplicado à página da fonte de dados. |
asSheet() | Sheet | Retorna a planilha de fonte de dados como um objeto de planilha normal. |
autoResizeColumn(columnName) | DataSourceSheet | Redimensiona automaticamente a largura da coluna especificada. |
autoResizeColumns(columnNames) | DataSourceSheet | Redimensiona automaticamente a largura das colunas especificadas. |
forceRefreshData() | DataSourceSheet | Atualiza os dados desse objeto, independentemente do estado atual. |
getColumnWidth(columnName) | Integer | Retorna a largura da coluna especificada. |
getDataSource() | DataSource | Recebe a fonte de dados à qual o objeto está vinculado. |
getFilters() | DataSourceSheetFilter[] | Retorna todos os filtros aplicados à página da fonte de dados. |
getSheetValues(columnName) | Object[] | Retorna todos os valores da planilha da fonte de dados referente ao nome da coluna fornecido. |
getSheetValues(columnName, startRow, numRows) | Object[] | Retorna todos os valores da página de fonte de dados referentes ao nome da coluna fornecido a partir da linha inicial fornecida (base-1) até a numRows fornecida. |
getSortSpecs() | SortSpec[] | Recebe todas as especificações de classificação na planilha da fonte de dados. |
getStatus() | DataExecutionStatus | Recebe o status de execução de dados do objeto. |
refreshData() | DataSourceSheet | Atualiza os dados do objeto. |
removeFilters(columnName) | DataSourceSheet | Remove todos os filtros aplicados à coluna da página da fonte de dados. |
removeSortSpec(columnName) | DataSourceSheet | Remove a especificação de classificação de uma coluna na planilha da fonte de dados. |
setColumnWidth(columnName, width) | DataSourceSheet | Define a largura da coluna especificada. |
setColumnWidths(columnNames, width) | DataSourceSheet | Define a largura das colunas especificadas. |
setSortSpec(columnName, ascending) | DataSourceSheet | Define a especificação de classificação em uma coluna na planilha da fonte de dados. |
setSortSpec(columnName, sortOrder) | DataSourceSheet | Define a especificação de classificação em uma coluna na planilha da fonte de dados. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Aguarda até que a execução atual seja concluída, expirando após o número de segundos fornecido. |
DataSourceSheetFilter
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getDataSourceColumn() | DataSourceColumn | Retorna a coluna de fonte de dados à qual esse filtro se aplica. |
getDataSourceSheet() | DataSourceSheet | Retorna o DataSourceSheet ao qual esse filtro pertence. |
getFilterCriteria() | FilterCriteria | Retorna os critérios para este filtro. |
remove() | void | Remove esse filtro do objeto da fonte de dados. |
setFilterCriteria(filterCriteria) | DataSourceSheetFilter | Define os critérios para este filtro. |
DataSourceSpec
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
asBigQuery() | BigQueryDataSourceSpec | Recebe a especificação da fonte de dados do BigQuery. |
copy() | DataSourceSpecBuilder | Cria um DataSourceSpecBuilder com base nas configurações dessa fonte de dados. |
getParameters() | DataSourceParameter[] | Recebe os parâmetros da fonte de dados. |
getType() | DataSourceType | Extrai o tipo da fonte de dados. |
DataSourceSpecBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
asBigQuery() | BigQueryDataSourceSpecBuilder | Recebe o builder da fonte de dados do BigQuery. |
build() | DataSourceSpec | Cria uma especificação de fonte de dados com base nas configurações deste builder. |
copy() | DataSourceSpecBuilder | Cria um DataSourceSpecBuilder com base nas configurações dessa fonte de dados. |
getParameters() | DataSourceParameter[] | Recebe os parâmetros da fonte de dados. |
getType() | DataSourceType | Extrai o tipo da fonte de dados. |
removeAllParameters() | DataSourceSpecBuilder | Remove todos os parâmetros. |
removeParameter(parameterName) | DataSourceSpecBuilder | Remove o parâmetro especificado. |
setParameterFromCell(parameterName, sourceCell) | DataSourceSpecBuilder | Adiciona um parâmetro ou, se o parâmetro com o nome existir, atualiza a célula de origem. |
DataSourceTable
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addColumns(columnNames) | DataSourceTable | Adiciona colunas à tabela da fonte de dados. |
addFilter(columnName, filterCriteria) | DataSourceTable | Adiciona um filtro aplicado à tabela de fonte de dados. |
addSortSpec(columnName, ascending) | DataSourceTable | Adiciona uma especificação de classificação a uma coluna na tabela de fonte de dados. |
addSortSpec(columnName, sortOrder) | DataSourceTable | Adiciona uma especificação de classificação a uma coluna na tabela de fonte de dados. |
forceRefreshData() | DataSourceTable | Atualiza os dados desse objeto, independentemente do estado atual. |
getColumns() | DataSourceTableColumn[] | Extrai todas as colunas da fonte de dados adicionadas à tabela da fonte de dados. |
getDataSource() | DataSource | Recebe a fonte de dados à qual o objeto está vinculado. |
getFilters() | DataSourceTableFilter[] | Retorna todos os filtros aplicados à tabela de fonte de dados. |
getRange() | Range | Recebe o Range que esta tabela de fonte de dados abrange. |
getRowLimit() | Integer | Retorna o limite de linhas da tabela de fonte de dados. |
getSortSpecs() | SortSpec[] | Recebe todas as especificações de classificação na tabela de fonte de dados. |
getStatus() | DataExecutionStatus | Recebe o status de execução de dados do objeto. |
isSyncingAllColumns() | Boolean | Retorna se a tabela de fonte de dados está sincronizando todas as colunas na fonte de dados associada. |
refreshData() | DataSourceTable | Atualiza os dados do objeto. |
removeAllColumns() | DataSourceTable | Remove todas as colunas da tabela da fonte de dados. |
removeAllSortSpecs() | DataSourceTable | Remove todas as especificações de classificação na tabela de fonte de dados. |
setRowLimit(rowLimit) | DataSourceTable | Atualiza o limite de linhas da tabela de fonte de dados. |
syncAllColumns() | DataSourceTable | Sincronize todas as colunas atuais e futuras na fonte de dados associada com a tabela de fonte de dados. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Aguarda até que a execução atual seja concluída, expirando após o número de segundos fornecido. |
DataSourceTableColumn
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getDataSourceColumn() | DataSourceColumn | Recebe a coluna de origem de dados. |
remove() | void | Remove a coluna do DataSourceTable . |
DataSourceTableFilter
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getDataSourceColumn() | DataSourceColumn | Retorna a coluna de fonte de dados à qual esse filtro se aplica. |
getDataSourceTable() | DataSourceTable | Retorna o DataSourceTable ao qual esse filtro pertence. |
getFilterCriteria() | FilterCriteria | Retorna os critérios para este filtro. |
remove() | void | Remove esse filtro do objeto da fonte de dados. |
setFilterCriteria(filterCriteria) | DataSourceTableFilter | Define os critérios para este filtro. |
DataSourceType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
DATA_SOURCE_TYPE_UNSUPPORTED | Enum | Um tipo de fonte de dados que não é compatível com o Apps Script. |
BIGQUERY | Enum | Uma fonte de dados do BigQuery. |
DataValidation
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | DataValidationBuilder | Cria um builder para uma regra de validação de dados com base nas configurações dessa regra. |
getAllowInvalid() | Boolean | Retorna true se a regra mostrar um aviso quando a entrada falha na validação de dados ou false se ela rejeita totalmente a entrada. |
getCriteriaType() | DataValidationCriteria | Recebe o tipo de critério da regra, conforme definido na enumeração DataValidationCriteria . |
getCriteriaValues() | Object[] | Recebe uma matriz de argumentos para os critérios da regra. |
getHelpText() | String | Recebe o texto de ajuda da regra ou null se nenhum texto de ajuda foi definido. |
DataValidationBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
build() | DataValidation | Cria uma regra de validação de dados com base nas configurações aplicadas ao builder. |
copy() | DataValidationBuilder | Cria um builder para uma regra de validação de dados com base nas configurações dessa regra. |
getAllowInvalid() | Boolean | Retorna true se a regra mostrar um aviso quando a entrada falha na validação de dados ou false se ela rejeita totalmente a entrada. |
getCriteriaType() | DataValidationCriteria | Recebe o tipo de critério da regra, conforme definido na enumeração DataValidationCriteria . |
getCriteriaValues() | Object[] | Recebe uma matriz de argumentos para os critérios da regra. |
getHelpText() | String | Recebe o texto de ajuda da regra ou null se nenhum texto de ajuda foi definido. |
requireCheckbox() | DataValidationBuilder | Define 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) | DataValidationBuilder | Define a regra de validação de dados para exigir que a entrada seja o valor especificado ou em branco. |
requireCheckbox(checkedValue, uncheckedValue) | DataValidationBuilder | Define a regra de validação de dados para exigir que a entrada seja um dos valores especificados. |
requireDate() | DataValidationBuilder | Define a regra de validação de dados para exigir uma data. |
requireDateAfter(date) | DataValidationBuilder | Define a regra de validação de dados para exigir uma data posterior ao valor especificado. |
requireDateBefore(date) | DataValidationBuilder | Define a regra de validação de dados para exigir uma data antes do valor determinado. |
requireDateBetween(start, end) | DataValidationBuilder | Define a regra de validação de dados para exigir uma data que esteja entre as duas datas especificadas. |
requireDateEqualTo(date) | DataValidationBuilder | Define a regra de validação de dados para exigir uma data igual ao valor informado. |
requireDateNotBetween(start, end) | DataValidationBuilder | Define a regra de validação de dados para exigir uma data que não fique entre duas datas especificadas e não seja nenhuma das duas. |
requireDateOnOrAfter(date) | DataValidationBuilder | Define a regra de validação de dados para exigir uma data igual ou posterior ao valor fornecido. |
requireDateOnOrBefore(date) | DataValidationBuilder | Define a regra de validação de dados para exigir uma data igual ou anterior ao valor fornecido. |
requireFormulaSatisfied(formula) | DataValidationBuilder | Define a regra de validação de dados para exigir que a fórmula seja avaliada como true . |
requireNumberBetween(start, end) | DataValidationBuilder | Define 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) | DataValidationBuilder | Define a regra de validação de dados para exigir um número igual ao valor fornecido. |
requireNumberGreaterThan(number) | DataValidationBuilder | Define a regra de validação de dados para exigir um número maior do que o valor fornecido. |
requireNumberGreaterThanOrEqualTo(number) | DataValidationBuilder | Define a regra de validação de dados para exigir um número maior ou igual ao valor fornecido. |
requireNumberLessThan(number) | DataValidationBuilder | Define a regra de validação de dados para exigir um número menor do que o valor fornecido. |
requireNumberLessThanOrEqualTo(number) | DataValidationBuilder | Define a regra de validação de dados para exigir um número menor ou igual ao valor fornecido. |
requireNumberNotBetween(start, end) | DataValidationBuilder | Define a regra de validação de dados para exigir um número que não fique entre dois números especificados e não seja de nenhum dos dois. |
requireNumberNotEqualTo(number) | DataValidationBuilder | Define a regra de validação de dados para exigir um número diferente do valor fornecido. |
requireTextContains(text) | DataValidationBuilder | Define a regra de validação de dados para exigir que a entrada contenha o valor determinado. |
requireTextDoesNotContain(text) | DataValidationBuilder | Define a regra de validação de dados para exigir que a entrada não contenha o valor fornecido. |
requireTextEqualTo(text) | DataValidationBuilder | Define a regra de validação de dados para exigir que a entrada seja igual ao valor fornecido. |
requireTextIsEmail() | DataValidationBuilder | Define a regra de validação de dados para exigir que a entrada esteja na forma de um endereço de e-mail. |
requireTextIsUrl() | DataValidationBuilder | Define a regra de validação de dados para exigir que a entrada esteja na forma de um URL. |
requireValueInList(values) | DataValidationBuilder | Define a regra de validação de dados para exigir que a entrada seja igual a um dos valores fornecidos. |
requireValueInList(values, showDropdown) | DataValidationBuilder | Define 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) | DataValidationBuilder | Define a regra de validação de dados para exigir que a entrada seja igual a um valor no intervalo determinado. |
requireValueInRange(range, showDropdown) | DataValidationBuilder | Define a regra de validação de dados para exigir que a entrada seja igual a um valor no intervalo especificado, com uma opção para ocultar o menu suspenso. |
setAllowInvalid(allowInvalidData) | DataValidationBuilder | Define se um aviso será mostrado quando a entrada falhar na validação de dados ou se ela será totalmente rejeitada. |
setHelpText(helpText) | DataValidationBuilder | Define o texto de ajuda que aparece quando o usuário passa o cursor sobre a célula em que a validação de dados está definida. |
withCriteria(criteria, args) | DataValidationBuilder | Define a regra de validação de dados para os critérios definidos por valores DataValidationCriteria , normalmente retirados de criteria e arguments de uma regra atual. |
DataValidationCriteria
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
DATE_AFTER | Enum | Requer uma data posterior ao valor fornecido. |
DATE_BEFORE | Enum | Requer uma data anterior ao valor fornecido. |
DATE_BETWEEN | Enum | Requer uma data entre os valores fornecidos. |
DATE_EQUAL_TO | Enum | Requer uma data igual ao valor informado. |
DATE_IS_VALID_DATE | Enum | Requer uma data. |
DATE_NOT_BETWEEN | Enum | Requer uma data que não esteja entre os valores fornecidos. |
DATE_ON_OR_AFTER | Enum | Exige uma data igual ou posterior ao valor fornecido. |
DATE_ON_OR_BEFORE | Enum | Requer uma data igual ou anterior ao valor fornecido. |
NUMBER_BETWEEN | Enum | Requer um número entre os valores fornecidos. |
NUMBER_EQUAL_TO | Enum | Requer um número igual ao valor fornecido. |
NUMBER_GREATER_THAN | Enum | Exige um número maior do que o valor fornecido. |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | Requer um número maior ou igual ao valor fornecido. |
NUMBER_LESS_THAN | Enum | Requer um número menor do que o valor fornecido. |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | Requer um número menor ou igual ao valor fornecido. |
NUMBER_NOT_BETWEEN | Enum | Requer um número que não esteja entre os valores fornecidos. |
NUMBER_NOT_EQUAL_TO | Enum | Requer um número que não seja igual ao valor fornecido. |
TEXT_CONTAINS | Enum | Requer que a entrada contenha o valor fornecido. |
TEXT_DOES_NOT_CONTAIN | Enum | Requer que a entrada não contenha o valor fornecido. |
TEXT_EQUAL_TO | Enum | Exige que a entrada seja igual ao valor informado. |
TEXT_IS_VALID_EMAIL | Enum | Requer que a entrada esteja na forma de um endereço de e-mail. |
TEXT_IS_VALID_URL | Enum | Requer que a entrada esteja na forma de um URL. |
VALUE_IN_LIST | Enum | Requer que a entrada seja igual a um dos valores fornecidos. |
VALUE_IN_RANGE | Enum | Requer que a entrada seja igual a um valor no intervalo fornecido. |
CUSTOM_FORMULA | Enum | Exige que a entrada faça a fórmula especificada ser avaliada como true . |
CHECKBOX | Enum | Requer que a entrada seja um valor personalizado ou um booleano, renderizado como uma caixa de seleção. |
DateTimeGroupingRule
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getRuleType() | DateTimeGroupingRuleType | Extrai o tipo da regra de agrupamento de data-hora. |
DateTimeGroupingRuleType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
UNSUPPORTED | Enum | Um tipo de regra de agrupamento de data-hora que não é compatível. |
SECOND | Enum | Agrupar data-hora por segundo, de 0 a 59. |
MINUTE | Enum | Agrupar data-hora por minuto, de 0 a 59. |
HOUR | Enum | Agrupe data-hora por hora usando um sistema 24 horas, de 0 a 23. |
HOUR_MINUTE | Enum | Agrupe data-hora por hora e minuto usando um sistema de 24 horas, por exemplo, 19:45 . |
HOUR_MINUTE_AMPM | Enum | Agrupe data-hora por hora e minuto usando um sistema de 12 horas, por exemplo, 7:45 PM . |
DAY_OF_WEEK | Enum | Agrupar data-hora pelo dia da semana, por exemplo, Sunday . |
DAY_OF_YEAR | Enum | Agrupar data-hora por dia do ano, de 1 a 366. |
DAY_OF_MONTH | Enum | Agrupe data-hora por dia do mês, de 1 a 31. |
DAY_MONTH | Enum | Agrupe a data-hora por dia e mês, por exemplo, 22-Nov . |
MONTH | Enum | Agrupar data-hora por mês, por exemplo, Nov . |
QUARTER | Enum | Agrupe data-hora por trimestre, por exemplo, T1 (que representa de janeiro a março). |
YEAR | Enum | Agrupar data-hora por ano, por exemplo, 2008. |
YEAR_MONTH | Enum | Agrupe data-hora por ano e mês, por exemplo, 2008-Nov . |
YEAR_QUARTER | Enum | Agrupe data-hora por ano e trimestre, por exemplo, 2008 Q4 . |
YEAR_MONTH_DAY | Enum | Agrupe data-hora por ano, mês e dia, por exemplo, 2008-11-22 . |
DeveloperMetadata
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getId() | Integer | Retorna o ID exclusivo associado aos metadados desse desenvolvedor. |
getKey() | String | Retorna a chave associada aos metadados desse desenvolvedor. |
getLocation() | DeveloperMetadataLocation | Retorna o local desses metadados do desenvolvedor. |
getValue() | String | Retorna o valor associado aos metadados do desenvolvedor ou null caso esses metadados não tenham valor. |
getVisibility() | DeveloperMetadataVisibility | Retorna a visibilidade dos metadados desse desenvolvedor. |
moveToColumn(column) | DeveloperMetadata | Move os metadados do desenvolvedor para a coluna especificada. |
moveToRow(row) | DeveloperMetadata | Move os metadados do desenvolvedor para a linha especificada. |
moveToSheet(sheet) | DeveloperMetadata | Move os metadados do desenvolvedor para a página especificada. |
moveToSpreadsheet() | DeveloperMetadata | Move os metadados do desenvolvedor para a planilha de nível superior. |
remove() | void | Exclui esses metadados. |
setKey(key) | DeveloperMetadata | Define a chave dos metadados deste desenvolvedor para o valor especificado. |
setValue(value) | DeveloperMetadata | Define o valor associado aos metadados deste desenvolvedor como o valor especificado. |
setVisibility(visibility) | DeveloperMetadata | Define a visibilidade dos metadados do desenvolvedor como a visibilidade especificada. |
DeveloperMetadataFinder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
find() | DeveloperMetadata[] | Executa essa pesquisa e retorna os metadados correspondentes. |
onIntersectingLocations() | DeveloperMetadataFinder | Configura a pesquisa para considerar locais de interseção que têm metadados. |
withId(id) | DeveloperMetadataFinder | Limita esta pesquisa para considerar apenas os metadados que correspondem ao ID especificado. |
withKey(key) | DeveloperMetadataFinder | Limita esta pesquisa para considerar apenas os metadados que correspondem à chave especificada. |
withLocationType(locationType) | DeveloperMetadataFinder | Limita esta pesquisa para considerar apenas os metadados que correspondem ao tipo de local especificado. |
withValue(value) | DeveloperMetadataFinder | Limita esta pesquisa para considerar apenas os metadados que correspondem ao valor especificado. |
withVisibility(visibility) | DeveloperMetadataFinder | Limita esta pesquisa para considerar apenas os metadados que correspondem à visibilidade especificada. |
DeveloperMetadataLocation
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getColumn() | Range | Retorna o Range do local da coluna desses metadados ou null se o tipo de local não for DeveloperMetadataLocationType.COLUMN . |
getLocationType() | DeveloperMetadataLocationType | Recebe o tipo de local. |
getRow() | Range | Retorna o Range do local da linha desses metadados ou null se o tipo de local não for DeveloperMetadataLocationType.ROW . |
getSheet() | Sheet | Retorna o local Sheet desses metadados ou null se o tipo de local não for DeveloperMetadataLocationType.SHEET . |
getSpreadsheet() | Spreadsheet | Retorna o local Spreadsheet desses metadados ou null se o tipo de local não for DeveloperMetadataLocationType.SPREADSHEET . |
DeveloperMetadataLocationType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
SPREADSHEET | Enum | É o tipo de local para os metadados do desenvolvedor associados à planilha de nível superior. |
SHEET | Enum | É o tipo de local para os metadados do desenvolvedor associados a uma página inteira. |
ROW | Enum | É o tipo de local dos metadados de desenvolvedor associados a uma linha. |
COLUMN | Enum | O tipo de local dos metadados de desenvolvedor associados a uma coluna. |
DeveloperMetadataVisibility
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
DOCUMENT | Enum | Os metadados visíveis ao documento podem ser acessados de qualquer projeto de desenvolvedor com acesso ao documento. |
PROJECT | Enum | Os metadados visíveis ao projeto só são visíveis e acessíveis pelo projeto de desenvolvedor que os criou. |
Dimension
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
COLUMNS | Enum | A dimensão de coluna (vertical). |
ROWS | Enum | A dimensão da linha (horizontal). |
Direction
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
UP | Enum | A direção dos índices de linha decrescentes. |
DOWN | Enum | A direção do aumento dos índices de linha. |
PREVIOUS | Enum | A direção dos índices de coluna decrescentes. |
NEXT | Enum | A direção do aumento dos índices das colunas. |
Drawing
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getContainerInfo() | ContainerInfo | Recebe informações sobre onde o desenho está posicionado na página. |
getHeight() | Integer | Retorna a altura real desse desenho em pixels. |
getOnAction() | String | Retorna o nome da macro anexada a este desenho. |
getSheet() | Sheet | Retorna a página em que esse desenho aparece. |
getWidth() | Integer | Retorna a largura real desse desenho em pixels. |
getZIndex() | Number | Retorna o Z-index desse desenho. |
remove() | void | Exclui este desenho da planilha. |
setHeight(height) | Drawing | Define a altura real deste desenho em pixels. |
setOnAction(macroName) | Drawing | Atribui uma função de macro a este desenho. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | Drawing | Define a posição em que o desenho aparece na página. |
setWidth(width) | Drawing | Define a largura real deste desenho em pixels. |
setZIndex(zIndex) | Drawing | Define o Z-index do desenho. |
EmbeddedAreaChartBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adiciona um intervalo ao gráfico que o criador modifica. |
asAreaChart() | EmbeddedAreaChartBuilder | Define o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Define o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Define o tipo de gráfico como ColumnChart e retorna EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Define o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Define o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Define o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Define o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Define o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Define o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Cria o gráfico para refletir todas as alterações feitas nele. |
clearRanges() | EmbeddedChartBuilder | Remove todos os intervalos do gráfico que este construtor modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que o gráfico aparece na página. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que disponibilizam dados para o gráfico no momento. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que este criador modifica. |
reverseCategories() | EmbeddedAreaChartBuilder | Inverte o desenho das séries no eixo de domínio. |
setBackgroundColor(cssValue) | EmbeddedAreaChartBuilder | Define a cor do plano de fundo do gráfico. |
setChartType(type) | EmbeddedChartBuilder | Muda o tipo de gráfico. |
setColors(cssValues) | EmbeddedAreaChartBuilder | Define as cores das linhas no gráfico. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Define a estratégia a ser usada para linhas e colunas ocultas. |
setLegendPosition(position) | EmbeddedAreaChartBuilder | Define a posição da legenda em relação ao gráfico. |
setLegendTextStyle(textStyle) | EmbeddedAreaChartBuilder | Define o estilo de texto da legenda do gráfico. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Define a estratégia de combinação a ser usada quando houver mais de um intervalo. |
setNumHeaders(headers) | EmbeddedChartBuilder | Define o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos. |
setOption(option, value) | EmbeddedChartBuilder | Define opções avançadas para este gráfico. |
setPointStyle(style) | EmbeddedAreaChartBuilder | Define o estilo dos pontos na linha. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Define a posição, alterando onde o gráfico aparece na página. |
setRange(start, end) | EmbeddedAreaChartBuilder | Define o intervalo do gráfico. |
setStacked() | EmbeddedAreaChartBuilder | Usa linhas empilhadas, o que significa que os valores de linha e barra são empilhados (acumulados). |
setTitle(chartTitle) | EmbeddedAreaChartBuilder | Define o título do gráfico. |
setTitleTextStyle(textStyle) | EmbeddedAreaChartBuilder | Define o estilo de texto do título do gráfico. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Define se as linhas e colunas do gráfico serão transpostas. |
setXAxisTextStyle(textStyle) | EmbeddedAreaChartBuilder | Define o estilo de texto do eixo horizontal. |
setXAxisTitle(title) | EmbeddedAreaChartBuilder | Adiciona um título ao eixo horizontal. |
setXAxisTitleTextStyle(textStyle) | EmbeddedAreaChartBuilder | Define o estilo do texto do título do eixo horizontal. |
setYAxisTextStyle(textStyle) | EmbeddedAreaChartBuilder | Define o estilo de texto do eixo vertical. |
setYAxisTitle(title) | EmbeddedAreaChartBuilder | Adiciona um título ao eixo vertical. |
setYAxisTitleTextStyle(textStyle) | EmbeddedAreaChartBuilder | Define o estilo do texto do título do eixo vertical. |
useLogScale() | EmbeddedAreaChartBuilder | Transforma o eixo do intervalo em uma escala logarítmica (requer que todos os valores sejam positivos). |
EmbeddedBarChartBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adiciona um intervalo ao gráfico que o criador modifica. |
asAreaChart() | EmbeddedAreaChartBuilder | Define o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Define o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Define o tipo de gráfico como ColumnChart e retorna EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Define o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Define o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Define o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Define o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Define o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Define o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Cria o gráfico para refletir todas as alterações feitas nele. |
clearRanges() | EmbeddedChartBuilder | Remove todos os intervalos do gráfico que este construtor modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que o gráfico aparece na página. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que disponibilizam dados para o gráfico no momento. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que este criador modifica. |
reverseCategories() | EmbeddedBarChartBuilder | Inverte o desenho das séries no eixo de domínio. |
reverseDirection() | EmbeddedBarChartBuilder | Inverte a direção em que as barras crescem ao longo do eixo horizontal. |
setBackgroundColor(cssValue) | EmbeddedBarChartBuilder | Define a cor do plano de fundo do gráfico. |
setChartType(type) | EmbeddedChartBuilder | Muda o tipo de gráfico. |
setColors(cssValues) | EmbeddedBarChartBuilder | Define as cores das linhas no gráfico. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Define a estratégia a ser usada para linhas e colunas ocultas. |
setLegendPosition(position) | EmbeddedBarChartBuilder | Define a posição da legenda em relação ao gráfico. |
setLegendTextStyle(textStyle) | EmbeddedBarChartBuilder | Define o estilo de texto da legenda do gráfico. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Define a estratégia de combinação a ser usada quando houver mais de um intervalo. |
setNumHeaders(headers) | EmbeddedChartBuilder | Define o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos. |
setOption(option, value) | EmbeddedChartBuilder | Define opções avançadas para este gráfico. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Define a posição, alterando onde o gráfico aparece na página. |
setRange(start, end) | EmbeddedBarChartBuilder | Define o intervalo do gráfico. |
setStacked() | EmbeddedBarChartBuilder | Usa linhas empilhadas, o que significa que os valores de linha e barra são empilhados (acumulados). |
setTitle(chartTitle) | EmbeddedBarChartBuilder | Define o título do gráfico. |
setTitleTextStyle(textStyle) | EmbeddedBarChartBuilder | Define o estilo de texto do título do gráfico. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Define se as linhas e colunas do gráfico serão transpostas. |
setXAxisTextStyle(textStyle) | EmbeddedBarChartBuilder | Define o estilo de texto do eixo horizontal. |
setXAxisTitle(title) | EmbeddedBarChartBuilder | Adiciona um título ao eixo horizontal. |
setXAxisTitleTextStyle(textStyle) | EmbeddedBarChartBuilder | Define o estilo do texto do título do eixo horizontal. |
setYAxisTextStyle(textStyle) | EmbeddedBarChartBuilder | Define o estilo de texto do eixo vertical. |
setYAxisTitle(title) | EmbeddedBarChartBuilder | Adiciona um título ao eixo vertical. |
setYAxisTitleTextStyle(textStyle) | EmbeddedBarChartBuilder | Define o estilo do texto do título do eixo vertical. |
useLogScale() | EmbeddedBarChartBuilder | Transforma o eixo do intervalo em uma escala logarítmica (requer que todos os valores sejam positivos). |
EmbeddedChart
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
asDataSourceChart() | DataSourceChart | Converte para uma instância de gráfico da fonte de dados se o gráfico for de fonte de dados. Caso contrário, o resultado será null . |
getAs(contentType) | Blob | Retorne os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado. |
getBlob() | Blob | Retorne os dados dentro desse objeto como um blob. |
getChartId() | Integer | Retorna um identificador estável para o gráfico que é exclusivo em toda a planilha que contém o gráfico ou null se o gráfico não estiver em uma planilha. |
getContainerInfo() | ContainerInfo | Retorna informações sobre onde o gráfico está posicionado em uma página. |
getHiddenDimensionStrategy() | ChartHiddenDimensionStrategy | Retorna a estratégia a ser usada para lidar com linhas e colunas ocultas. |
getMergeStrategy() | ChartMergeStrategy | Retorna a estratégia de mesclagem usada quando há mais de um intervalo. |
getNumHeaders() | Integer | Retorna o número de linhas ou colunas do intervalo que são tratadas como cabeçalhos. |
getOptions() | ChartOptions | Retorna as opções desse gráfico, como altura, cores e eixos. |
getRanges() | Range[] | Retorna os intervalos que este gráfico usa como fonte de dados. |
getTransposeRowsAndColumns() | Boolean | Se for true , as linhas e colunas usadas para preencher o gráfico serão alteradas. |
modify() | EmbeddedChartBuilder | Retorna um EmbeddedChartBuilder que pode ser usado para modificar esse gráfico. |
EmbeddedChartBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adiciona um intervalo ao gráfico que o criador modifica. |
asAreaChart() | EmbeddedAreaChartBuilder | Define o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Define o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Define o tipo de gráfico como ColumnChart e retorna EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Define o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Define o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Define o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Define o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Define o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Define o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Cria o gráfico para refletir todas as alterações feitas nele. |
clearRanges() | EmbeddedChartBuilder | Remove todos os intervalos do gráfico que este construtor modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que o gráfico aparece na página. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que disponibilizam dados para o gráfico no momento. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que este criador modifica. |
setChartType(type) | EmbeddedChartBuilder | Muda o tipo de gráfico. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Define a estratégia a ser usada para linhas e colunas ocultas. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Define a estratégia de combinação a ser usada quando houver mais de um intervalo. |
setNumHeaders(headers) | EmbeddedChartBuilder | Define o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos. |
setOption(option, value) | EmbeddedChartBuilder | Define opções avançadas para este gráfico. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Define a posição, alterando onde o gráfico aparece na página. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Define se as linhas e colunas do gráfico serão transpostas. |
EmbeddedColumnChartBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adiciona um intervalo ao gráfico que o criador modifica. |
asAreaChart() | EmbeddedAreaChartBuilder | Define o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Define o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Define o tipo de gráfico como ColumnChart e retorna EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Define o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Define o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Define o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Define o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Define o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Define o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Cria o gráfico para refletir todas as alterações feitas nele. |
clearRanges() | EmbeddedChartBuilder | Remove todos os intervalos do gráfico que este construtor modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que o gráfico aparece na página. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que disponibilizam dados para o gráfico no momento. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que este criador modifica. |
reverseCategories() | EmbeddedColumnChartBuilder | Inverte o desenho das séries no eixo de domínio. |
setBackgroundColor(cssValue) | EmbeddedColumnChartBuilder | Define a cor do plano de fundo do gráfico. |
setChartType(type) | EmbeddedChartBuilder | Muda o tipo de gráfico. |
setColors(cssValues) | EmbeddedColumnChartBuilder | Define as cores das linhas no gráfico. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Define a estratégia a ser usada para linhas e colunas ocultas. |
setLegendPosition(position) | EmbeddedColumnChartBuilder | Define a posição da legenda em relação ao gráfico. |
setLegendTextStyle(textStyle) | EmbeddedColumnChartBuilder | Define o estilo de texto da legenda do gráfico. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Define a estratégia de combinação a ser usada quando houver mais de um intervalo. |
setNumHeaders(headers) | EmbeddedChartBuilder | Define o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos. |
setOption(option, value) | EmbeddedChartBuilder | Define opções avançadas para este gráfico. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Define a posição, alterando onde o gráfico aparece na página. |
setRange(start, end) | EmbeddedColumnChartBuilder | Define o intervalo do gráfico. |
setStacked() | EmbeddedColumnChartBuilder | Usa linhas empilhadas, o que significa que os valores de linha e barra são empilhados (acumulados). |
setTitle(chartTitle) | EmbeddedColumnChartBuilder | Define o título do gráfico. |
setTitleTextStyle(textStyle) | EmbeddedColumnChartBuilder | Define o estilo de texto do título do gráfico. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Define se as linhas e colunas do gráfico serão transpostas. |
setXAxisTextStyle(textStyle) | EmbeddedColumnChartBuilder | Define o estilo de texto do eixo horizontal. |
setXAxisTitle(title) | EmbeddedColumnChartBuilder | Adiciona um título ao eixo horizontal. |
setXAxisTitleTextStyle(textStyle) | EmbeddedColumnChartBuilder | Define o estilo do texto do título do eixo horizontal. |
setYAxisTextStyle(textStyle) | EmbeddedColumnChartBuilder | Define o estilo de texto do eixo vertical. |
setYAxisTitle(title) | EmbeddedColumnChartBuilder | Adiciona um título ao eixo vertical. |
setYAxisTitleTextStyle(textStyle) | EmbeddedColumnChartBuilder | Define o estilo do texto do título do eixo vertical. |
useLogScale() | EmbeddedColumnChartBuilder | Transforma o eixo do intervalo em uma escala logarítmica (requer que todos os valores sejam positivos). |
EmbeddedComboChartBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adiciona um intervalo ao gráfico que o criador modifica. |
asAreaChart() | EmbeddedAreaChartBuilder | Define o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Define o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Define o tipo de gráfico como ColumnChart e retorna EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Define o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Define o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Define o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Define o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Define o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Define o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Cria o gráfico para refletir todas as alterações feitas nele. |
clearRanges() | EmbeddedChartBuilder | Remove todos os intervalos do gráfico que este construtor modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que o gráfico aparece na página. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que disponibilizam dados para o gráfico no momento. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que este criador modifica. |
reverseCategories() | EmbeddedComboChartBuilder | Inverte o desenho das séries no eixo de domínio. |
setBackgroundColor(cssValue) | EmbeddedComboChartBuilder | Define a cor do plano de fundo do gráfico. |
setChartType(type) | EmbeddedChartBuilder | Muda o tipo de gráfico. |
setColors(cssValues) | EmbeddedComboChartBuilder | Define as cores das linhas no gráfico. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Define a estratégia a ser usada para linhas e colunas ocultas. |
setLegendPosition(position) | EmbeddedComboChartBuilder | Define a posição da legenda em relação ao gráfico. |
setLegendTextStyle(textStyle) | EmbeddedComboChartBuilder | Define o estilo de texto da legenda do gráfico. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Define a estratégia de combinação a ser usada quando houver mais de um intervalo. |
setNumHeaders(headers) | EmbeddedChartBuilder | Define o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos. |
setOption(option, value) | EmbeddedChartBuilder | Define opções avançadas para este gráfico. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Define a posição, alterando onde o gráfico aparece na página. |
setRange(start, end) | EmbeddedComboChartBuilder | Define o intervalo do gráfico. |
setStacked() | EmbeddedComboChartBuilder | Usa linhas empilhadas, o que significa que os valores de linha e barra são empilhados (acumulados). |
setTitle(chartTitle) | EmbeddedComboChartBuilder | Define o título do gráfico. |
setTitleTextStyle(textStyle) | EmbeddedComboChartBuilder | Define o estilo de texto do título do gráfico. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Define se as linhas e colunas do gráfico serão transpostas. |
setXAxisTextStyle(textStyle) | EmbeddedComboChartBuilder | Define o estilo de texto do eixo horizontal. |
setXAxisTitle(title) | EmbeddedComboChartBuilder | Adiciona um título ao eixo horizontal. |
setXAxisTitleTextStyle(textStyle) | EmbeddedComboChartBuilder | Define o estilo do texto do título do eixo horizontal. |
setYAxisTextStyle(textStyle) | EmbeddedComboChartBuilder | Define o estilo de texto do eixo vertical. |
setYAxisTitle(title) | EmbeddedComboChartBuilder | Adiciona um título ao eixo vertical. |
setYAxisTitleTextStyle(textStyle) | EmbeddedComboChartBuilder | Define o estilo do texto do título do eixo vertical. |
useLogScale() | EmbeddedComboChartBuilder | Transforma o eixo do intervalo em uma escala logarítmica (requer que todos os valores sejam positivos). |
EmbeddedHistogramChartBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adiciona um intervalo ao gráfico que o criador modifica. |
asAreaChart() | EmbeddedAreaChartBuilder | Define o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Define o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Define o tipo de gráfico como ColumnChart e retorna EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Define o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Define o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Define o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Define o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Define o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Define o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Cria o gráfico para refletir todas as alterações feitas nele. |
clearRanges() | EmbeddedChartBuilder | Remove todos os intervalos do gráfico que este construtor modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que o gráfico aparece na página. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que disponibilizam dados para o gráfico no momento. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que este criador modifica. |
reverseCategories() | EmbeddedHistogramChartBuilder | Inverte o desenho das séries no eixo de domínio. |
setBackgroundColor(cssValue) | EmbeddedHistogramChartBuilder | Define a cor do plano de fundo do gráfico. |
setChartType(type) | EmbeddedChartBuilder | Muda o tipo de gráfico. |
setColors(cssValues) | EmbeddedHistogramChartBuilder | Define as cores das linhas no gráfico. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Define a estratégia a ser usada para linhas e colunas ocultas. |
setLegendPosition(position) | EmbeddedHistogramChartBuilder | Define a posição da legenda em relação ao gráfico. |
setLegendTextStyle(textStyle) | EmbeddedHistogramChartBuilder | Define o estilo de texto da legenda do gráfico. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Define a estratégia de combinação a ser usada quando houver mais de um intervalo. |
setNumHeaders(headers) | EmbeddedChartBuilder | Define o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos. |
setOption(option, value) | EmbeddedChartBuilder | Define opções avançadas para este gráfico. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Define a posição, alterando onde o gráfico aparece na página. |
setRange(start, end) | EmbeddedHistogramChartBuilder | Define o intervalo do gráfico. |
setStacked() | EmbeddedHistogramChartBuilder | Usa linhas empilhadas, o que significa que os valores de linha e barra são empilhados (acumulados). |
setTitle(chartTitle) | EmbeddedHistogramChartBuilder | Define o título do gráfico. |
setTitleTextStyle(textStyle) | EmbeddedHistogramChartBuilder | Define o estilo de texto do título do gráfico. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Define se as linhas e colunas do gráfico serão transpostas. |
setXAxisTextStyle(textStyle) | EmbeddedHistogramChartBuilder | Define o estilo de texto do eixo horizontal. |
setXAxisTitle(title) | EmbeddedHistogramChartBuilder | Adiciona um título ao eixo horizontal. |
setXAxisTitleTextStyle(textStyle) | EmbeddedHistogramChartBuilder | Define o estilo do texto do título do eixo horizontal. |
setYAxisTextStyle(textStyle) | EmbeddedHistogramChartBuilder | Define o estilo de texto do eixo vertical. |
setYAxisTitle(title) | EmbeddedHistogramChartBuilder | Adiciona um título ao eixo vertical. |
setYAxisTitleTextStyle(textStyle) | EmbeddedHistogramChartBuilder | Define o estilo do texto do título do eixo vertical. |
useLogScale() | EmbeddedHistogramChartBuilder | Transforma o eixo do intervalo em uma escala logarítmica (requer que todos os valores sejam positivos). |
EmbeddedLineChartBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adiciona um intervalo ao gráfico que o criador modifica. |
asAreaChart() | EmbeddedAreaChartBuilder | Define o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Define o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Define o tipo de gráfico como ColumnChart e retorna EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Define o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Define o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Define o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Define o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Define o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Define o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Cria o gráfico para refletir todas as alterações feitas nele. |
clearRanges() | EmbeddedChartBuilder | Remove todos os intervalos do gráfico que este construtor modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que o gráfico aparece na página. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que disponibilizam dados para o gráfico no momento. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que este criador modifica. |
reverseCategories() | EmbeddedLineChartBuilder | Inverte o desenho das séries no eixo de domínio. |
setBackgroundColor(cssValue) | EmbeddedLineChartBuilder | Define a cor do plano de fundo do gráfico. |
setChartType(type) | EmbeddedChartBuilder | Muda o tipo de gráfico. |
setColors(cssValues) | EmbeddedLineChartBuilder | Define as cores das linhas no gráfico. |
setCurveStyle(style) | EmbeddedLineChartBuilder | Define o estilo a ser usado para curvas no gráfico. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Define a estratégia a ser usada para linhas e colunas ocultas. |
setLegendPosition(position) | EmbeddedLineChartBuilder | Define a posição da legenda em relação ao gráfico. |
setLegendTextStyle(textStyle) | EmbeddedLineChartBuilder | Define o estilo de texto da legenda do gráfico. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Define a estratégia de combinação a ser usada quando houver mais de um intervalo. |
setNumHeaders(headers) | EmbeddedChartBuilder | Define o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos. |
setOption(option, value) | EmbeddedChartBuilder | Define opções avançadas para este gráfico. |
setPointStyle(style) | EmbeddedLineChartBuilder | Define o estilo dos pontos na linha. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Define a posição, alterando onde o gráfico aparece na página. |
setRange(start, end) | EmbeddedLineChartBuilder | Define o intervalo do gráfico. |
setTitle(chartTitle) | EmbeddedLineChartBuilder | Define o título do gráfico. |
setTitleTextStyle(textStyle) | EmbeddedLineChartBuilder | Define o estilo de texto do título do gráfico. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Define se as linhas e colunas do gráfico serão transpostas. |
setXAxisTextStyle(textStyle) | EmbeddedLineChartBuilder | Define o estilo de texto do eixo horizontal. |
setXAxisTitle(title) | EmbeddedLineChartBuilder | Adiciona um título ao eixo horizontal. |
setXAxisTitleTextStyle(textStyle) | EmbeddedLineChartBuilder | Define o estilo do texto do título do eixo horizontal. |
setYAxisTextStyle(textStyle) | EmbeddedLineChartBuilder | Define o estilo de texto do eixo vertical. |
setYAxisTitle(title) | EmbeddedLineChartBuilder | Adiciona um título ao eixo vertical. |
setYAxisTitleTextStyle(textStyle) | EmbeddedLineChartBuilder | Define o estilo do texto do título do eixo vertical. |
useLogScale() | EmbeddedLineChartBuilder | Transforma o eixo do intervalo em uma escala logarítmica (requer que todos os valores sejam positivos). |
EmbeddedPieChartBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adiciona um intervalo ao gráfico que o criador modifica. |
asAreaChart() | EmbeddedAreaChartBuilder | Define o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Define o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Define o tipo de gráfico como ColumnChart e retorna EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Define o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Define o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Define o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Define o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Define o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Define o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Cria o gráfico para refletir todas as alterações feitas nele. |
clearRanges() | EmbeddedChartBuilder | Remove todos os intervalos do gráfico que este construtor modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que o gráfico aparece na página. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que disponibilizam dados para o gráfico no momento. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que este criador modifica. |
reverseCategories() | EmbeddedPieChartBuilder | Inverte o desenho das séries no eixo de domínio. |
set3D() | EmbeddedPieChartBuilder | Define o gráfico como tridimensional. |
setBackgroundColor(cssValue) | EmbeddedPieChartBuilder | Define a cor do plano de fundo do gráfico. |
setChartType(type) | EmbeddedChartBuilder | Muda o tipo de gráfico. |
setColors(cssValues) | EmbeddedPieChartBuilder | Define as cores das linhas no gráfico. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Define a estratégia a ser usada para linhas e colunas ocultas. |
setLegendPosition(position) | EmbeddedPieChartBuilder | Define a posição da legenda em relação ao gráfico. |
setLegendTextStyle(textStyle) | EmbeddedPieChartBuilder | Define o estilo de texto da legenda do gráfico. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Define a estratégia de combinação a ser usada quando houver mais de um intervalo. |
setNumHeaders(headers) | EmbeddedChartBuilder | Define o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos. |
setOption(option, value) | EmbeddedChartBuilder | Define opções avançadas para este gráfico. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Define a posição, alterando onde o gráfico aparece na página. |
setTitle(chartTitle) | EmbeddedPieChartBuilder | Define o título do gráfico. |
setTitleTextStyle(textStyle) | EmbeddedPieChartBuilder | Define o estilo de texto do título do gráfico. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Define se as linhas e colunas do gráfico serão transpostas. |
EmbeddedScatterChartBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adiciona um intervalo ao gráfico que o criador modifica. |
asAreaChart() | EmbeddedAreaChartBuilder | Define o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Define o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Define o tipo de gráfico como ColumnChart e retorna EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Define o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Define o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Define o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Define o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Define o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Define o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Cria o gráfico para refletir todas as alterações feitas nele. |
clearRanges() | EmbeddedChartBuilder | Remove todos os intervalos do gráfico que este construtor modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que o gráfico aparece na página. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que disponibilizam dados para o gráfico no momento. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que este criador modifica. |
setBackgroundColor(cssValue) | EmbeddedScatterChartBuilder | Define a cor do plano de fundo do gráfico. |
setChartType(type) | EmbeddedChartBuilder | Muda o tipo de gráfico. |
setColors(cssValues) | EmbeddedScatterChartBuilder | Define as cores das linhas no gráfico. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Define a estratégia a ser usada para linhas e colunas ocultas. |
setLegendPosition(position) | EmbeddedScatterChartBuilder | Define a posição da legenda em relação ao gráfico. |
setLegendTextStyle(textStyle) | EmbeddedScatterChartBuilder | Define o estilo de texto da legenda do gráfico. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Define a estratégia de combinação a ser usada quando houver mais de um intervalo. |
setNumHeaders(headers) | EmbeddedChartBuilder | Define o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos. |
setOption(option, value) | EmbeddedChartBuilder | Define opções avançadas para este gráfico. |
setPointStyle(style) | EmbeddedScatterChartBuilder | Define o estilo dos pontos na linha. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Define a posição, alterando onde o gráfico aparece na página. |
setTitle(chartTitle) | EmbeddedScatterChartBuilder | Define o título do gráfico. |
setTitleTextStyle(textStyle) | EmbeddedScatterChartBuilder | Define o estilo de texto do título do gráfico. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Define se as linhas e colunas do gráfico serão transpostas. |
setXAxisLogScale() | EmbeddedScatterChartBuilder | Transforma o eixo horizontal em uma escala logarítmica (requer que todos os valores sejam positivos). |
setXAxisRange(start, end) | EmbeddedScatterChartBuilder | Define o intervalo do eixo horizontal do gráfico. |
setXAxisTextStyle(textStyle) | EmbeddedScatterChartBuilder | Define o estilo de texto do eixo horizontal. |
setXAxisTitle(title) | EmbeddedScatterChartBuilder | Adiciona um título ao eixo horizontal. |
setXAxisTitleTextStyle(textStyle) | EmbeddedScatterChartBuilder | Define o estilo do texto do título do eixo horizontal. |
setYAxisLogScale() | EmbeddedScatterChartBuilder | Torna o eixo vertical em uma escala logarítmica (requer que todos os valores sejam positivos). |
setYAxisRange(start, end) | EmbeddedScatterChartBuilder | Define o intervalo do eixo vertical do gráfico. |
setYAxisTextStyle(textStyle) | EmbeddedScatterChartBuilder | Define o estilo de texto do eixo vertical. |
setYAxisTitle(title) | EmbeddedScatterChartBuilder | Adiciona um título ao eixo vertical. |
setYAxisTitleTextStyle(textStyle) | EmbeddedScatterChartBuilder | Define o estilo do texto do título do eixo vertical. |
EmbeddedTableChartBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Adiciona um intervalo ao gráfico que o criador modifica. |
asAreaChart() | EmbeddedAreaChartBuilder | Define o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Define o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Define o tipo de gráfico como ColumnChart e retorna EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Define o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Define o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Define o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Define o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Define o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Define o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Cria o gráfico para refletir todas as alterações feitas nele. |
clearRanges() | EmbeddedChartBuilder | Remove todos os intervalos do gráfico que este construtor modifica. |
enablePaging(enablePaging) | EmbeddedTableChartBuilder | Define se a paginação será ativada pelos dados. |
enablePaging(pageSize) | EmbeddedTableChartBuilder | Ativa a paginação e define o número de linhas em cada página. |
enablePaging(pageSize, startPage) | EmbeddedTableChartBuilder | Ativa a paginação, define o número de linhas em cada página e a primeira página da tabela a ser exibida (os números das páginas são baseados em zero). |
enableRtlTable(rtlEnabled) | EmbeddedTableChartBuilder | Adiciona suporte básico a idiomas escritos da direita para a esquerda (como árabe ou hebraico) invertendo a ordem das colunas da tabela, de modo que a coluna zero seja a mais à direita e a última coluna seja a mais à esquerda. |
enableSorting(enableSorting) | EmbeddedTableChartBuilder | Define se as colunas serão classificadas quando o usuário clicar no cabeçalho de uma coluna. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que o gráfico aparece na página. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que disponibilizam dados para o gráfico no momento. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que este criador modifica. |
setChartType(type) | EmbeddedChartBuilder | Muda o tipo de gráfico. |
setFirstRowNumber(number) | EmbeddedTableChartBuilder | Define o número da primeira linha na tabela de dados. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Define a estratégia a ser usada para linhas e colunas ocultas. |
setInitialSortingAscending(column) | EmbeddedTableChartBuilder | Define o índice da coluna de acordo com o qual a tabela será inicialmente classificada (crescente). |
setInitialSortingDescending(column) | EmbeddedTableChartBuilder | Define o índice da coluna de acordo com o qual a tabela será inicialmente classificada (decrescente). |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Define a estratégia de combinação a ser usada quando houver mais de um intervalo. |
setNumHeaders(headers) | EmbeddedChartBuilder | Define o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos. |
setOption(option, value) | EmbeddedChartBuilder | Define opções avançadas para este gráfico. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Define a posição, alterando onde o gráfico aparece na página. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Define se as linhas e colunas do gráfico serão transpostas. |
showRowNumberColumn(showRowNumber) | EmbeddedTableChartBuilder | Define se o número da linha será mostrado como a primeira coluna da tabela. |
useAlternatingRowStyle(alternate) | EmbeddedTableChartBuilder | Define se o estilo de cor alternada será atribuído às linhas pares e ímpares do gráfico de tabela. |
Filter
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getColumnFilterCriteria(columnPosition) | FilterCriteria | Recebe os critérios de filtro na coluna especificada ou null quando a coluna não tem critérios de filtro aplicados a ela. |
getRange() | Range | Recebe o intervalo ao qual este filtro se aplica. |
remove() | void | Remove esse filtro. |
removeColumnFilterCriteria(columnPosition) | Filter | Remove os critérios de filtro da coluna especificada. |
setColumnFilterCriteria(columnPosition, filterCriteria) | Filter | Define os critérios de filtro na coluna especificada. |
sort(columnPosition, ascending) | Filter | Classifica o intervalo filtrado pela coluna especificada, excluindo a primeira linha (a linha de cabeçalho) no intervalo a que esse filtro se aplica. |
FilterCriteria
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | FilterCriteriaBuilder | Copia esses critérios de filtro e cria um criador de critérios que você pode aplicar a outro filtro. |
getCriteriaType() | BooleanCriteria | Retorna 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() | Color | Retorna a cor de fundo usada como critérios de filtro. |
getVisibleForegroundColor() | Color | Retorna a cor do primeiro plano usada como critério de filtro. |
getVisibleValues() | String[] | Retorna os valores exibidos pelo filtro da tabela dinâmica. |
FilterCriteriaBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
build() | FilterCriteria | Monta os critérios de filtro usando as configurações que você adiciona ao criador de critérios. |
copy() | FilterCriteriaBuilder | Copia esses critérios de filtro e cria um criador de critérios que você pode aplicar a outro filtro. |
getCriteriaType() | BooleanCriteria | Retorna 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() | Color | Retorna a cor de fundo usada como critérios de filtro. |
getVisibleForegroundColor() | Color | Retorna a cor do primeiro plano usada como critério de filtro. |
getVisibleValues() | String[] | Retorna os valores exibidos pelo filtro da tabela dinâmica. |
setHiddenValues(values) | FilterCriteriaBuilder | Define os valores a serem ocultados. |
setVisibleBackgroundColor(visibleBackgroundColor) | FilterCriteriaBuilder | Define a cor do plano de fundo usada como critério de filtro. |
setVisibleForegroundColor(visibleForegroundColor) | FilterCriteriaBuilder | Define a cor do primeiro plano usada como critério de filtro. |
setVisibleValues(values) | FilterCriteriaBuilder | Define os valores a serem mostrados em uma tabela dinâmica. |
whenCellEmpty() | FilterCriteriaBuilder | Define os critérios do filtro para mostrar células vazias. |
whenCellNotEmpty() | FilterCriteriaBuilder | Define os critérios de filtro para mostrar as células que não estão vazias. |
whenDateAfter(date) | FilterCriteriaBuilder | Define os critérios de filtro que mostram as células com datas posteriores à data especificada. |
whenDateAfter(date) | FilterCriteriaBuilder | Define os critérios de filtro que mostram as células com datas posteriores à data relativa especificada. |
whenDateBefore(date) | FilterCriteriaBuilder | Define os critérios de filtro que mostram as células com datas anteriores à data especificada. |
whenDateBefore(date) | FilterCriteriaBuilder | Define os critérios de filtro que mostram as células com datas anteriores à data relativa especificada. |
whenDateEqualTo(date) | FilterCriteriaBuilder | Define os critérios de filtro que mostram as células com datas iguais à data especificada. |
whenDateEqualTo(date) | FilterCriteriaBuilder | Define os critérios de filtro que mostram as células com datas iguais à data relativa especificada. |
whenDateEqualToAny(dates) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com datas iguais a qualquer uma das datas especificadas. |
whenDateNotEqualTo(date) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células que não sejam iguais à data especificada. |
whenDateNotEqualToAny(dates) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com datas que não são iguais a nenhuma das datas especificadas. |
whenFormulaSatisfied(formula) | FilterCriteriaBuilder | Define 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) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com um número que esteja entre dois números especificados ou seja um dos dois. |
whenNumberEqualTo(number) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com um número igual ao especificado. |
whenNumberEqualToAny(numbers) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com um número igual a qualquer um dos números especificados. |
whenNumberGreaterThan(number) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com um número maior que o especificado. |
whenNumberGreaterThanOrEqualTo(number) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com um número maior ou igual ao número especificado. |
whenNumberLessThan(number) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com um número menor que o especificado. |
whenNumberLessThanOrEqualTo(number) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com um número menor ou igual ao número especificado. |
whenNumberNotBetween(start, end) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com um número que não esteja entre os dois números especificados. |
whenNumberNotEqualTo(number) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com um número diferente do especificado. |
whenNumberNotEqualToAny(numbers) | FilterCriteriaBuilder | Define 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) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com texto que contenha o texto especificado. |
whenTextDoesNotContain(text) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com texto que não contém o texto especificado. |
whenTextEndsWith(text) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com texto que termine com o texto especificado. |
whenTextEqualTo(text) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com texto igual ao texto especificado. |
whenTextEqualToAny(texts) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com texto igual a qualquer um dos valores de texto especificados. |
whenTextNotEqualTo(text) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com texto diferente do texto especificado. |
whenTextNotEqualToAny(texts) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com texto diferente de nenhum dos valores especificados. |
whenTextStartsWith(text) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com texto que comece com o texto especificado. |
withCriteria(criteria, args) | FilterCriteriaBuilder | Define os critérios de filtro como uma condição booleana definida por valores BooleanCriteria , como
CELL_EMPTY ou NUMBER_GREATER_THAN . |
FrequencyType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
FREQUENCY_TYPE_UNSUPPORTED | Enum | O tipo de frequência não é aceito. |
DAILY | Enum | Atualizar diariamente. |
WEEKLY | Enum | Atualizadas semanalmente em determinados dias da semana. |
MONTHLY | Enum | É atualizado mensalmente, em determinados dias do mês. |
GradientCondition
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getMaxColorObject() | Color | Recebe a cor definida para o valor máximo desta condição de gradiente. |
getMaxType() | InterpolationType | Recebe o tipo de interpolação para o valor máximo desta condição de gradiente. |
getMaxValue() | String | Recebe o valor máximo dessa condição de gradiente. |
getMidColorObject() | Color | Recebe a cor definida para o valor do ponto médio dessa condição de gradiente. |
getMidType() | InterpolationType | Recebe o tipo de interpolação para o valor do ponto médio dessa condição de gradiente. |
getMidValue() | String | Recebe o valor do ponto médio dessa condição do gradiente. |
getMinColorObject() | Color | Recebe a cor definida para o valor mínimo dessa condição de gradiente. |
getMinType() | InterpolationType | Recebe o tipo de interpolação para o valor mínimo dessa condição de gradiente. |
getMinValue() | String | Recebe o valor mínimo dessa condição de gradiente. |
Group
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
collapse() | Group | Recolhe este grupo. |
expand() | Group | Expande este grupo. |
getControlIndex() | Integer | Retorna o índice de alternância do controle desse grupo. |
getDepth() | Integer | Retorna a profundidade desse grupo. |
getRange() | Range | Retorna o intervalo no qual este grupo existe. |
isCollapsed() | Boolean | Retorna true se o grupo estiver recolhido. |
remove() | void | Remove esse grupo da página, reduzindo a profundidade do grupo do range em
um. |
GroupControlTogglePosition
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
BEFORE | Enum | A posição em que o controle de alternância está antes do grupo (em índices mais baixos). |
AFTER | Enum | A posição em que o controle de alternância está depois do grupo (em índices mais altos). |
InterpolationType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
NUMBER | Enum | Use o número como ponto de interpolação específico para uma condição de gradiente. |
PERCENT | Enum | Use o número como um ponto de interpolação percentual para uma condição de gradiente. |
PERCENTILE | Enum | Use o número como um ponto de interpolação de percentil para uma condição de gradiente. |
MIN | Enum | Infira o número mínimo como um ponto de interpolação específico para uma condição de gradiente. |
MAX | Enum | Infira o número máximo como um ponto de interpolação específico para uma condição de gradiente. |
NamedRange
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getName() | String | Recebe o nome desse intervalo nomeado. |
getRange() | Range | Recebe o intervalo referenciado por esse intervalo nomeado. |
remove() | void | Exclui esse intervalo nomeado. |
setName(name) | NamedRange | Define/atualiza o nome do intervalo nomeado. |
setRange(range) | NamedRange | Define/atualiza o intervalo para este intervalo nomeado. |
OverGridImage
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
assignScript(functionName) | OverGridImage | Atribui a função com o nome especificado à imagem. |
getAltTextDescription() | String | Retorna a descrição do texto alternativo para esta imagem. |
getAltTextTitle() | String | Retorna o título do texto alternativo para esta imagem. |
getAnchorCell() | Range | Retorna a célula em que uma imagem está ancorada. |
getAnchorCellXOffset() | Integer | Retorna o deslocamento de pixel horizontal da célula âncora. |
getAnchorCellYOffset() | Integer | Retorna o deslocamento de pixels verticais da célula âncora. |
getHeight() | Integer | Retorna a altura real desta imagem em pixels. |
getInherentHeight() | Integer | Retorna a altura inerente desta imagem em pixels. |
getInherentWidth() | Integer | Retorna a altura inerente desta imagem em pixels. |
getScript() | String | Retorna o nome da função atribuída a essa imagem. |
getSheet() | Sheet | Retorna a página em que a imagem aparece. |
getUrl() | String | Recebe o URL de origem da imagem. Retorna null se o URL não estiver disponível. |
getWidth() | Integer | Retorna a largura real dessa imagem em pixels. |
remove() | void | Exclui essa imagem da planilha. |
replace(blob) | OverGridImage | Substitui essa imagem pela especificada pelo BlobSource fornecido. |
replace(url) | OverGridImage | Substitui esta imagem pela do URL especificado. |
resetSize() | OverGridImage | Redefine a imagem com as dimensões inerentes. |
setAltTextDescription(description) | OverGridImage | Define a descrição do texto alternativo para a imagem. |
setAltTextTitle(title) | OverGridImage | Define o título do texto alternativo para a imagem. |
setAnchorCell(cell) | OverGridImage | Define a célula em que uma imagem está ancorada. |
setAnchorCellXOffset(offset) | OverGridImage | Define o deslocamento horizontal dos pixels a partir da célula âncora. |
setAnchorCellYOffset(offset) | OverGridImage | Define o deslocamento de pixels verticais a partir da célula âncora. |
setHeight(height) | OverGridImage | Define a altura real desta imagem em pixels. |
setWidth(width) | OverGridImage | Define a largura real dessa imagem em pixels. |
PageProtection
PivotFilter
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getFilterCriteria() | FilterCriteria | Retorna os critérios de filtro para este filtro dinâmico. |
getPivotTable() | PivotTable | Retorna o PivotTable ao qual esse filtro pertence. |
getSourceDataColumn() | Integer | Retorna o número da coluna de dados de origem em que esse filtro opera. |
getSourceDataSourceColumn() | DataSourceColumn | Retorna a coluna de fonte de dados em que o filtro opera. |
remove() | void | Remove esse filtro dinâmico da tabela dinâmica. |
setFilterCriteria(filterCriteria) | PivotFilter | Define os critérios de filtro para este filtro dinâmico. |
PivotGroup
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addManualGroupingRule(groupName, groupMembers) | PivotGroup | Adiciona uma regra de agrupamento manual a este grupo dinâmico. |
areLabelsRepeated() | Boolean | Retorna se os rótulos são exibidos como repetidos. |
clearGroupingRule() | PivotGroup | Remove todas as regras de agrupamento desse grupo dinâmico. |
clearSort() | PivotGroup | Remove qualquer classificação aplicada a este grupo. |
getDateTimeGroupingRule() | DateTimeGroupingRule | Retorna a regra de agrupamento de data-hora no grupo dinâmico ou null se nenhuma regra de agrupamento
de data-hora estiver definida. |
getDimension() | Dimension | Retorna indicando se é um grupo de linhas ou colunas. |
getGroupLimit() | PivotGroupLimit | Retorna o limite do grupo dinâmico. |
getIndex() | Integer | Retorna o índice do grupo dinâmico na ordem do grupo atual. |
getPivotTable() | PivotTable | Retorna o PivotTable ao qual este agrupamento pertence. |
getSourceDataColumn() | Integer | Retorna o número da coluna de dados de origem resumido por este grupo. |
getSourceDataSourceColumn() | DataSourceColumn | Retorna a coluna de fonte de dados em que o grupo dinâmico opera. |
hideRepeatedLabels() | PivotGroup | Oculta os rótulos repetidos deste agrupamento. |
isSortAscending() | Boolean | Retorna true se a classificação for crescente e false se a ordem for decrescente. |
moveToIndex(index) | PivotGroup | Move este grupo para a posição especificada na lista atual de grupos de linhas ou colunas. |
remove() | void | Remove este grupo dinâmico da tabela. |
removeManualGroupingRule(groupName) | PivotGroup | Remove a regra de agrupamento manual com o groupName especificado. |
resetDisplayName() | PivotGroup | Redefine o nome de exibição desse grupo na tabela dinâmica para o valor padrão. |
setDateTimeGroupingRule(dateTimeGroupingRuleType) | PivotGroup | Define a regra de agrupamento de data e hora no grupo dinâmico. |
setDisplayName(name) | PivotGroup | Define o nome de exibição desse grupo na tabela dinâmica. |
setGroupLimit(countLimit) | PivotGroup | Define o limite do grupo dinâmico. |
setHistogramGroupingRule(minValue, maxValue, intervalSize) | PivotGroup | Define uma regra de agrupamento por histograma para este grupo dinâmico. |
showRepeatedLabels() | PivotGroup | Quando há mais de uma linha ou agrupamento de colunas, esse método exibe o rótulo desse agrupamento para cada entrada do agrupamento seguinte. |
showTotals(showTotals) | PivotGroup | Define se os valores totais desse grupo dinâmico devem ser exibidos na tabela. |
sortAscending() | PivotGroup | Define a ordem de classificação para ser crescente. |
sortBy(value, oppositeGroupValues) | PivotGroup | Classifica este grupo pelo PivotValue especificado para os valores de oppositeGroupValues . |
sortDescending() | PivotGroup | Define a ordem de classificação para ser decrescente. |
totalsAreShown() | Boolean | Retorna se os valores totais são mostrados atualmente para este grupo dinâmico. |
PivotGroupLimit
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getCountLimit() | Integer | Recebe o limite de contagem em linhas ou colunas no grupo dinâmico. |
getPivotGroup() | PivotGroup | Retorna o grupo dinâmico a que o limite pertence. |
remove() | void | Remove o limite do grupo dinâmico. |
setCountLimit(countLimit) | PivotGroupLimit | Define o limite de contagem em linhas ou colunas no grupo dinâmico. |
PivotTable
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addCalculatedPivotValue(name, formula) | PivotValue | Cria um novo valor dinâmico na tabela dinâmica calculado a partir do formula especificado com o name especificado. |
addColumnGroup(sourceDataColumn) | PivotGroup | Define um novo agrupamento de colunas na tabela dinâmica. |
addFilter(sourceDataColumn, filterCriteria) | PivotFilter | Cria um novo filtro de tabela dinâmica para a tabela dinâmica. |
addPivotValue(sourceDataColumn, summarizeFunction) | PivotValue | Define um novo valor dinâmico na tabela dinâmica com o summarizeFunction especificado. |
addRowGroup(sourceDataColumn) | PivotGroup | Define um novo agrupamento de linhas dinâmicas na tabela dinâmica. |
asDataSourcePivotTable() | DataSourcePivotTable | Retornará a tabela dinâmica como tabela dinâmica de fonte de dados se estiver vinculada a uma DataSource . Caso contrário, retornará null . |
getAnchorCell() | Range | Retorna o Range que representa a célula em que essa tabela dinâmica está ancorada. |
getColumnGroups() | PivotGroup[] | Retorna uma lista ordenada dos grupos de colunas nesta tabela dinâmica. |
getFilters() | PivotFilter[] | Retorna uma lista ordenada dos filtros nesta tabela dinâmica. |
getPivotValues() | PivotValue[] | Retorna uma lista ordenada dos valores dinâmicos nesta tabela dinâmica. |
getRowGroups() | PivotGroup[] | Retorna uma lista ordenada dos grupos de linhas nesta tabela dinâmica. |
getSourceDataRange() | Range | Retorna o intervalo de dados de origem em que a tabela dinâmica é construída. |
getValuesDisplayOrientation() | Dimension | Retorna se os valores são exibidos como linhas ou colunas. |
remove() | void | Exclui esta tabela dinâmica. |
setValuesDisplayOrientation(dimension) | PivotTable | Define o layout dessa tabela dinâmica para exibir valores como colunas ou linhas. |
PivotTableSummarizeFunction
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
CUSTOM | Enum | Uma função personalizada. Esse valor só é válido para campos calculados. |
SUM | Enum | A função SUM |
COUNTA | Enum | A função CONT.VALORES |
COUNT | Enum | A função COUNT |
COUNTUNIQUE | Enum | A função COUNTUNIQUE |
AVERAGE | Enum | A função AVERAGE |
MAX | Enum | A função MAX |
MIN | Enum | A função MÍNIMO |
MEDIAN | Enum | A função MEDIAN |
PRODUCT | Enum | A função PRODUCT |
STDEV | Enum | A função DESVPAD |
STDEVP | Enum | A função DESVPADP |
VAR | Enum | A função VAR |
VARP | Enum | A função VARP |
PivotValue
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getDisplayType() | PivotValueDisplayType | Retorna o tipo de exibição que descreve como esse valor dinâmico é exibido na tabela. |
getFormula() | String | Retorna a fórmula usada para calcular esse valor. |
getPivotTable() | PivotTable | Retorna o PivotTable ao qual esse valor pertence. |
getSourceDataColumn() | Integer | Retorna o número da coluna de dados de origem resumido pelo valor dinâmico. |
getSourceDataSourceColumn() | DataSourceColumn | Retorna a coluna de fonte de dados resumida pelo valor dinâmico. |
getSummarizedBy() | PivotTableSummarizeFunction | Retorna a função de resumo desse grupo. |
remove() | void | Remova esse valor da tabela dinâmica. |
setDisplayName(name) | PivotValue | Define o nome de exibição desse valor na tabela dinâmica. |
setFormula(formula) | PivotValue | Define a fórmula usada para calcular esse valor. |
showAs(displayType) | PivotValue | Exibe esse valor na tabela dinâmica como uma função de outro valor. |
summarizeBy(summarizeFunction) | PivotValue | Define a função de resumo. |
PivotValueDisplayType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
DEFAULT | Enum | Padrão. |
PERCENT_OF_ROW_TOTAL | Enum | Exibe valores dinâmicos como uma porcentagem do total da linha. |
PERCENT_OF_COLUMN_TOTAL | Enum | Exibe valores dinâmicos como uma porcentagem do total da coluna. |
PERCENT_OF_GRAND_TOTAL | Enum | Exibe valores dinâmicos como uma porcentagem do total geral. |
Protection
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addEditor(emailAddress) | Protection | Adiciona o usuário fornecido à lista de editores da página ou do intervalo protegido. |
addEditor(user) | Protection | Adiciona o usuário fornecido à lista de editores da página ou do intervalo protegido. |
addEditors(emailAddresses) | Protection | Adiciona a matriz de usuários especificada à lista de editores da página ou do intervalo protegido. |
addTargetAudience(audienceId) | Protection | Adiciona o público-alvo especificado como um editor do intervalo protegido. |
canDomainEdit() | Boolean | Determina se todos os usuários no domínio proprietário da planilha têm permissão para editar o intervalo ou a página protegidos. |
canEdit() | Boolean | Determina se o usuário tem permissão para editar o intervalo ou a página protegidos. |
getDescription() | String | Recebe a descrição do intervalo ou página protegidos. |
getEditors() | User[] | Extrai a lista de editores do intervalo ou da página protegidos. |
getProtectionType() | ProtectionType | Recebe o tipo da área protegida, RANGE ou SHEET . |
getRange() | Range | Extrai o intervalo que está sendo protegido. |
getRangeName() | String | Recebe o nome do intervalo protegido se ele estiver associado a um intervalo nomeado. |
getTargetAudiences() | TargetAudience[] | Retorna os códigos dos públicos-alvo que podem editar o intervalo protegido. |
getUnprotectedRanges() | Range[] | Recebe uma matriz de intervalos desprotegidos dentro de uma página protegida. |
isWarningOnly() | Boolean | Determina se a área protegida está usando a proteção "baseada em avisos". |
remove() | void | Desprotege o intervalo ou a página. |
removeEditor(emailAddress) | Protection | Remove o usuário especificado da lista de editores da página ou do intervalo protegido. |
removeEditor(user) | Protection | Remove o usuário especificado da lista de editores da página ou do intervalo protegido. |
removeEditors(emailAddresses) | Protection | Remove a matriz de usuários especificada da lista de editores da página ou do intervalo protegido. |
removeTargetAudience(audienceId) | Protection | Remove o público-alvo especificado como um editor do intervalo protegido. |
setDescription(description) | Protection | Define a descrição do intervalo ou página protegidos. |
setDomainEdit(editable) | Protection | Define se todos os usuários no domínio proprietário da planilha têm permissão para editar o intervalo ou a página protegidos. |
setNamedRange(namedRange) | Protection | Associa o intervalo protegido a um intervalo nomeado já existente. |
setRange(range) | Protection | Ajusta o intervalo que está sendo protegido. |
setRangeName(rangeName) | Protection | Associa o intervalo protegido a um intervalo nomeado já existente. |
setUnprotectedRanges(ranges) | Protection | Desprotege a matriz de intervalos fornecida dentro de uma página protegida. |
setWarningOnly(warningOnly) | Protection | Define se este intervalo protegido usa ou não a proteção "baseada em avisos". |
ProtectionType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
RANGE | Enum | Proteção para um intervalo. |
SHEET | Enum | Proteção para uma página. |
Range
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
activate() | Range | Define o intervalo especificado como active range , com a célula
superior esquerda no intervalo como current cell . |
activateAsCurrentCell() | Range | Define a célula especificada como current cell . |
addDeveloperMetadata(key) | Range | Adiciona metadados de desenvolvedor com a chave especificada ao intervalo. |
addDeveloperMetadata(key, visibility) | Range | Adiciona metadados do desenvolvedor com a chave e a visibilidade especificadas ao intervalo. |
addDeveloperMetadata(key, value) | Range | Adiciona metadados do desenvolvedor com a chave e o valor especificados ao intervalo. |
addDeveloperMetadata(key, value, visibility) | Range | Adiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados ao intervalo. |
applyColumnBanding() | Banding | Aplica um tema de banda de coluna padrão ao intervalo. |
applyColumnBanding(bandingTheme) | Banding | Aplica um tema de faixa de coluna especificado ao intervalo. |
applyColumnBanding(bandingTheme, showHeader, showFooter) | Banding | Aplica um tema de faixa de coluna especificado ao intervalo com configurações específicas de cabeçalho e rodapé. |
applyRowBanding() | Banding | Aplica um tema de faixa de linhas padrão ao intervalo. |
applyRowBanding(bandingTheme) | Banding | Aplica um tema de faixa de linhas especificado ao intervalo. |
applyRowBanding(bandingTheme, showHeader, showFooter) | Banding | Aplica um tema de faixa de linhas especificado ao intervalo com configurações de cabeçalho e rodapé especificadas. |
autoFill(destination, series) | void | Preenche o destinationRange com dados baseados nos dados desse intervalo. |
autoFillToNeighbor(series) | void | Calcula um intervalo a ser preenchido com novos dados com base em células vizinhas e preenche automaticamente esse intervalo com novos valores com base nos dados contidos nesse intervalo. |
breakApart() | Range | Divida todas as células de várias colunas no intervalo em células individuais novamente. |
canEdit() | Boolean | Determina se o usuário tem permissão para editar cada célula no intervalo. |
check() | Range | Altera o estado das caixas de seleção no intervalo para "marcada". |
clear() | Range | Limpa o intervalo de conteúdo e formatos. |
clear(options) | Range | Limpa o intervalo de conteúdo, formato, regras de validação de dados e/ou comentários, conforme especificado com as opções avançadas fornecidas. |
clearContent() | Range | Limpa o conteúdo do intervalo, deixando a formatação intacta. |
clearDataValidations() | Range | Limpa as regras de validação de dados para o intervalo. |
clearFormat() | Range | Limpa a formatação deste intervalo. |
clearNote() | Range | Limpa a nota em uma ou mais células específicas. |
collapseGroups() | Range | Recolhe todos os grupos contidos totalmente no intervalo. |
copyFormatToRange(gridId, column, columnEnd, row, rowEnd) | void | Copie a formatação do intervalo para o local especificado. |
copyFormatToRange(sheet, column, columnEnd, row, rowEnd) | void | Copie a formatação do intervalo para o local especificado. |
copyTo(destination) | void | Copia os dados de um intervalo de células para outro intervalo de células. |
copyTo(destination, copyPasteType, transposed) | void | Copia os dados de um intervalo de células para outro intervalo de células. |
copyTo(destination, options) | void | Copia os dados de um intervalo de células para outro intervalo de células. |
copyValuesToRange(gridId, column, columnEnd, row, rowEnd) | void | Copie o conteúdo do intervalo para o local especificado. |
copyValuesToRange(sheet, column, columnEnd, row, rowEnd) | void | Copie o conteúdo do intervalo para o local especificado. |
createDataSourcePivotTable(dataSource) | DataSourcePivotTable | Cria uma tabela dinâmica de fonte de dados vazia a partir da fonte de dados, ancorada na primeira célula desse intervalo. |
createDataSourceTable(dataSource) | DataSourceTable | Cria uma tabela de fonte de dados vazia a partir da fonte de dados, ancorada na primeira célula desse intervalo. |
createDeveloperMetadataFinder() | DeveloperMetadataFinder | Retorna uma DeveloperMetadataFinderApi para encontrar metadados do desenvolvedor no escopo desse intervalo. |
createFilter() | Filter | Cria um filtro e o aplica ao intervalo especificado na página. |
createPivotTable(sourceData) | PivotTable | Cria uma tabela dinâmica vazia do sourceData especificado ancorado na primeira célula
desse intervalo. |
createTextFinder(findText) | TextFinder | Cria um localizador de texto para o intervalo, que pode localizar e substituir texto nesse intervalo. |
deleteCells(shiftDimension) | void | Exclui este intervalo de células. |
expandGroups() | Range | Expande os grupos recolhidos cujo intervalo ou controle de alternância cruza esse intervalo. |
getA1Notation() | String | Retorna uma descrição de string do intervalo, em notação A1. |
getBackground() | String | Retorna a cor de fundo da célula superior esquerda do intervalo (por exemplo, '#ffffff' ). |
getBackgroundObject() | Color | Retorna a cor de fundo da célula superior esquerda no intervalo. |
getBackgroundObjects() | Color[][] | Retorna as cores de fundo das células no intervalo. |
getBackgrounds() | String[][] | Retorna as cores de fundo das células no intervalo (por exemplo, '#ffffff' ). |
getBandings() | Banding[] | Retorna todas as faixas aplicadas a qualquer célula neste intervalo. |
getCell(row, column) | Range | Retorna uma determinada célula dentro de um intervalo. |
getColumn() | Integer | Retorna a posição inicial da coluna para esse intervalo. |
getDataRegion() | Range | Retorna uma cópia do intervalo expandido nos quatro Direction s cardeais para cobrir todas as células adjacentes com dados. |
getDataRegion(dimension) | Range | Retorna uma cópia do intervalo expandido Direction.UP e Direction.DOWN se a dimensão especificada for Dimension.ROWS ou Direction.NEXT e Direction.PREVIOUS se a dimensão for Dimension.COLUMNS . |
getDataSourceFormula() | DataSourceFormula | Retornará DataSourceFormula para a primeira célula no intervalo ou null se a célula não contiver uma fórmula de fonte de dados. |
getDataSourceFormulas() | DataSourceFormula[] | Retorna os DataSourceFormula s das células no intervalo. |
getDataSourcePivotTables() | DataSourcePivotTable[] | Recebe todas as tabelas dinâmicas da fonte de dados que cruzam com o intervalo. |
getDataSourceTables() | DataSourceTable[] | Extrai todas as tabelas de fonte de dados que cruzam com o intervalo. |
getDataSourceUrl() | String | Retorna um URL dos dados neste intervalo, que pode ser usado para criar gráficos e consultas. |
getDataTable() | DataTable | Retorne os dados dentro desse objeto como uma DataTable. |
getDataTable(firstRowIsHeader) | DataTable | Retorne os dados dentro desse intervalo como uma DataTable. |
getDataValidation() | DataValidation | Retorna a regra de validação de dados para a célula superior esquerda do intervalo. |
getDataValidations() | DataValidation[][] | Retorna as regras de validação de dados para todas as células no intervalo. |
getDeveloperMetadata() | DeveloperMetadata[] | Recebe os metadados do desenvolvedor associados a esse intervalo. |
getDisplayValue() | String | Retorna o valor exibido da célula superior esquerda do intervalo. |
getDisplayValues() | String[][] | Retorna a grade retangular de valores para este intervalo. |
getFilter() | Filter | Retorna o filtro na página a que o intervalo pertence ou null se não houver filtro na página. |
getFontColorObject() | Color | Retorna a cor da fonte da célula no canto superior esquerdo do intervalo. |
getFontColorObjects() | Color[][] | Retorna as cores da fonte das células no intervalo. |
getFontFamilies() | String[][] | Retorna as famílias de fontes das células no intervalo. |
getFontFamily() | String | Retorna a família de fontes da célula no canto superior esquerdo do intervalo. |
getFontLine() | String | Recebe o estilo de linha da célula no canto superior esquerdo do intervalo ('underline' ,
'line-through' ou 'none' ). |
getFontLines() | String[][] | Recebe o estilo da linha das células no intervalo ('underline' , 'line-through' ou 'none' ). |
getFontSize() | Integer | Retorna o tamanho da fonte em tamanho de ponto da célula no canto superior esquerdo do intervalo. |
getFontSizes() | Integer[][] | Retorna os tamanhos das fontes das células no intervalo. |
getFontStyle() | String | Retorna o estilo da fonte ('italic' ou 'normal' ) da célula no canto superior esquerdo
do intervalo. |
getFontStyles() | String[][] | Retorna os estilos de fonte das células no intervalo. |
getFontWeight() | String | Retorna a espessura da fonte (normal/negrito) da célula no canto superior esquerdo do intervalo. |
getFontWeights() | String[][] | Retorna as espessuras de fonte das células no intervalo. |
getFormula() | String | Retorna a fórmula (notação A1) para a célula superior esquerda do intervalo ou uma string vazia se a célula estiver vazia ou não contiver uma fórmula. |
getFormulaR1C1() | String | Retorna a fórmula (notação R1C1) de uma determinada célula ou null se nenhuma. |
getFormulas() | String[][] | Retorna as fórmulas (notação A1) das células no intervalo. |
getFormulasR1C1() | String[][] | Retorna as fórmulas (notação R1C1) das células no intervalo. |
getGridId() | Integer | Retorna o ID da grade da página pai do intervalo. |
getHeight() | Integer | Retorna a altura do intervalo. |
getHorizontalAlignment() | String | Retorna o alinhamento horizontal do texto (esquerda/centrado/direita) da célula no canto superior esquerdo do intervalo. |
getHorizontalAlignments() | String[][] | Retorna os alinhamentos horizontais das células no intervalo. |
getLastColumn() | Integer | Retorna a posição da coluna final. |
getLastRow() | Integer | Retorna a posição da linha final. |
getMergedRanges() | Range[] | Retorna uma matriz de objetos Range que representam células mescladas que estão totalmente dentro do intervalo atual ou contêm pelo menos uma célula no intervalo atual. |
getNextDataCell(direction) | Range | Começando na célula na primeira coluna e linha do intervalo, retorna a próxima célula na direção determinada, que é a borda de um intervalo contíguo de células com dados ou a célula na borda da planilha naquela direção. |
getNote() | String | Retorna a nota associada ao intervalo especificado. |
getNotes() | String[][] | Retorna as notas associadas às células no intervalo. |
getNumColumns() | Integer | Retorna o número de colunas nesse intervalo. |
getNumRows() | Integer | Retorna o número de linhas neste intervalo. |
getNumberFormat() | String | Define a formatação de número ou data da célula superior esquerda de determinado intervalo. |
getNumberFormats() | String[][] | Retorna os formatos de número ou data das células no intervalo. |
getRichTextValue() | RichTextValue | Retorna o valor de rich text da célula superior esquerda do intervalo ou null se o valor da célula não for texto. |
getRichTextValues() | RichTextValue[][] | Retorna os valores de rich text das células no intervalo. |
getRow() | Integer | Retorna a posição da linha para esse intervalo. |
getRowIndex() | Integer | Retorna a posição da linha para esse intervalo. |
getSheet() | Sheet | Retorna a página a que o intervalo pertence. |
getTextDirection() | TextDirection | Retorna a direção do texto para a célula superior esquerda do intervalo. |
getTextDirections() | TextDirection[][] | Retorna as direções do texto das células no intervalo. |
getTextRotation() | TextRotation | Retorna as configurações de rotação de texto para a célula superior esquerda do intervalo. |
getTextRotations() | TextRotation[][] | Retorna as configurações de rotação do texto para as células no intervalo. |
getTextStyle() | TextStyle | Retorna o estilo de texto da célula superior esquerda do intervalo. |
getTextStyles() | TextStyle[][] | Retorna os estilos de texto das células no intervalo. |
getValue() | Object | Retorna o valor da célula superior esquerda do intervalo. |
getValues() | Object[][] | Retorna a grade retangular de valores para este intervalo. |
getVerticalAlignment() | String | Retorna o alinhamento vertical (superior/meio/inferior) da célula no canto superior esquerdo do intervalo. |
getVerticalAlignments() | String[][] | Retorna os alinhamentos verticais das células no intervalo. |
getWidth() | Integer | Retorna a largura do intervalo em colunas. |
getWrap() | Boolean | Retorna se o texto na célula é agrupado. |
getWrapStrategies() | WrapStrategy[][] | Retorna as estratégias de ajuste de texto para as células no intervalo. |
getWrapStrategy() | WrapStrategy | Retorna a estratégia de ajuste de texto da célula superior esquerda do intervalo. |
getWraps() | Boolean[][] | Retorna se o texto nas células é ajustado. |
insertCells(shiftDimension) | Range | Insere células vazias neste intervalo. |
insertCheckboxes() | Range | Insere caixas de seleção em cada célula do intervalo, configuradas com true para marcada e
false para desmarcada. |
insertCheckboxes(checkedValue) | Range | Insere caixas de seleção em cada célula do intervalo, configuradas com um valor personalizado para marcado e a string vazia para desmarcada. |
insertCheckboxes(checkedValue, uncheckedValue) | Range | Insere caixas de seleção em cada célula do intervalo, configuradas com valores personalizados para os estados marcado e desmarcado. |
isBlank() | Boolean | Retorna true se o intervalo estiver totalmente em branco. |
isChecked() | Boolean | Retorna se todas as células no intervalo têm seu estado de caixa de seleção como "marcada". |
isEndColumnBounded() | Boolean | Determina se o fim do intervalo está vinculado a uma coluna específica. |
isEndRowBounded() | Boolean | Determina se o fim do intervalo está vinculado a uma linha específica. |
isPartOfMerge() | Boolean | Retornará true se as células no intervalo atual se sobrepuserem a qualquer célula mesclada. |
isStartColumnBounded() | Boolean | Determina se o início do intervalo está vinculado a uma coluna específica. |
isStartRowBounded() | Boolean | Determina se o início do intervalo está vinculado a uma linha específica. |
merge() | Range | Mescla as células do intervalo em um único bloco. |
mergeAcross() | Range | Mescle as células do intervalo de acordo com as colunas dele. |
mergeVertically() | Range | Mescla as células no intervalo. |
moveTo(target) | void | Recorte e cole (formatar e valores) deste intervalo para o intervalo de destino. |
offset(rowOffset, columnOffset) | Range | Retorna um novo intervalo que é deslocado desse intervalo pelo número fornecido de linhas e colunas (que pode ser negativo). |
offset(rowOffset, columnOffset, numRows) | Range | Retorna um novo intervalo relativo ao intervalo atual, cujo ponto superior esquerdo é deslocado do intervalo atual pelas linhas e colunas fornecidas e com a altura especificada nas células. |
offset(rowOffset, columnOffset, numRows, numColumns) | Range | Retorna um novo intervalo relativo ao intervalo atual, cujo ponto superior esquerdo é deslocado do intervalo atual pelas linhas e colunas fornecidas e com a altura e largura indicadas nas células. |
protect() | Protection | Cria um objeto que pode proteger o intervalo de ser editado, exceto por usuários que tenham permissão. |
randomize() | Range | Randomiza a ordem das linhas no intervalo fornecido. |
removeCheckboxes() | Range | Remove todas as caixas de seleção do intervalo. |
removeDuplicates() | Range | Remove as linhas dentro desse intervalo que contêm valores duplicados de valores em qualquer linha anterior. |
removeDuplicates(columnsToCompare) | Range | Remove as linhas dentro desse intervalo que contêm valores nas colunas especificadas que são cópias de valores de qualquer linha anterior. |
setBackground(color) | Range | Define a cor do plano de fundo de todas as células no intervalo na notação CSS (como '#ffffff'
ou 'white' ). |
setBackgroundObject(color) | Range | Define a cor de fundo de todas as células no intervalo. |
setBackgroundObjects(color) | Range | Define uma grade retangular de cores de fundo (deve corresponder às dimensões deste intervalo). |
setBackgroundRGB(red, green, blue) | Range | Define o plano de fundo com a cor especificada usando valores RGB (números inteiros entre 0 e 255). |
setBackgrounds(color) | Range | Define uma grade retangular de cores de fundo (deve corresponder às dimensões deste intervalo). |
setBorder(top, left, bottom, right, vertical, horizontal) | Range | Define a propriedade da borda. |
setBorder(top, left, bottom, right, vertical, horizontal, color, style) | Range | Define a propriedade da borda com cor e/ou estilo. |
setDataValidation(rule) | Range | Define uma regra de validação de dados para todas as células no intervalo. |
setDataValidations(rules) | Range | Define as regras de validação de dados para todas as células no intervalo. |
setFontColor(color) | Range | Define a cor da fonte na notação CSS (como '#ffffff' ou 'white' ). |
setFontColorObject(color) | Range | Define a cor da fonte do intervalo especificado. |
setFontColorObjects(colors) | Range | Define uma grade retangular de cores de fonte (deve corresponder às dimensões deste intervalo). |
setFontColors(colors) | Range | Define uma grade retangular de cores de fonte (deve corresponder às dimensões deste intervalo). |
setFontFamilies(fontFamilies) | Range | Define uma grade retangular de famílias de fontes (deve corresponder às dimensões desse intervalo). |
setFontFamily(fontFamily) | Range | Define a família de fontes, como "Arial" ou "Helvetica". |
setFontLine(fontLine) | Range | Define o estilo da linha de fonte do intervalo especificado ('underline' , 'line-through' ou
'none' ). |
setFontLines(fontLines) | Range | Define uma grade retangular de estilos de linha (deve corresponder às dimensões deste intervalo). |
setFontSize(size) | Range | Define o tamanho da fonte, sendo o tamanho o tamanho do ponto a ser usado. |
setFontSizes(sizes) | Range | Define uma grade retangular de tamanhos de fonte (deve corresponder às dimensões desse intervalo). |
setFontStyle(fontStyle) | Range | Define o estilo da fonte do intervalo especificado ('italic' ou 'normal' ). |
setFontStyles(fontStyles) | Range | Define uma grade retangular de estilos de fonte (deve corresponder às dimensões desse intervalo). |
setFontWeight(fontWeight) | Range | Define a espessura da fonte para o intervalo fornecido (normal/negrito). |
setFontWeights(fontWeights) | Range | Define uma grade retangular de espessuras de fonte (deve corresponder às dimensões deste intervalo). |
setFormula(formula) | Range | Atualiza a fórmula para esse intervalo. |
setFormulaR1C1(formula) | Range | Atualiza a fórmula para esse intervalo. |
setFormulas(formulas) | Range | Define uma grade retangular de fórmulas (precisa corresponder às dimensões deste intervalo). |
setFormulasR1C1(formulas) | Range | Define uma grade retangular de fórmulas (precisa corresponder às dimensões deste intervalo). |
setHorizontalAlignment(alignment) | Range | Define o alinhamento horizontal (da esquerda para a direita) para o intervalo especificado (esquerda/central/direita). |
setHorizontalAlignments(alignments) | Range | Define uma grade retangular de alinhamentos horizontais. |
setNote(note) | Range | Define a nota para o valor fornecido. |
setNotes(notes) | Range | Define uma grade retangular de notas (deve corresponder às dimensões deste intervalo). |
setNumberFormat(numberFormat) | Range | Define o formato de número ou data para a string de formatação especificada. |
setNumberFormats(numberFormats) | Range | Define uma grade retangular de formatos de número ou data (deve corresponder às dimensões desse intervalo). |
setRichTextValue(value) | Range | Define o valor de rich text para as células no intervalo. |
setRichTextValues(values) | Range | Define uma grade retangular de valores de Rich Text. |
setShowHyperlink(showHyperlink) | Range | Define se o intervalo deve ou não exibir hiperlinks. |
setTextDirection(direction) | Range | Define a direção do texto das células no intervalo. |
setTextDirections(directions) | Range | Define uma grade retangular de direções de texto. |
setTextRotation(degrees) | Range | Define as configurações de rotação do texto para as células no intervalo. |
setTextRotation(rotation) | Range | Define as configurações de rotação do texto para as células no intervalo. |
setTextRotations(rotations) | Range | Define uma grade retangular de rotações do texto. |
setTextStyle(style) | Range | Define o estilo de texto das células no intervalo. |
setTextStyles(styles) | Range | Define uma grade retangular de estilos de texto. |
setValue(value) | Range | Define o valor do intervalo. |
setValues(values) | Range | Define uma grade retangular de valores (precisa corresponder às dimensões deste intervalo). |
setVerticalAlignment(alignment) | Range | Define o alinhamento vertical (de cima para baixo) no intervalo especificado (superior/meio/inferior). |
setVerticalAlignments(alignments) | Range | Define uma grade retangular de alinhamentos verticais (deve corresponder às dimensões deste intervalo). |
setVerticalText(isVertical) | Range | Define se o texto será empilhado para as células no intervalo. |
setWrap(isWrapEnabled) | Range | Define a quebra de célula do intervalo especificado. |
setWrapStrategies(strategies) | Range | Define uma grade retangular de estratégias de agrupamento. |
setWrapStrategy(strategy) | Range | Define a estratégia de ajuste de texto para as células no intervalo. |
setWraps(isWrapEnabled) | Range | Define uma grade retangular de políticas de quebra de palavra (deve corresponder às dimensões desse intervalo). |
shiftColumnGroupDepth(delta) | Range | Altera a profundidade do agrupamento de colunas do intervalo pelo valor especificado. |
shiftRowGroupDepth(delta) | Range | Altera a profundidade do agrupamento de linhas do intervalo pelo valor especificado. |
sort(sortSpecObj) | Range | Classifica as células de um intervalo específico, por coluna e ordem especificada. |
splitTextToColumns() | void | Divide uma coluna de texto em várias colunas com base em um delimitador detectado automaticamente. |
splitTextToColumns(delimiter) | void | Divide uma coluna de texto em várias colunas usando a string especificada como um delimitador personalizado. |
splitTextToColumns(delimiter) | void | Divide uma coluna de texto em várias colunas com base no delimitador especificado. |
trimWhitespace() | Range | Corta o espaço em branco (como espaços, tabulações ou novas linhas) em todas as células neste intervalo. |
uncheck() | Range | Altera o estado das caixas de seleção no intervalo para "desmarcada". |
RangeList
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
activate() | RangeList | Seleciona a lista de instâncias de Range . |
breakApart() | RangeList | Divida todas as células mescladas na horizontal ou vertical contidas na lista de intervalos em células individuais novamente. |
check() | RangeList | Altera o estado das caixas de seleção no intervalo para "marcada". |
clear() | RangeList | Limpa o intervalo de conteúdos, formatos e regras de validação de dados para cada Range na
lista de intervalos. |
clear(options) | RangeList | Limpa o intervalo de conteúdo, formato, regras de validação de dados e comentários, conforme especificado com as opções fornecidas. |
clearContent() | RangeList | Limpa o conteúdo de cada Range na lista de intervalos, deixando a formatação intacta. |
clearDataValidations() | RangeList | Limpa as regras de validação de dados para cada Range na lista de intervalos. |
clearFormat() | RangeList | Limpa a formatação do texto para cada Range na lista de intervalos. |
clearNote() | RangeList | Limpa a nota para cada Range na lista de intervalos. |
getRanges() | Range[] | Retorna uma lista de uma ou mais instâncias de Range na mesma página. |
insertCheckboxes() | RangeList | Insere caixas de seleção em cada célula do intervalo, configuradas com true para marcada e
false para desmarcada. |
insertCheckboxes(checkedValue) | RangeList | Insere caixas de seleção em cada célula do intervalo, configuradas com um valor personalizado para marcado e a string vazia para desmarcada. |
insertCheckboxes(checkedValue, uncheckedValue) | RangeList | Insere caixas de seleção em cada célula do intervalo, configuradas com valores personalizados para os estados marcado e desmarcado. |
removeCheckboxes() | RangeList | Remove todas as caixas de seleção do intervalo. |
setBackground(color) | RangeList | Define a cor do plano de fundo para cada Range na lista de intervalos. |
setBackgroundRGB(red, green, blue) | RangeList | Define o plano de fundo para a cor RGB especificada. |
setBorder(top, left, bottom, right, vertical, horizontal) | RangeList | Define a propriedade de borda para cada Range na lista de intervalos. |
setBorder(top, left, bottom, right, vertical, horizontal, color, style) | RangeList | Define a propriedade da borda com cor e/ou estilo para cada Range na lista de intervalos. |
setFontColor(color) | RangeList | Define a cor da fonte de cada Range na lista de intervalos. |
setFontFamily(fontFamily) | RangeList | Define a família de fontes de cada Range na lista de intervalos. |
setFontLine(fontLine) | RangeList | Define o estilo da linha da fonte de cada Range na lista de intervalos. |
setFontSize(size) | RangeList | Define o tamanho da fonte (em pontos) para cada Range na lista de intervalos. |
setFontStyle(fontStyle) | RangeList | Defina o estilo da fonte de cada Range na lista de intervalos. |
setFontWeight(fontWeight) | RangeList | Defina a espessura da fonte para cada Range na lista de intervalos. |
setFormula(formula) | RangeList | Atualiza a fórmula para cada Range na lista de intervalos. |
setFormulaR1C1(formula) | RangeList | Atualiza a fórmula para cada Range na lista de intervalos. |
setHorizontalAlignment(alignment) | RangeList | Defina o alinhamento horizontal de cada Range na lista de intervalos. |
setNote(note) | RangeList | Define o texto da nota para cada Range na lista de intervalos. |
setNumberFormat(numberFormat) | RangeList | Define o formato de número ou data de cada Range na lista de intervalos. |
setShowHyperlink(showHyperlink) | RangeList | Define se cada Range na lista de intervalos deve mostrar hiperlinks ou não. |
setTextDirection(direction) | RangeList | Define a direção do texto para as células em cada Range na lista de intervalos. |
setTextRotation(degrees) | RangeList | Define as configurações de rotação do texto para as células em cada Range na lista de intervalos. |
setValue(value) | RangeList | Define o valor de cada Range na lista de intervalos. |
setVerticalAlignment(alignment) | RangeList | Defina o alinhamento vertical de cada Range na lista de intervalos. |
setVerticalText(isVertical) | RangeList | Define se o texto das células será empilhado para cada Range na lista
de intervalos. |
setWrap(isWrapEnabled) | RangeList | Defina o ajuste de texto para cada Range na lista de intervalos. |
setWrapStrategy(strategy) | RangeList | Define a estratégia de ajuste de texto para cada Range na lista de intervalos. |
trimWhitespace() | RangeList | Corta o espaço em branco (como espaços, tabulações ou novas linhas) em todas as células na lista de intervalos. |
uncheck() | RangeList | Altera o estado das caixas de seleção no intervalo para "desmarcada". |
RecalculationInterval
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
ON_CHANGE | Enum | Recalcular somente quando os valores forem alterados. |
MINUTE | Enum | Recalcule quando os valores são alterados e a cada minuto. |
HOUR | Enum | Recalcule quando os valores são alterados e a cada hora. |
RelativeDate
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
TODAY | Enum | Datas comparadas com a data atual |
TOMORROW | Enum | Datas comparadas com a data atual. |
YESTERDAY | Enum | Datas comparadas com a data anterior à atual. |
PAST_WEEK | Enum | Datas dentro do período da última semana. |
PAST_MONTH | Enum | Datas que se enquadrem no período do mês anterior. |
PAST_YEAR | Enum | Datas que se enquadrem no período do último ano. |
RichTextValue
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | RichTextValueBuilder | Retorna um builder para um valor de Rich Text inicializado com os valores desse valor de Rich Text. |
getEndIndex() | Integer | Extrai o índice final desse valor na célula. |
getLinkUrl() | String | Retorna o URL do link para esse valor. |
getLinkUrl(startOffset, endOffset) | String | Retorna o URL do link do texto de startOffset para endOffset . |
getRuns() | RichTextValue[] | Retorna a string Rich Text dividida em uma matriz de execuções, em que cada execução é a substring mais longa possível com um estilo de texto consistente. |
getStartIndex() | Integer | Extrai o índice inicial desse valor na célula. |
getText() | String | Retorna o texto desse valor. |
getTextStyle() | TextStyle | Retorna o estilo de texto desse valor. |
getTextStyle(startOffset, endOffset) | TextStyle | Retorna o estilo do texto de startOffset para endOffset . |
RichTextValueBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
build() | RichTextValue | Cria um valor de rich text a partir desse builder. |
setLinkUrl(startOffset, endOffset, linkUrl) | RichTextValueBuilder | Define o URL do link para a substring especificada desse valor ou o limpa se linkUrl for
null . |
setLinkUrl(linkUrl) | RichTextValueBuilder | Define o URL do link para o valor inteiro ou o limpa se linkUrl for null . |
setText(text) | RichTextValueBuilder | Define o texto para esse valor e limpa qualquer estilo de texto existente. |
setTextStyle(startOffset, endOffset, textStyle) | RichTextValueBuilder | Aplica um estilo de texto à substring especificada desse valor. |
setTextStyle(textStyle) | RichTextValueBuilder | Aplica um estilo de texto ao valor inteiro. |
Selection
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getActiveRange() | Range | Retorna o intervalo selecionado na página ativa ou null se não houver um intervalo ativo. |
getActiveRangeList() | RangeList | Retorna a lista de intervalos ativos na página ativa ou null se não houver intervalos ativos. |
getActiveSheet() | Sheet | Retorna a página ativa na planilha. |
getCurrentCell() | Range | Retorna a célula atual (destacada) selecionada em um dos intervalos ativos ou null se não houver célula atual. |
getNextDataRange(direction) | Range | A partir de current cell e active range
e movendo na direção indicada, retorna um intervalo ajustado em que a borda adequada do
intervalo foi deslocada para cobrir o next data cell enquanto ainda
cobre a célula atual. |
Sheet
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
activate() | Sheet | Ativa esta página. |
addDeveloperMetadata(key) | Sheet | Adiciona à planilha metadados do desenvolvedor com a chave especificada. |
addDeveloperMetadata(key, visibility) | Sheet | Adiciona metadados do desenvolvedor com a chave e a visibilidade especificadas à planilha. |
addDeveloperMetadata(key, value) | Sheet | Adiciona à planilha metadados do desenvolvedor com a chave e o valor especificados. |
addDeveloperMetadata(key, value, visibility) | Sheet | Adiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados à planilha. |
appendRow(rowContents) | Sheet | Anexa uma linha na parte inferior da região de dados atual na planilha. |
asDataSourceSheet() | DataSourceSheet | Retornará a página como DataSourceSheet se ela for do tipo SheetType.DATASOURCE . Caso contrário, retornará null . |
autoResizeColumn(columnPosition) | Sheet | Define a largura da coluna especificada para ajustar o conteúdo dela. |
autoResizeColumns(startColumn, numColumns) | Sheet | Define a largura de todas as colunas começando na posição especificada para ajustar o conteúdo delas. |
autoResizeRows(startRow, numRows) | Sheet | Define a altura de todas as linhas começando na posição determinada para ajustar o conteúdo. |
clear() | Sheet | Limpa a página de conteúdo e informações de formatação. |
clear(options) | Sheet | Limpa a página de conteúdo e/ou formato, conforme especificado com as opções avançadas fornecidas. |
clearConditionalFormatRules() | void | Remove todas as regras de formatação condicional da página. |
clearContents() | Sheet | Limpa a página de conteúdo, preservando as informações de formatação. |
clearFormats() | Sheet | Limpa a página de formatação, preservando o conteúdo. |
clearNotes() | Sheet | Limpa a página com todas as notas. |
collapseAllColumnGroups() | Sheet | Recolhe todos os grupos de colunas na página. |
collapseAllRowGroups() | Sheet | Recolhe todos os grupos de linhas na página. |
copyTo(spreadsheet) | Sheet | Copia a folha para uma determinada planilha, que pode ser a mesma que a fonte. |
createDeveloperMetadataFinder() | DeveloperMetadataFinder | Retorna um DeveloperMetadataFinder para encontrar metadados do desenvolvedor no escopo dessa planilha. |
createTextFinder(findText) | TextFinder | Cria um localizador de texto para a página, que pode encontrar e substituir texto nela. |
deleteColumn(columnPosition) | Sheet | Exclui a coluna na posição de coluna especificada. |
deleteColumns(columnPosition, howMany) | void | Exclui várias colunas começando na posição especificada. |
deleteRow(rowPosition) | Sheet | Exclui a linha na posição de linha especificada. |
deleteRows(rowPosition, howMany) | void | Exclui um número de linhas começando na posição de linha especificada. |
expandAllColumnGroups() | Sheet | Expande todos os grupos de colunas na página. |
expandAllRowGroups() | Sheet | Expande todos os grupos de linhas na página. |
expandColumnGroupsUpToDepth(groupDepth) | Sheet | Expande todos os grupos de colunas até a profundidade especificada e recolhe todas as outras. |
expandRowGroupsUpToDepth(groupDepth) | Sheet | Expande todos os grupos de linhas até a profundidade especificada e recolhe todos os outros. |
getActiveCell() | Range | Retorna a célula ativa nesta planilha. |
getActiveRange() | Range | Retorna o intervalo selecionado na página ativa ou null se não houver um intervalo ativo. |
getActiveRangeList() | RangeList | Retorna a lista de intervalos ativos na página ativa ou null se não houver intervalos ativos. |
getBandings() | Banding[] | Retorna todas as faixas nesta planilha. |
getCharts() | EmbeddedChart[] | Retorna uma matriz de gráficos nessa página. |
getColumnGroup(columnIndex, groupDepth) | Group | Retorna o grupo de colunas no índice e na profundidade do grupo especificados. |
getColumnGroupControlPosition() | GroupControlTogglePosition | Retorna o GroupControlTogglePosition de todos os grupos de colunas na página. |
getColumnGroupDepth(columnIndex) | Integer | Retorna a profundidade do grupo da coluna no índice especificado. |
getColumnWidth(columnPosition) | Integer | Recebe a largura em pixels da coluna especificada. |
getConditionalFormatRules() | ConditionalFormatRule[] | Acessar todas as regras de formatação condicional nesta página. |
getCurrentCell() | Range | Retorna a célula atual na página ativa ou null se não houver célula atual. |
getDataRange() | Range | Retorna um Range correspondente às dimensões em que os dados estão presentes. |
getDataSourceFormulas() | DataSourceFormula[] | Extrai todas as fórmulas da fonte de dados. |
getDataSourcePivotTables() | DataSourcePivotTable[] | Extrai todas as tabelas dinâmicas da fonte de dados. |
getDataSourceTables() | DataSourceTable[] | Extrai todas as tabelas da fonte de dados. |
getDeveloperMetadata() | DeveloperMetadata[] | Receba todos os metadados do desenvolvedor associados a esta planilha. |
getDrawings() | Drawing[] | Retorna uma matriz de desenhos na folha. |
getFilter() | Filter | Retorna o filtro nesta página ou null se não houver filtro. |
getFormUrl() | String | Retorna o URL do formulário que envia as respostas para essa planilha ou null se a página não tiver um formulário associado. |
getFrozenColumns() | Integer | Retorna o número de colunas congeladas. |
getFrozenRows() | Integer | Retorna o número de linhas congeladas. |
getImages() | OverGridImage[] | Retorna todas as imagens sobre a grade na página. |
getIndex() | Integer | Extrai a posição da página na planilha principal. |
getLastColumn() | Integer | Retorna a posição da última coluna que possui conteúdo. |
getLastRow() | Integer | Retorna a posição da última linha que possui conteúdo. |
getMaxColumns() | Integer | Retorna o número atual de colunas na página, independentemente do conteúdo. |
getMaxRows() | Integer | Retorna o número atual de linhas na planilha, independentemente do conteúdo. |
getName() | String | Retorna o nome da planilha. |
getNamedRanges() | NamedRange[] | Recebe todos os intervalos nomeados nesta página. |
getParent() | Spreadsheet | Retorna o Spreadsheet que contém essa planilha. |
getPivotTables() | PivotTable[] | Retorna todas as tabelas dinâmicas desta página. |
getProtections(type) | Protection[] | Recebe uma matriz de objetos que representam todos os intervalos protegidos na página ou uma matriz de elemento único que representa a proteção na própria página. |
getRange(row, column) | Range | Retorna o intervalo com a célula superior esquerda nas coordenadas fornecidas. |
getRange(row, column, numRows) | Range | Retorna o intervalo com a célula superior esquerda nas coordenadas especificadas e com o número de linhas especificado. |
getRange(row, column, numRows, numColumns) | Range | Retorna o intervalo com a célula superior esquerda nas coordenadas indicadas com o número especificado de linhas e colunas. |
getRange(a1Notation) | Range | Retorna o intervalo especificado na notação A1 ou R1C1. |
getRangeList(a1Notations) | RangeList | Retorna a coleção RangeList que representa os intervalos na mesma página especificada
por uma lista não vazia de notações A1 ou R1C1. |
getRowGroup(rowIndex, groupDepth) | Group | Retorna o grupo de linhas no índice e na profundidade do grupo fornecidos. |
getRowGroupControlPosition() | GroupControlTogglePosition | Retorna o GroupControlTogglePosition de todos os grupos de linhas na página. |
getRowGroupDepth(rowIndex) | Integer | Retorna a profundidade do grupo da linha no índice especificado. |
getRowHeight(rowPosition) | Integer | Recebe a altura em pixels da linha especificada. |
getSelection() | Selection | Retorna o Selection atual na planilha. |
getSheetId() | Integer | Retorna o ID da página representada por esse objeto. |
getSheetName() | String | Retorna o nome da planilha. |
getSheetValues(startRow, startColumn, numRows, numColumns) | Object[][] | Retorna a grade retangular de valores para este intervalo começando nas coordenadas fornecidas. |
getSlicers() | Slicer[] | Retorna uma matriz de controles de filtros na página. |
getTabColorObject() | Color | Recebe a cor da guia da página ou null se ela não tiver cor. |
getType() | SheetType | Retorna o tipo da planilha. |
hasHiddenGridlines() | Boolean | Retorna true se as linhas de grade da página estiverem ocultas. Caso contrário, retorna false . |
hideColumn(column) | void | Oculta colunas no intervalo especificado. |
hideColumns(columnIndex) | void | Oculta uma única coluna no índice especificado. |
hideColumns(columnIndex, numColumns) | void | Oculta uma ou mais colunas consecutivas a partir do índice especificado. |
hideRow(row) | void | Oculta as linhas no intervalo especificado. |
hideRows(rowIndex) | void | Oculta a linha no índice especificado. |
hideRows(rowIndex, numRows) | void | Oculta uma ou mais linhas consecutivas a partir do índice especificado. |
hideSheet() | Sheet | Oculta esta página. |
insertChart(chart) | void | Adiciona um novo gráfico à página. |
insertColumnAfter(afterPosition) | Sheet | Insere uma coluna após a posição de coluna especificada. |
insertColumnBefore(beforePosition) | Sheet | Insere uma coluna antes da posição da coluna especificada. |
insertColumns(columnIndex) | void | Insere uma coluna em branco em uma página no local especificado. |
insertColumns(columnIndex, numColumns) | void | Insere uma ou mais colunas em branco consecutivas em uma página, começando no local especificado. |
insertColumnsAfter(afterPosition, howMany) | Sheet | Insere um determinado número de colunas após a posição especificada. |
insertColumnsBefore(beforePosition, howMany) | Sheet | Insere várias colunas antes da posição especificada. |
insertImage(blobSource, column, row) | OverGridImage | Insere um BlobSource como uma imagem no documento em uma determinada linha e coluna. |
insertImage(blobSource, column, row, offsetX, offsetY) | OverGridImage | Insere um BlobSource como uma imagem no documento em uma determinada linha e coluna, com um
deslocamento de pixels. |
insertImage(url, column, row) | OverGridImage | Insere uma imagem no documento em uma determinada linha e coluna. |
insertImage(url, column, row, offsetX, offsetY) | OverGridImage | Insere uma imagem no documento em uma determinada linha e coluna, com um deslocamento de pixels. |
insertRowAfter(afterPosition) | Sheet | Insere uma linha após a posição da linha especificada. |
insertRowBefore(beforePosition) | Sheet | Insere uma linha antes da posição da linha especificada. |
insertRows(rowIndex) | void | Insere uma linha em branco em uma página no local especificado. |
insertRows(rowIndex, numRows) | void | Insere uma ou mais linhas em branco consecutivas em uma página, começando no local especificado. |
insertRowsAfter(afterPosition, howMany) | Sheet | Insere um número de linhas após a posição da linha especificada. |
insertRowsBefore(beforePosition, howMany) | Sheet | Insere um número de linhas antes da posição da linha especificada. |
insertSlicer(range, anchorRowPos, anchorColPos) | Slicer | Adiciona um novo controle de filtros à página. |
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY) | Slicer | Adiciona um novo controle de filtros à página. |
isColumnHiddenByUser(columnPosition) | Boolean | Retorna se a coluna especificada está oculta pelo usuário. |
isRightToLeft() | Boolean | Retorna true se esse layout de página for da direita para a esquerda. |
isRowHiddenByFilter(rowPosition) | Boolean | Retorna se a linha especificada está oculta por um filtro (não por uma visualização de filtro). |
isRowHiddenByUser(rowPosition) | Boolean | Retorna se a linha fornecida está oculta pelo usuário. |
isSheetHidden() | Boolean | Retorna true se a página estiver oculta no momento. |
moveColumns(columnSpec, destinationIndex) | void | Move as colunas selecionadas pelo intervalo especificado para a posição indicada por destinationIndex . |
moveRows(rowSpec, destinationIndex) | void | Move as linhas selecionadas pelo intervalo especificado para a posição indicada por destinationIndex . |
newChart() | EmbeddedChartBuilder | Retorna um criador para criar um novo gráfico para essa planilha. |
protect() | Protection | Cria um objeto que pode proteger a página de ser editada, exceto por usuários com permissão. |
removeChart(chart) | void | Remove um gráfico da página principal. |
setActiveRange(range) | Range | Define o intervalo especificado como o active range na página ativa, com
a célula superior esquerda no intervalo como current cell . |
setActiveRangeList(rangeList) | RangeList | Define a lista especificada de intervalos como o active ranges na
planilha ativa. |
setActiveSelection(range) | Range | Define a região de seleção ativa para a página. |
setActiveSelection(a1Notation) | Range | Define a seleção ativa, conforme especificado na notação A1 ou R1C1. |
setColumnGroupControlPosition(position) | Sheet | Define a posição do botão de controle do grupo de colunas na página. |
setColumnWidth(columnPosition, width) | Sheet | Define a largura da coluna especificada em pixels. |
setColumnWidths(startColumn, numColumns, width) | Sheet | Define a largura das colunas fornecidas em pixels. |
setConditionalFormatRules(rules) | void | Substitui todas as regras de formatação condicional atuais na página pelas regras de entrada. |
setCurrentCell(cell) | Range | Define a célula especificada como current cell . |
setFrozenColumns(columns) | void | Congela o número especificado de colunas. |
setFrozenRows(rows) | void | Congela o número especificado de linhas. |
setHiddenGridlines(hideGridlines) | Sheet | Oculta ou revela as linhas de grade da página. |
setName(name) | Sheet | Define o nome da página. |
setRightToLeft(rightToLeft) | Sheet | Define ou desativa o layout da página da direita para a esquerda. |
setRowGroupControlPosition(position) | Sheet | Define a posição do botão de alternância do controle do grupo de linhas na página. |
setRowHeight(rowPosition, height) | Sheet | Define a altura de uma linha especificada em pixels. |
setRowHeights(startRow, numRows, height) | Sheet | Define a altura das linhas fornecidas em pixels. |
setRowHeightsForced(startRow, numRows, height) | Sheet | Define a altura das linhas fornecidas em pixels. |
setTabColor(color) | Sheet | Define a cor da guia da página. |
setTabColorObject(color) | Sheet | Define a cor da guia da página. |
showColumns(columnIndex) | void | Reexibe a coluna no índice especificado. |
showColumns(columnIndex, numColumns) | void | Exibe uma ou mais colunas consecutivas a partir do índice especificado. |
showRows(rowIndex) | void | Reexibe a linha no índice especificado. |
showRows(rowIndex, numRows) | void | Exibe uma ou mais linhas consecutivas a partir do índice especificado. |
showSheet() | Sheet | Torna a página visível. |
sort(columnPosition) | Sheet | Classifica uma página por coluna, em ordem crescente. |
sort(columnPosition, ascending) | Sheet | Classifica uma página por coluna. |
unhideColumn(column) | void | Exibe a coluna no intervalo especificado. |
unhideRow(row) | void | Exibe a linha no intervalo especificado. |
updateChart(chart) | void | Atualiza o gráfico nesta planilha. |
SheetType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
GRID | Enum | Uma página com uma grade. |
OBJECT | Enum | Uma página com um único objeto incorporado, como EmbeddedChart . |
DATASOURCE | Enum | Uma página contendo um DataSource . |
Slicer
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getBackgroundColorObject() | Color | Retorne o Color do plano de fundo do controle de filtros. |
getColumnPosition() | Integer | Retorna a posição da coluna (em relação ao intervalo de dados do controle de filtros) em que o filtro é
aplicado no controle ou null se a posição da coluna não estiver definida. |
getContainerInfo() | ContainerInfo | Recebe informações sobre onde o controle de filtros está posicionado na página. |
getFilterCriteria() | FilterCriteria | Retorna os critérios de filtro do controle ou null se os critérios não estiverem definidos. |
getRange() | Range | Extrai o intervalo de dados ao qual o controle de filtros é aplicado. |
getTitle() | String | Retorna o título do controle de filtros. |
getTitleHorizontalAlignment() | String | Recebe o alinhamento horizontal do título. |
getTitleTextStyle() | TextStyle | Retorna o estilo de texto do título do controle de filtros. |
isAppliedToPivotTables() | Boolean | Retorna se o controle de filtros especificado é aplicado a tabelas dinâmicas. |
remove() | void | Exclui o controle de filtros. |
setApplyToPivotTables(applyToPivotTables) | Slicer | Define se o controle de filtros especificado deve ser aplicado às tabelas dinâmicas na planilha. |
setBackgroundColor(color) | Slicer | Define a cor do plano de fundo do controle de filtros. |
setBackgroundColorObject(color) | Slicer | Define o Color do plano de fundo do controle de filtros. |
setColumnFilterCriteria(columnPosition, filterCriteria) | Slicer | Define o índice da coluna e os critérios de filtragem do controle de filtros. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | Slicer | Define a posição em que o controle de filtros aparece na página. |
setRange(rangeApi) | Slicer | Define o intervalo de dados em que o controle de filtros é aplicado. |
setTitle(title) | Slicer | Define o título do controle de filtros. |
setTitleHorizontalAlignment(horizontalAlignment) | Slicer | Define o alinhamento horizontal do título no controle de filtros. |
setTitleTextStyle(textStyle) | Slicer | Define o estilo de texto do controle de filtros. |
SortOrder
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
ASCENDING | Enum | Ordem de classificação crescente. |
DESCENDING | Enum | Ordem de classificação decrescente. |
SortSpec
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getBackgroundColor() | Color | Retorna a cor de plano de fundo usada para classificação ou null se estiver ausente. |
getDataSourceColumn() | DataSourceColumn | Recebe a coluna da fonte de dados na qual a especificação de classificação atua. |
getDimensionIndex() | Integer | Retorna o índice da dimensão ou null se não estiver vinculado a um filtro local. |
getForegroundColor() | Color | Retorna a cor do primeiro plano usada para classificação ou null se estiver ausente. |
getSortOrder() | SortOrder | Retorna a ordem de classificação. |
isAscending() | Boolean | Retorna se a ordem de classificação é crescente. |
Spreadsheet
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addDeveloperMetadata(key) | Spreadsheet | Adiciona metadados do desenvolvedor com a chave especificada à planilha de nível superior. |
addDeveloperMetadata(key, visibility) | Spreadsheet | Adiciona à planilha metadados do desenvolvedor com a chave e a visibilidade especificadas. |
addDeveloperMetadata(key, value) | Spreadsheet | Adiciona à planilha metadados do desenvolvedor com a chave e o valor especificados. |
addDeveloperMetadata(key, value, visibility) | Spreadsheet | Adiciona metadados do desenvolvedor com a chave, o valor e a visibilidade especificados à planilha. |
addEditor(emailAddress) | Spreadsheet | Adiciona o usuário especificado à lista de editores do Spreadsheet . |
addEditor(user) | Spreadsheet | Adiciona o usuário especificado à lista de editores do Spreadsheet . |
addEditors(emailAddresses) | Spreadsheet | Adiciona a matriz de usuários especificada à lista de editores do Spreadsheet . |
addMenu(name, subMenus) | void | Cria um novo menu na interface do Planilhas. |
addViewer(emailAddress) | Spreadsheet | Adiciona o usuário especificado à lista de leitores do Spreadsheet . |
addViewer(user) | Spreadsheet | Adiciona o usuário especificado à lista de leitores do Spreadsheet . |
addViewers(emailAddresses) | Spreadsheet | Adiciona a matriz de usuários especificada à lista de leitores para o Spreadsheet . |
appendRow(rowContents) | Sheet | Anexa uma linha na parte inferior da região de dados atual na planilha. |
autoResizeColumn(columnPosition) | Sheet | Define a largura da coluna especificada para ajustar o conteúdo dela. |
copy(name) | Spreadsheet | Copia a planilha e retorna a nova. |
createDeveloperMetadataFinder() | DeveloperMetadataFinder | Retorna um DeveloperMetadataFinder para encontrar metadados do desenvolvedor no escopo dessa planilha. |
createTextFinder(findText) | TextFinder | Cria um localizador de texto para a planilha, que pode ser usado para localizar e substituir texto na planilha. |
deleteActiveSheet() | Sheet | Exclui a planilha ativa no momento. |
deleteColumn(columnPosition) | Sheet | Exclui a coluna na posição de coluna especificada. |
deleteColumns(columnPosition, howMany) | void | Exclui várias colunas começando na posição especificada. |
deleteRow(rowPosition) | Sheet | Exclui a linha na posição de linha especificada. |
deleteRows(rowPosition, howMany) | void | Exclui um número de linhas começando na posição de linha especificada. |
deleteSheet(sheet) | void | Exclui a página especificada. |
duplicateActiveSheet() | Sheet | Duplica a planilha ativa e a torna ativa. |
getActiveCell() | Range | Retorna a célula ativa nesta planilha. |
getActiveRange() | Range | Retorna o intervalo selecionado na página ativa ou null se não houver um intervalo ativo. |
getActiveRangeList() | RangeList | Retorna a lista de intervalos ativos na página ativa ou null se não houver intervalos ativos. |
getActiveSheet() | Sheet | Extrai a página ativa em uma planilha. |
getAs(contentType) | Blob | Retorne os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado. |
getBandings() | Banding[] | Retorna todas as faixas nesta planilha. |
getBlob() | Blob | Retorne os dados dentro desse objeto como um blob. |
getColumnWidth(columnPosition) | Integer | Recebe a largura em pixels da coluna especificada. |
getCurrentCell() | Range | Retorna a célula atual na página ativa ou null se não houver célula atual. |
getDataRange() | Range | Retorna um Range correspondente às dimensões em que os dados estão presentes. |
getDataSourceFormulas() | DataSourceFormula[] | Extrai todas as fórmulas da fonte de dados. |
getDataSourcePivotTables() | DataSourcePivotTable[] | Extrai todas as tabelas dinâmicas da fonte de dados. |
getDataSourceRefreshSchedules() | DataSourceRefreshSchedule[] | Recebe as programações de atualização desta planilha. |
getDataSourceSheets() | DataSourceSheet[] | Retorna todas as páginas de fonte de dados da planilha. |
getDataSourceTables() | DataSourceTable[] | Extrai todas as tabelas da fonte de dados. |
getDataSources() | DataSource[] | Retorna todas as fontes de dados da planilha. |
getDeveloperMetadata() | DeveloperMetadata[] | Recebe os metadados do desenvolvedor associados à planilha de nível superior. |
getEditors() | User[] | Recebe a lista de editores deste Spreadsheet . |
getFormUrl() | String | Retorna o URL do formulário que envia as respostas para esta planilha ou null se a planilha não tiver um formulário associado. |
getFrozenColumns() | Integer | Retorna o número de colunas congeladas. |
getFrozenRows() | Integer | Retorna o número de linhas congeladas. |
getId() | String | Recebe um identificador exclusivo para esta planilha. |
getImages() | OverGridImage[] | Retorna todas as imagens sobre a grade na página. |
getIterativeCalculationConvergenceThreshold() | Number | Retorna o valor limite usado durante o cálculo iterativo. |
getLastColumn() | Integer | Retorna a posição da última coluna que possui conteúdo. |
getLastRow() | Integer | Retorna a posição da última linha que possui conteúdo. |
getMaxIterativeCalculationCycles() | Integer | Retorna o número máximo de iterações a serem usadas durante o cálculo iterativo. |
getName() | String | Extrai o nome do documento. |
getNamedRanges() | NamedRange[] | Extrai todos os intervalos nomeados nesta planilha. |
getNumSheets() | Integer | Retorna o número de páginas nesta planilha. |
getOwner() | User | Retorna o proprietário do documento ou null para um documento em um drive compartilhado. |
getPredefinedSpreadsheetThemes() | SpreadsheetTheme[] | Retorna a lista de temas predefinidos. |
getProtections(type) | Protection[] | Recebe uma matriz de objetos que representam todos os intervalos ou páginas protegidos na planilha. |
getRange(a1Notation) | Range | Retorna o intervalo especificado na notação A1 ou R1C1. |
getRangeByName(name) | Range | Retorna um intervalo nomeado ou null se nenhum intervalo com o nome indicado for encontrado. |
getRangeList(a1Notations) | RangeList | Retorna a coleção RangeList que representa os intervalos na mesma página especificada
por uma lista não vazia de notações A1 ou R1C1. |
getRecalculationInterval() | RecalculationInterval | Retorna o intervalo de cálculo desta planilha. |
getRowHeight(rowPosition) | Integer | Recebe a altura em pixels da linha especificada. |
getSelection() | Selection | Retorna o Selection atual na planilha. |
getSheetByName(name) | Sheet | Retorna uma página com o nome informado. |
getSheetId() | Integer | Retorna o ID da página representada por esse objeto. |
getSheetName() | String | Retorna o nome da planilha. |
getSheetValues(startRow, startColumn, numRows, numColumns) | Object[][] | Retorna a grade retangular de valores para este intervalo começando nas coordenadas fornecidas. |
getSheets() | Sheet[] | Extrai todas as páginas desta planilha. |
getSpreadsheetLocale() | String | Recebe a localidade da planilha. |
getSpreadsheetTheme() | SpreadsheetTheme | Retorna o tema atual da planilha ou null se nenhum tema for aplicado. |
getSpreadsheetTimeZone() | String | Extrai o fuso horário da planilha. |
getUrl() | String | Retorna o URL da planilha especificada. |
getViewers() | User[] | Recebe a lista de leitores e comentadores deste Spreadsheet . |
hideColumn(column) | void | Oculta colunas no intervalo especificado. |
hideRow(row) | void | Oculta as linhas no intervalo especificado. |
insertColumnAfter(afterPosition) | Sheet | Insere uma coluna após a posição de coluna especificada. |
insertColumnBefore(beforePosition) | Sheet | Insere uma coluna antes da posição da coluna especificada. |
insertColumnsAfter(afterPosition, howMany) | Sheet | Insere um determinado número de colunas após a posição especificada. |
insertColumnsBefore(beforePosition, howMany) | Sheet | Insere várias colunas antes da posição especificada. |
insertDataSourceSheet(spec) | DataSourceSheet | Insere um novo DataSourceSheet na planilha e inicia a execução dos dados. |
insertImage(blobSource, column, row) | OverGridImage | Insere um Spreadsheet como uma imagem no documento em uma determinada linha e coluna. |
insertImage(blobSource, column, row, offsetX, offsetY) | OverGridImage | Insere um Spreadsheet como uma imagem no documento em uma determinada linha e coluna, com um
deslocamento de pixels. |
insertImage(url, column, row) | OverGridImage | Insere uma imagem no documento em uma determinada linha e coluna. |
insertImage(url, column, row, offsetX, offsetY) | OverGridImage | Insere uma imagem no documento em uma determinada linha e coluna, com um deslocamento de pixels. |
insertRowAfter(afterPosition) | Sheet | Insere uma linha após a posição da linha especificada. |
insertRowBefore(beforePosition) | Sheet | Insere uma linha antes da posição da linha especificada. |
insertRowsAfter(afterPosition, howMany) | Sheet | Insere um número de linhas após a posição da linha especificada. |
insertRowsBefore(beforePosition, howMany) | Sheet | Insere um número de linhas antes da posição da linha especificada. |
insertSheet() | Sheet | Insere uma nova página na planilha usando um nome de página padrão. |
insertSheet(sheetIndex) | Sheet | Insere uma nova página na planilha com o índice especificado. |
insertSheet(sheetIndex, options) | Sheet | Insere uma nova página na planilha no índice especificado e usa argumentos avançados opcionais. |
insertSheet(options) | Sheet | Insere uma nova página na planilha usando um nome de página padrão e argumentos avançados opcionais. |
insertSheet(sheetName) | Sheet | Insere uma nova página na planilha com o nome informado. |
insertSheet(sheetName, sheetIndex) | Sheet | Insere uma nova página na planilha com o nome indicado no índice especificado. |
insertSheet(sheetName, sheetIndex, options) | Sheet | Insere uma nova página na planilha com o nome indicado no índice especificado e usa argumentos avançados opcionais. |
insertSheet(sheetName, options) | Sheet | Insere uma nova página na planilha com o nome indicado e usa argumentos avançados opcionais. |
insertSheetWithDataSourceTable(spec) | Sheet | Insere uma nova página na planilha, cria um DataSourceTable que abrange a página inteira com a especificação de fonte de dados fornecida e inicia a execução dos dados. |
isColumnHiddenByUser(columnPosition) | Boolean | Retorna se a coluna especificada está oculta pelo usuário. |
isIterativeCalculationEnabled() | Boolean | Retorna se o cálculo iterativo está ativado nesta planilha. |
isRowHiddenByFilter(rowPosition) | Boolean | Retorna se a linha especificada está oculta por um filtro (não por uma visualização de filtro). |
isRowHiddenByUser(rowPosition) | Boolean | Retorna se a linha fornecida está oculta pelo usuário. |
moveActiveSheet(pos) | void | Move a página ativa para a posição especificada na lista de páginas. |
moveChartToObjectSheet(chart) | Sheet | Cria uma nova página SheetType.OBJECT e move o gráfico fornecido para ela. |
refreshAllDataSources() | void | Atualiza todas as fontes de dados compatíveis e os respectivos objetos de fonte de dados vinculados, ignorando objetos inválidos. |
removeEditor(emailAddress) | Spreadsheet | Remove o usuário especificado da lista de editores do Spreadsheet . |
removeEditor(user) | Spreadsheet | Remove o usuário especificado da lista de editores do Spreadsheet . |
removeMenu(name) | void | Remove um menu que foi adicionado por addMenu(name, subMenus) . |
removeNamedRange(name) | void | Exclui um intervalo nomeado com o nome informado. |
removeViewer(emailAddress) | Spreadsheet | Remove o usuário especificado da lista de leitores e comentadores do Spreadsheet . |
removeViewer(user) | Spreadsheet | Remove o usuário especificado da lista de leitores e comentadores do Spreadsheet . |
rename(newName) | void | Renomeia o documento. |
renameActiveSheet(newName) | void | Renomeia a página ativa atual com o novo nome. |
resetSpreadsheetTheme() | SpreadsheetTheme | Remove o tema aplicado e define o tema padrão na planilha. |
setActiveRange(range) | Range | Define o intervalo especificado como o active range na página ativa, com
a célula superior esquerda no intervalo como current cell . |
setActiveRangeList(rangeList) | RangeList | Define a lista especificada de intervalos como o active ranges na
planilha ativa. |
setActiveSelection(range) | Range | Define a região de seleção ativa para a página. |
setActiveSelection(a1Notation) | Range | Define a seleção ativa, conforme especificado na notação A1 ou R1C1. |
setActiveSheet(sheet) | Sheet | Define a página especificada como a página ativa na planilha. |
setActiveSheet(sheet, restoreSelection) | Sheet | Define a página especificada como ativa na planilha, com uma opção para restaurar a seleção mais recente nessa página. |
setColumnWidth(columnPosition, width) | Sheet | Define a largura da coluna especificada em pixels. |
setCurrentCell(cell) | Range | Define a célula especificada como current cell . |
setFrozenColumns(columns) | void | Congela o número especificado de colunas. |
setFrozenRows(rows) | void | Congela o número especificado de linhas. |
setIterativeCalculationConvergenceThreshold(minThreshold) | Spreadsheet | Define o valor limite mínimo para o cálculo iterativo. |
setIterativeCalculationEnabled(isEnabled) | Spreadsheet | Define se o cálculo iterativo está ativado nesta planilha. |
setMaxIterativeCalculationCycles(maxIterations) | Spreadsheet | Define o número máximo de iterações de cálculo que precisam ser realizadas durante o cálculo iterativo. |
setNamedRange(name, range) | void | nomeia um intervalo; |
setRecalculationInterval(recalculationInterval) | Spreadsheet | Define com que frequência esta planilha deve ser recalculada. |
setRowHeight(rowPosition, height) | Sheet | Define a altura de uma linha especificada em pixels. |
setSpreadsheetLocale(locale) | void | Define a localidade da planilha. |
setSpreadsheetTheme(theme) | SpreadsheetTheme | Define um tema na planilha. |
setSpreadsheetTimeZone(timezone) | void | Define o fuso horário da planilha. |
show(userInterface) | void | Exibe um componente personalizado da interface do usuário em uma caixa de diálogo centralizada na janela de visualização do navegador do usuário. |
sort(columnPosition) | Sheet | Classifica uma página por coluna, em ordem crescente. |
sort(columnPosition, ascending) | Sheet | Classifica uma página por coluna. |
toast(msg) | void | Mostra uma janela pop-up no canto inferior direito da planilha com a mensagem especificada. |
toast(msg, title) | void | Mostra uma janela pop-up no canto inferior direito da planilha com a mensagem e o título fornecidos. |
toast(msg, title, timeoutSeconds) | void | Mostra uma janela pop-up no canto inferior direito da planilha com o título e a mensagem fornecidos, que permanece visível por um determinado período. |
unhideColumn(column) | void | Exibe a coluna no intervalo especificado. |
unhideRow(row) | void | Exibe a linha no intervalo especificado. |
updateMenu(name, subMenus) | void | Atualiza um menu que foi adicionado por addMenu(name, subMenus) . |
waitForAllDataExecutionsCompletion(timeoutInSeconds) | void | Aguarda até que todas as execuções atuais na planilha sejam concluídas, expirando após o número fornecido de segundos. |
SpreadsheetApp
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
AutoFillSeries | AutoFillSeries | Uma enumeração dos tipos de séries usadas para calcular valores preenchidos automaticamente. |
BandingTheme | BandingTheme | Uma enumeração dos possíveis temas de faixa. |
BooleanCriteria | BooleanCriteria | Uma enumeração de critérios booleanos de formatação condicional. |
BorderStyle | BorderStyle | Uma enumeração dos estilos válidos para definir bordas em um Range . |
ColorType | ColorType | Uma enumeração dos possíveis tipos de cor. |
CopyPasteType | CopyPasteType | Uma enumeração dos possíveis tipos de colagem. |
DataExecutionErrorCode | DataExecutionErrorCode | Uma enumeração dos possíveis códigos de erro de execução de dados. |
DataExecutionState | DataExecutionState | Uma enumeração dos possíveis estados de execução de dados. |
DataSourceParameterType | DataSourceParameterType | Uma enumeração dos possíveis tipos de parâmetro da fonte de dados. |
DataSourceRefreshScope | DataSourceRefreshScope | Uma enumeração de possíveis escopos de atualização da fonte de dados. |
DataSourceType | DataSourceType | Uma enumeração dos possíveis tipos de fontes de dados. |
DataValidationCriteria | DataValidationCriteria | Uma enumeração que representa os critérios de validação de dados que podem ser definidos em um intervalo. |
DateTimeGroupingRuleType | DateTimeGroupingRuleType | Uma enumeração da regra de agrupamento de data e hora. |
DeveloperMetadataLocationType | DeveloperMetadataLocationType | Uma enumeração de possíveis tipos de locais de metadados do desenvolvedor. |
DeveloperMetadataVisibility | DeveloperMetadataVisibility | Uma enumeração das possíveis visibilidades de metadados do desenvolvedor. |
Dimension | Dimension | Uma enumeração das possíveis dimensões de uma planilha. |
Direction | Direction | Uma enumeração das possíveis direções que se pode mover em uma planilha usando as teclas de seta. |
FrequencyType | FrequencyType | Uma enumeração dos possíveis tipos de frequência. |
GroupControlTogglePosition | GroupControlTogglePosition | Uma enumeração das posições em que o controle de grupo pode estar. |
InterpolationType | InterpolationType | Uma enumeração de tipos de interpolação de gradiente de formato condicional. |
PivotTableSummarizeFunction | PivotTableSummarizeFunction | Uma enumeração das funções que podem ser usadas para resumir valores em uma tabela dinâmica. |
PivotValueDisplayType | PivotValueDisplayType | Uma enumeração das maneiras como um valor dinâmico pode ser exibido. |
ProtectionType | ProtectionType | Uma enumeração que representa as partes de uma planilha que podem ser protegidas contra edições. |
RecalculationInterval | RecalculationInterval | Uma enumeração dos intervalos possíveis que podem ser usados no recálculo da planilha. |
RelativeDate | RelativeDate | Uma enumeração de opções de data relativa para calcular um valor a ser usado em BooleanCriteria baseado em data. |
SheetType | SheetType | Uma enumeração dos diferentes tipos de páginas que podem existir em uma planilha. |
SortOrder | SortOrder | Uma enumeração da ordem de classificação. |
TextDirection | TextDirection | Uma enumeração de direções de texto válidas. |
TextToColumnsDelimiter | TextToColumnsDelimiter | Uma enumeração dos delimitadores predefinidos para divisão de texto em colunas. |
ThemeColorType | ThemeColorType | Uma enumeração dos possíveis tipos de cores do tema. |
ValueType | ValueType | Uma enumeração de tipos de valor retornados por Range.getValue() e Range.getValues() da classe Range do serviço Planilha. |
WrapStrategy | WrapStrategy | Uma enumeração das estratégias usadas para unir células. |
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
create(name) | Spreadsheet | Cria uma nova planilha com o nome informado. |
create(name, rows, columns) | Spreadsheet | Cria uma nova planilha com o nome e o número especificado de linhas e colunas. |
enableAllDataSourcesExecution() | void | Ativa a execução de dados para todos os tipos de fontes de dados. |
enableBigQueryExecution() | void | Ativa a execução de dados para fontes do BigQuery. |
flush() | void | Aplica todas as alterações pendentes na planilha. |
getActive() | Spreadsheet | Retorna a planilha ativa no momento ou null se não houver nenhuma. |
getActiveRange() | Range | Retorna o intervalo selecionado na página ativa ou null se não houver um intervalo ativo. |
getActiveRangeList() | RangeList | Retorna a lista de intervalos ativos na página ativa ou null se não houver intervalos selecionados. |
getActiveSheet() | Sheet | Extrai a página ativa em uma planilha. |
getActiveSpreadsheet() | Spreadsheet | Retorna a planilha ativa no momento ou null se não houver nenhuma. |
getCurrentCell() | Range | Retorna a célula atual (destacada) selecionada em um dos intervalos ativos na página ativa ou null se não houver célula atual. |
getSelection() | Selection | Retorna o Selection atual na planilha. |
getUi() | Ui | Retorna uma instância do ambiente de interface do usuário da planilha que permite ao script adicionar recursos como menus, caixas de diálogo e barras laterais. |
newCellImage() | CellImageBuilder | Cria um builder para uma CellImage . |
newColor() | ColorBuilder | Cria um builder para uma Color . |
newConditionalFormatRule() | ConditionalFormatRuleBuilder | Cria um builder para uma regra de formatação condicional. |
newDataSourceSpec() | DataSourceSpecBuilder | Cria um builder para uma DataSourceSpec . |
newDataValidation() | DataValidationBuilder | Cria um builder para uma regra de validação de dados. |
newFilterCriteria() | FilterCriteriaBuilder | Cria um builder para uma FilterCriteria . |
newRichTextValue() | RichTextValueBuilder | Cria um builder para um valor de Rich Text. |
newTextStyle() | TextStyleBuilder | Cria um builder para um estilo de texto. |
open(file) | Spreadsheet | Abre a planilha que corresponde ao objeto File especificado. |
openById(id) | Spreadsheet | Abre a planilha com o ID fornecido. |
openByUrl(url) | Spreadsheet | Abre a planilha com o URL fornecido. |
setActiveRange(range) | Range | Define o intervalo especificado como active range , com a célula
superior esquerda no intervalo como current cell . |
setActiveRangeList(rangeList) | RangeList | Define a lista de intervalos especificada como o active ranges . |
setActiveSheet(sheet) | Sheet | Define a página ativa em uma planilha. |
setActiveSheet(sheet, restoreSelection) | Sheet | Define a página ativa em uma planilha, com a opção de restaurar a seleção mais recente nessa página. |
setActiveSpreadsheet(newActiveSpreadsheet) | void | Define a planilha ativa. |
setCurrentCell(cell) | Range | Define a célula especificada como current cell . |
SpreadsheetTheme
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getConcreteColor(themeColorType) | Color | Retorna a Color concreta para um tipo de cor de tema válido. |
getFontFamily() | String | Retorna a família de fontes do tema ou null , se for um tema null . |
getThemeColors() | ThemeColorType[] | Retorna uma lista de todos os tipos de cor de tema possíveis para o tema atual. |
setConcreteColor(themeColorType, color) | SpreadsheetTheme | Define a cor concreta associada ao ThemeColorType neste esquema de cores para a
cor especificada. |
setConcreteColor(themeColorType, red, green, blue) | SpreadsheetTheme | Define a cor concreta associada ao ThemeColorType neste esquema de cores para a
cor especificada no formato RGB. |
setFontFamily(fontFamily) | SpreadsheetTheme | Define a família de fontes do tema. |
TextDirection
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
LEFT_TO_RIGHT | Enum | É a direção do texto da esquerda para a direita. |
RIGHT_TO_LEFT | Enum | É a direção do texto da direita para a esquerda. |
TextFinder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
findAll() | Range[] | Retorna todas as células que correspondem aos critérios de pesquisa. |
findNext() | Range | Retorna a próxima célula que corresponde aos critérios de pesquisa. |
findPrevious() | Range | Retorna a célula anterior que corresponde aos critérios de pesquisa. |
getCurrentMatch() | Range | Retorna a célula atual que corresponde aos critérios de pesquisa. |
ignoreDiacritics(ignoreDiacritics) | TextFinder | Se true , configura a pesquisa para ignorar diacríticos durante a correspondência. Caso contrário, a
pesquisa corresponde a diacríticos. |
matchCase(matchCase) | TextFinder | Se for true , configura a pesquisa para corresponder exatamente ao texto da pesquisa. Caso contrário, a pesquisa será padronizada com correspondência indiferente a maiúsculas. |
matchEntireCell(matchEntireCell) | TextFinder | Se true , configura a pesquisa para corresponder a todo o conteúdo de uma célula. Caso contrário, a pesquisa é padronizada com correspondência parcial. |
matchFormulaText(matchFormulaText) | TextFinder | Se for true , configura a pesquisa para retornar correspondências que aparecem no texto da fórmula.
Caso contrário, as células com fórmulas são consideradas com base no valor exibido. |
replaceAllWith(replaceText) | Integer | Substitui todas as correspondências pelo texto especificado. |
replaceWith(replaceText) | Integer | Substitui o texto da pesquisa na célula correspondente no momento pelo texto especificado e retorna o número de ocorrências substituídas. |
startFrom(startRange) | TextFinder | Configura a pesquisa para iniciar imediatamente após o intervalo de células especificado. |
useRegularExpression(useRegEx) | TextFinder | Se true , configura a pesquisa para interpretar a string de pesquisa como uma expressão regular. Caso contrário, a pesquisa interpretará a string de pesquisa como texto normal. |
TextRotation
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getDegrees() | Integer | Mostra o ângulo entre a orientação de texto padrão e a orientação atual do texto. |
isVertical() | Boolean | Retorna true se o texto estiver empilhado verticalmente. Caso contrário, retorna false . |
TextStyle
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | TextStyleBuilder | Cria um builder de estilo de texto inicializado com os valores desse estilo. |
getFontFamily() | String | Recebe a família de fontes do texto. |
getFontSize() | Integer | Recebe o tamanho da fonte do texto em pontos. |
getForegroundColorObject() | Color | Recebe a cor da fonte do texto. |
isBold() | Boolean | Consegue ou não o texto em negrito. |
isItalic() | Boolean | Define se a célula está em itálico ou não. |
isStrikethrough() | Boolean | Descobre se a célula está tachada ou não. |
isUnderline() | Boolean | Descobre se a célula está ou não sublinhada. |
TextStyleBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
build() | TextStyle | Cria um estilo de texto com base nesse builder. |
setBold(bold) | TextStyleBuilder | Define se o texto está em negrito ou não. |
setFontFamily(fontFamily) | TextStyleBuilder | Define a família de fontes do texto, como "Arial". |
setFontSize(fontSize) | TextStyleBuilder | Define o tamanho da fonte do texto em pontos. |
setForegroundColor(cssString) | TextStyleBuilder | Define a cor da fonte do texto. |
setForegroundColorObject(color) | TextStyleBuilder | Define a cor da fonte do texto. |
setItalic(italic) | TextStyleBuilder | Define se o texto será itálico ou não. |
setStrikethrough(strikethrough) | TextStyleBuilder | Define se o texto será tachado ou não. |
setUnderline(underline) | TextStyleBuilder | Define se o texto será sublinhado ou não. |
TextToColumnsDelimiter
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
COMMA | Enum | Delimitador "," . |
SEMICOLON | Enum | Delimitador ";" . |
PERIOD | Enum | Delimitador "." . |
SPACE | Enum | Delimitador " " . |
ThemeColor
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getColorType() | ColorType | Define o tipo dessa cor. |
getThemeColorType() | ThemeColorType | Recebe o tipo de cor do tema desta cor. |
ThemeColorType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
UNSUPPORTED | Enum | Representa uma cor de tema que não é compatível. |
TEXT | Enum | Representa a cor do texto. |
BACKGROUND | Enum | Representa a cor a ser usada no plano de fundo do gráfico. |
ACCENT1 | Enum | Representa a primeira cor de destaque. |
ACCENT2 | Enum | Representa a segunda cor de destaque. |
ACCENT3 | Enum | Representa a terceira cor de destaque. |
ACCENT4 | Enum | Representa a quarta cor de destaque. |
ACCENT5 | Enum | Representa a quinta cor de destaque. |
ACCENT6 | Enum | Representa a sexta cor de destaque. |
HYPERLINK | Enum | Representa a cor a ser usada em hiperlinks. |
ValueType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
IMAGE | Enum | O tipo de valor quando a célula contém uma imagem. |
WrapStrategy
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
WRAP | Enum | Una as linhas que são mais longas que a largura da célula em uma nova linha. |
OVERFLOW | Enum | Transborda as linhas para a próxima célula, desde que ela esteja vazia. |
CLIP | Enum | Linhas com mais do que a largura da célula. |