Esse serviço permite que os scripts criem, acessem e modifiquem os arquivos do Planilhas Google. Consulte também o guia para armazenar dados em planilhas.
Às vezes, as operações de planilha são agrupadas para melhorar o desempenho, como ao
fazer várias chamadas para um método. Se você quiser garantir que todas as mudanças pendentes sejam feitas imediatamente, por exemplo, para mostrar as informações aos usuários enquanto um script está sendo executado, chame SpreadsheetApp.flush()
.
Classes
Nome | Breve descrição |
---|---|
AutoFillSeries | Uma enumeração dos tipos de série usados para calcular os valores preenchidos automaticamente. |
Banding | Acessar e modificar as faixas, os padrões de cores aplicados a linhas ou colunas de um intervalo. |
BandingTheme | Uma enumeração de temas de faixas. |
BigQueryDataSourceSpec | Acessar a especificação atual da fonte de dados do BigQuery. |
BigQueryDataSourceSpecBuilder | O builder da classe 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 da classe ColorBuilder . |
ConditionalFormatRule | Acessar regras de formatação condicional. |
ConditionalFormatRuleBuilder | Builder de regras de formatação condicional. |
ContainerInfo | Acessar 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 | O status de execução dos dados. |
DataSource | Acessar e modificar uma fonte de dados atual. |
DataSourceChart | Acessar e modificar um gráfico de fonte de dados existente. |
DataSourceColumn | Acessar e modificar uma coluna de fonte de dados. |
DataSourceFormula | Acessar e modificar fórmulas de fontes de dados atuais. |
DataSourceParameter | Acessar 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 de fonte de dados existente. |
DataSourceSheetFilter | Acessar e modificar um filtro de planilha de fonte de dados existente. |
DataSourceSpec | Acesse as configurações gerais de uma especificação de fonte de dados atual. |
DataSourceSpecBuilder | O builder da classe DataSourceSpec . |
DataSourceTable | Acessar e modificar a tabela de fonte de dados atual. |
DataSourceTableColumn | Acessar e modificar uma coluna existente em um DataSourceTable . |
DataSourceTableFilter | Acessar e modificar um filtro de tabela de fonte de dados atual. |
DataSourceType | Uma enumeração de tipos de fonte 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 e hora. |
DeveloperMetadata | Acessar e modificar metadados do desenvolvedor. |
DeveloperMetadataFinder | Pesquisar metadados do desenvolvedor em uma planilha. |
DeveloperMetadataLocation | Acessar as informações de localização 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 uma pessoa pode mover em uma planilha usando as teclas de seta. |
Drawing | Representa um desenho sobre uma folha 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 de gráficos de colunas. |
EmbeddedComboChartBuilder | Builder para gráficos de combinação. |
EmbeddedHistogramChartBuilder | Builder de gráficos de histograma. |
EmbeddedLineChartBuilder | Builder de 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 páginas Grid , o tipo padrão de
planilha. |
FilterCriteria | Use esta classe para receber informações sobre os filtros atuais ou copiar os critérios deles. |
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 alternância do 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 um ConditionalFormatRule . |
NamedRange | Criar, acessar e modificar intervalos nomeados em uma planilha. |
OverGridImage | Representa uma imagem sobre a grade em uma planilha. |
| Acessar e modificar páginas protegidas na versão antiga do Planilhas Google. |
PivotFilter | Acessar e modificar os filtros da tabela dinâmica. |
PivotGroup | Acesse e modifique grupos de tabelas dinâmicas. |
PivotGroupLimit | Acessar e modificar os limites dos grupos 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 | Acessar e modificar 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 intervalos e páginas protegidos. |
ProtectionType | Uma enumeração que representa as partes de uma planilha que podem ser protegidas contra edições. |
Range | Acessar e modificar intervalos da planilha. |
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 com base na data. |
RichTextValue | Uma string de texto estilizada usada para representar texto de célula. |
RichTextValueBuilder | Um builder para valores Rich Text. |
Selection | Acessar a seleção ativa atual na planilha 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, 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 | Acesse e crie arquivos do Planilhas Google. |
SpreadsheetTheme | Acessar e modificar temas existentes. |
TextDirection | Uma enumeração de direções de texto. |
TextFinder | Localizar ou substituir texto em um intervalo, uma página ou uma planilha. |
TextRotation | Acesse as configurações de rotação do texto em uma célula. |
TextStyle | O estilo renderizado do texto 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 da planilha. |
WrapStrategy | Uma enumeração das estratégias usadas para lidar com quebra de texto de 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 no 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 estiver definida. |
getFirstRowColorObject() | Color | Retorna a primeira cor da linha alternada ou null , se nenhuma cor estiver definida. |
getFooterColumnColorObject() | Color | Retorna a cor da última coluna na faixa ou null se nenhuma cor estiver definida. |
getFooterRowColorObject() | Color | Retorna a cor da última linha na faixa ou null se nenhuma cor estiver definida. |
getHeaderColumnColorObject() | Color | Retorna a cor da primeira coluna na faixa ou null se nenhuma cor estiver definida. |
getHeaderRowColorObject() | Color | Retorna a cor da linha de cabeçalho ou null se nenhuma cor estiver definida. |
getRange() | Range | Retorna o intervalo dessa faixa. |
getSecondColumnColorObject() | Color | Retorna a segunda cor de coluna alternada na faixa ou null se nenhuma cor estiver definida. |
getSecondRowColorObject() | Color | Retorna a segunda cor da linha alternada ou null , se nenhuma cor estiver 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. |
setFirstRowColor(color) | Banding | Define a cor da primeira linha que é alternada. |
setFirstRowColorObject(color) | Banding | Define a primeira cor da 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 de cabeçalho. |
setHeaderColumnColorObject(color) | Banding | Define a cor da coluna de 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. |
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 ciano. |
GREEN | Enum | Tema de faixas verdes. |
YELLOW | Enum | Tema de faixas amarelas. |
ORANGE | Enum | Tema de faixas laranja. |
BLUE | Enum | Tema de faixas azuis. |
TEAL | Enum | Tema de faixas na cor azul-petróleo. |
GREY | Enum | Tema de faixas cinza. |
BROWN | Enum | Tema de faixas marrons. |
LIGHT_GREEN | Enum | Tema de faixas verde-claro. |
INDIGO | Enum | Tema de bandas na cor índigo. |
PINK | Enum | 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[] | Extrai os parâmetros da fonte de dados. |
getProjectId() | String | Recebe o ID do projeto de faturamento. |
getRawQuery() | String | Extrai 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 desse 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[] | Extrai os parâmetros da fonte de dados. |
getProjectId() | String | Recebe o ID do projeto de faturamento. |
getRawQuery() | String | Extrai 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 já existir, atualiza sua 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 desta condição booleana. |
getBold() | Boolean | Retornará true se essa condição booleana colocar o texto em negrito e retornará false se essa condição booleana remover o negrito do texto. |
getCriteriaType() | BooleanCriteria | Recebe o tipo de critérios da regra, conforme definido na enumeração BooleanCriteria . |
getCriteriaValues() | Object[] | Recebe uma matriz de argumentos para os critérios da regra. |
getFontColorObject() | Color | Recebe a cor da fonte para essa condição booleana. |
getItalic() | Boolean | Retorna 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 | Retorna true se essa condição booleana tocar no texto e retorna 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 | Os critérios são atendidos quando uma célula não está vazia. |
DATE_AFTER | Enum | O critério é atendido quando uma data é posterior ao valor fornecido. |
DATE_BEFORE | Enum | O critério é atendido quando uma 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 uma data é anterior ao valor da data relativa. |
DATE_EQUAL_TO_RELATIVE | Enum | O critério é atendido 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 | Os critérios são atendidos 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 que 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 fornecido. |
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 fornecido. |
TEXT_NOT_EQUAL_TO | Enum | Os critérios são atendidos quando a entrada não é igual ao valor fornecido. |
TEXT_STARTS_WITH | Enum | O critério é atendido 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 tracejadas. |
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 está 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 da 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 está disponível. |
setAltTextDescription(description) | CellImage | Define a descrição de texto alternativo para esta imagem. |
setAltTextTitle(title) | CellImage | Define o título do texto alternativo para esta 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 com base nas 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 de criador de regras com as configurações dessa regra. |
getBooleanCondition() | BooleanCondition | Recupera as informações BooleanCondition da regra se ela usar
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 essa regra de formato condicional é aplicada. |
ConditionalFormatRuleBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
build() | ConditionalFormatRule | Constrói uma regra de formatação condicional a partir das configurações aplicadas ao builder. |
copy() | ConditionalFormatRuleBuilder | Retorna uma predefinição de criador de regras com as configurações dessa regra. |
getBooleanCondition() | BooleanCondition | Recupera as informações BooleanCondition da regra se ela usar
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 essa regra de formato 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 formato 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 formato condicional e 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 formato condicional e usa o valor máximo nos intervalos da regra. |
setGradientMaxpointObjectWithValue(color, type, value) | ConditionalFormatRuleBuilder | Define os campos de ponto máximo gradiente da regra de formato condicional. |
setGradientMaxpointWithValue(color, type, value) | ConditionalFormatRuleBuilder | Define os campos de ponto máximo gradiente da regra de formato condicional. |
setGradientMidpointObjectWithValue(color, type, value) | ConditionalFormatRuleBuilder | Define os campos de ponto médio do gradiente da regra de formato condicional. |
setGradientMidpointWithValue(color, type, value) | ConditionalFormatRuleBuilder | Define os campos de ponto médio do gradiente da regra de formato condicional. |
setGradientMinpoint(color) | ConditionalFormatRuleBuilder | Limpa o valor mínimo do gradiente da regra de formato condicional e usa o valor mínimo nos intervalos da regra. |
setGradientMinpointObject(color) | ConditionalFormatRuleBuilder | Limpa o valor mínimo do gradiente da regra de formato condicional e usa o valor mínimo nos intervalos da regra. |
setGradientMinpointObjectWithValue(color, type, value) | ConditionalFormatRuleBuilder | Define os campos de ponto mínimo de gradiente da regra de formato condicional. |
setGradientMinpointWithValue(color, type, value) | ConditionalFormatRuleBuilder | Define os campos de ponto mínimo de gradiente da regra de formato condicional. |
setItalic(italic) | ConditionalFormatRuleBuilder | Define o itálico do texto para o formato da regra de formato 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 formato condicional. |
setUnderline(underline) | ConditionalFormatRuleBuilder | Define o sublinhado do texto do formato da regra de formato condicional. |
whenCellEmpty() | ConditionalFormatRuleBuilder | Define a regra de formato condicional que será acionada quando a célula estiver vazia. |
whenCellNotEmpty() | ConditionalFormatRuleBuilder | Define a regra de formato condicional que será acionada quando a célula não estiver vazia. |
whenDateAfter(date) | ConditionalFormatRuleBuilder | Define a regra de formato condicional que será acionada quando uma data for posterior ao valor informado. |
whenDateAfter(date) | ConditionalFormatRuleBuilder | Define a regra de formato condicional que será acionada quando uma data for posterior à data relativa especificada. |
whenDateBefore(date) | ConditionalFormatRuleBuilder | Define a regra de formato condicional que será acionada quando uma data for anterior à data especificada. |
whenDateBefore(date) | ConditionalFormatRuleBuilder | Define a regra de formato condicional que será acionada quando uma data for anterior à data relativa especificada. |
whenDateEqualTo(date) | ConditionalFormatRuleBuilder | Define a regra de formato condicional que será acionada quando uma data for igual à data especificada. |
whenDateEqualTo(date) | ConditionalFormatRuleBuilder | Define a regra de formato condicional que será acionada quando uma data for igual à data relativa especificada. |
whenFormulaSatisfied(formula) | ConditionalFormatRuleBuilder | Define a regra de formato condicional a ser acionada quando a fórmula especificada for avaliada como true . |
whenNumberBetween(start, end) | ConditionalFormatRuleBuilder | Define a regra de formato condicional que será acionada quando um número estiver entre dois valores especificados ou for um deles. |
whenNumberEqualTo(number) | ConditionalFormatRuleBuilder | Define a regra de formato condicional que será acionada quando um número for igual ao valor informado. |
whenNumberGreaterThan(number) | ConditionalFormatRuleBuilder | Define a regra de formato condicional que será acionada quando um número for maior que o valor fornecido. |
whenNumberGreaterThanOrEqualTo(number) | ConditionalFormatRuleBuilder | Define a regra de formato condicional que será acionada quando um número for maior ou igual ao valor fornecido. |
whenNumberLessThan(number) | ConditionalFormatRuleBuilder | Define a regra de formato condicional condicional a ser acionada quando um número menor que o valor fornecido. |
whenNumberLessThanOrEqualTo(number) | ConditionalFormatRuleBuilder | Define a regra de formato condicional a ser acionada quando um número menor ou igual ao valor fornecido. |
whenNumberNotBetween(start, end) | ConditionalFormatRuleBuilder | Define a regra de formato condicional a ser acionada quando um número não estiver entre os dois valores especificados e não estiver entre eles. |
whenNumberNotEqualTo(number) | ConditionalFormatRuleBuilder | Define a regra de formato condicional que será acionada quando um número não for igual ao valor informado. |
whenTextContains(text) | ConditionalFormatRuleBuilder | Define a regra de formato condicional a ser acionada quando a entrada contiver o valor fornecido. |
whenTextDoesNotContain(text) | ConditionalFormatRuleBuilder | Define a regra de formato condicional a ser acionada quando a entrada não contiver o valor fornecido. |
whenTextEndsWith(text) | ConditionalFormatRuleBuilder | Define a regra de formato condicional que será acionada quando a entrada terminar com o valor fornecido. |
whenTextEqualTo(text) | ConditionalFormatRuleBuilder | Define a regra de formato condicional a ser acionada quando a entrada for igual ao valor informado. |
whenTextStartsWith(text) | ConditionalFormatRuleBuilder | Define a regra de formato condicional a ser acionada quando a entrada começar com o valor fornecido. |
withCriteria(criteria, args) | ConditionalFormatRuleBuilder | Define a regra de formato condicional para critérios definidos por valores BooleanCriteria , geralmente retirados de criteria e arguments de uma regra atual. |
ContainerInfo
Métodos
Mé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 de âncora por tantos pixels. |
getOffsetY() | Integer | O canto superior esquerdo do gráfico está deslocado da linha da âncora em vários pixels. |
CopyPasteType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
PASTE_NORMAL | Enum | Colar valores, fórmulas, formatos e mesclagens. |
PASTE_NO_BORDERS | Enum | Colar valores, fórmulas, formatos e mesclagens, mas sem bordas. |
PASTE_FORMAT | Enum | Cole apenas o formato. |
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 mesclagens. |
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 | Código de erro de execução de dados incompatível com o Apps Script. |
NONE | Enum | A execução dos dados não apresentou erros. |
TIME_OUT | Enum | A execução dos dados expirou. |
TOO_MANY_ROWS | Enum | A execução de dados retorna mais linhas do que o limite. |
TOO_MANY_COLUMNS | Enum | A execução de 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 do 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 Apps Script não oferece suporte ao estado de execução de dados. |
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 tem 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 | Extrai 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 | Recebe a hora em que os dados foram atualizados pela última vez. |
isTruncated() | Boolean | Retornará true se os dados da última execução bem-sucedida forem truncados. Caso contrário, retornará false . |
DataSource
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
cancelAllLinkedDataSourceObjectRefreshes() | void | Cancela todas as atualizações em execução nos objetos da fonte de dados vinculados a essa fonte. |
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 de dados. |
getSpec() | DataSourceSpec | Recebe a especificação da fonte de dados. |
refreshAllLinkedDataSourceObjects() | void | Atualiza todos os objetos da fonte de dados vinculados à fonte. |
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 atualiza o data
source sheets vinculado com a nova especificação. |
waitForAllDataExecutionsCompletion(timeoutInSeconds) | void | Aguarda a conclusão de todas as execuções atuais dos objetos da fonte de dados vinculados, expirando após o número fornecido de segundos. |
DataSourceChart
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
cancelDataRefresh() | DataSourceChart | Cancela a atualização de dados associada a esse objeto se ele estiver em execução. |
forceRefreshData() | DataSourceChart | Atualiza os dados desse objeto, independentemente do estado atual. |
getDataSource() | DataSource | Extrai 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 a execução atual, expirando após o número fornecido de segundos. |
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 | Extrai o nome da coluna da fonte de dados. |
hasArrayDependency() | Boolean | Retorna indicando se a coluna tem uma dependência de matriz. |
isCalculatedColumn() | Boolean | Retorna indicando se a coluna é uma coluna calculada. |
remove() | void | Remove a coluna da fonte de dados. |
setFormula(formula) | DataSourceColumn | Define a fórmula da 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 |
---|---|---|
cancelDataRefresh() | DataSourceFormula | Cancela a atualização de dados associada a esse objeto se ele estiver em execução. |
forceRefreshData() | DataSourceFormula | Atualiza os dados desse objeto, independentemente do estado atual. |
getAnchorCell() | Range | Retorna Range que representa a célula em que essa fórmula de fonte de dados está ancorada. |
getDataSource() | DataSource | Extrai 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 a execução atual, expirando após o número fornecido de segundos. |
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 | Extrai o tipo de parâmetro. |
DataSourceParameterType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTED | Enum | Um tipo de parâmetro de 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 da fonte de dados especificada. |
addFilter(columnName, filterCriteria) | PivotFilter | Adiciona um novo filtro com base na coluna da 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 da fonte de dados especificada com a função de resumo especificada. |
addRowGroup(columnName) | PivotGroup | Adiciona um novo grupo de linhas dinâmicas com base na coluna da fonte de dados especificada. |
asPivotTable() | PivotTable | Retorna a tabela dinâmica da fonte de dados como um objeto de tabela dinâmica normal. |
cancelDataRefresh() | DataSourcePivotTable | Cancela a atualização de dados associada a esse objeto se ele estiver em execução. |
forceRefreshData() | DataSourcePivotTable | Atualiza os dados desse objeto, independentemente do estado atual. |
getDataSource() | DataSource | Extrai 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 a execução atual, expirando após o número fornecido de segundos. |
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 a frequência e o momento da atualização. |
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 a 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[] | Recebe os dias da semana em que a fonte de dados é atualizada. |
getFrequencyType() | FrequencyType | Extrai 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 é aceito. |
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 página da 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. |
cancelDataRefresh() | DataSourceSheet | Cancela a atualização de dados associada a esse objeto se ele estiver em execução. |
forceRefreshData() | DataSourceSheet | Atualiza os dados desse objeto, independentemente do estado atual. |
getColumnWidth(columnName) | Integer | Retorna a largura da coluna especificada. |
getDataSource() | DataSource | Extrai a fonte de dados à qual o objeto está vinculado. |
getFilters() | DataSourceSheetFilter[] | Retorna todos os filtros aplicados à página da fonte de dados. |
getSheetValues(columnName) | Object[] | Retorna todos os valores da planilha da fonte de dados para o nome de coluna fornecido. |
getSheetValues(columnName, startRow, numRows) | Object[] | Retorna todos os valores da página de fonte de dados referentes ao nome de coluna fornecido, desde a linha inicial (baseada em 1) até o numRows fornecido. |
getSortSpecs() | SortSpec[] | Recebe todas as especificações de classificação na planilha da fonte de dados. |
getStatus() | 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 em 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 a execução atual, expirando após o número fornecido de segundos. |
DataSourceSheetFilter
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getDataSourceColumn() | DataSourceColumn | Retorna a coluna da fonte de dados à qual este 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[] | Extrai 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 desse builder. |
copy() | DataSourceSpecBuilder | Cria um DataSourceSpecBuilder com base nas configurações dessa fonte de dados. |
getParameters() | DataSourceParameter[] | Extrai 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 já existir, atualiza sua célula de origem. |
DataSourceTable
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addColumns(columnNames) | DataSourceTable | Adiciona colunas à tabela de 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. |
cancelDataRefresh() | DataSourceTable | Cancela a atualização de dados associada a esse objeto se ele estiver em execução. |
forceRefreshData() | DataSourceTable | Atualiza os dados desse objeto, independentemente do estado atual. |
getColumns() | DataSourceTableColumn[] | Recebe todas as colunas de fonte de dados adicionadas à tabela de fonte de dados. |
getDataSource() | DataSource | Extrai 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 na tabela de 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 da fonte de dados associada com a tabela de fontes de dados. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Aguarda a execução atual, expirando após o número fornecido de segundos. |
DataSourceTableColumn
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getDataSourceColumn() | DataSourceColumn | Extrai a coluna da fonte 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 da fonte de dados à qual este 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 | Retornará true se a regra mostrar um aviso quando a entrada falhar na validação de dados ou false se ela rejeitar totalmente a entrada. |
getCriteriaType() | DataValidationCriteria | Recebe o tipo de critérios da regra, conforme definido na enumeração DataValidationCriteria . |
getCriteriaValues() | Object[] | Recebe uma matriz de argumentos para os critérios da regra. |
getHelpText() | String | Recebe o texto de ajuda da regra ou null , se nenhum texto de ajuda estiver 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 criador. |
copy() | DataValidationBuilder | Cria um builder para uma regra de validação de dados com base nas configurações dessa regra. |
getAllowInvalid() | Boolean | Retornará true se a regra mostrar um aviso quando a entrada falhar na validação de dados ou false se ela rejeitar totalmente a entrada. |
getCriteriaType() | DataValidationCriteria | Recebe o tipo de critérios da regra, conforme definido na enumeração DataValidationCriteria . |
getCriteriaValues() | Object[] | Recebe uma matriz de argumentos para os critérios da regra. |
getHelpText() | String | Recebe o texto de ajuda da regra ou null , se nenhum texto de ajuda estiver 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 um 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 após o valor determinado. |
requireDateBefore(date) | DataValidationBuilder | Define a regra de validação de dados para exigir uma data antes do valor fornecido. |
requireDateBetween(start, end) | DataValidationBuilder | Define a regra de validação de dados para exigir uma data que esteja entre duas datas especificadas ou seja uma delas. |
requireDateEqualTo(date) | DataValidationBuilder | Define a regra de validação de dados para exigir uma data igual ao valor fornecido. |
requireDateNotBetween(start, end) | DataValidationBuilder | Define a regra de validação de dados para exigir uma data que não esteja entre duas datas especificadas e que não seja de nenhuma. |
requireDateOnOrAfter(date) | DataValidationBuilder | Define a regra de validação de dados para exigir uma data a partir do 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 especificada 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 esteja entre dois números especificados e que 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 fornecido. |
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 seja 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 especificado. |
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 critérios definidos por valores DataValidationCriteria ,
geralmente recebidos de criteria e arguments de uma regra atual. |
DataValidationCriteria
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
DATE_AFTER | Enum | Requer uma data posterior ao valor informado. |
DATE_BEFORE | Enum | Requer uma data anterior ao valor informado. |
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 informado. |
DATE_ON_OR_BEFORE | Enum | Requer uma data igual ou anterior ao valor informado. |
NUMBER_BETWEEN | Enum | Requer um número que esteja entre os valores fornecidos. |
NUMBER_EQUAL_TO | Enum | Requer um número igual ao valor fornecido. |
NUMBER_GREATER_THAN | Enum | Exigem 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 diferente do valor fornecido. |
TEXT_CONTAINS | Enum | Exige que a entrada contenha o valor informado. |
TEXT_DOES_NOT_CONTAIN | Enum | Requer que a entrada não contenha o valor informado. |
TEXT_EQUAL_TO | Enum | Exige que a entrada seja igual ao valor informado. |
TEXT_IS_VALID_EMAIL | Enum | Exige que a entrada seja 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 | Exige que a entrada seja igual a um dos valores fornecidos. |
VALUE_IN_RANGE | Enum | Exige que a entrada seja igual a um valor no intervalo informado. |
CUSTOM_FORMULA | Enum | Requer que a entrada faça a fórmula especificada ser avaliada como true . |
CHECKBOX | Enum | Exige que a entrada seja um valor personalizado ou booleano; renderizado como uma caixa de seleção. |
DateTimeGroupingRule
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getRuleType() | DateTimeGroupingRuleType | Recebe o tipo da regra de agrupamento data-hora. |
DateTimeGroupingRuleType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
UNSUPPORTED | Enum | Um tipo de regra de agrupamento de data e hora 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 | Agrupar 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 por 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 | Agrupar data-hora por dia do mês, de 1 a 31. |
DAY_MONTH | Enum | Agrupe 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 e hora por trimestre, por exemplo, Q1 (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 a esses metadados do desenvolvedor. |
getKey() | String | Retorna a chave associada aos metadados do desenvolvedor. |
getLocation() | DeveloperMetadataLocation | Retorna o local dos metadados do desenvolvedor. |
getValue() | String | Retorna o valor associado a esses metadados do desenvolvedor ou null se esses metadados não tiverem valor. |
getVisibility() | DeveloperMetadataVisibility | Retorna a visibilidade dos metadados do 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 do desenvolvedor como o valor especificado. |
setValue(value) | DeveloperMetadata | Define o valor associado a estes metadados do 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 metadados que correspondem ao ID especificado. |
withKey(key) | DeveloperMetadataFinder | Limita esta pesquisa para considerar apenas metadados que correspondem à chave especificada. |
withLocationType(locationType) | DeveloperMetadataFinder | Limita esta pesquisa para considerar apenas metadados que correspondem ao tipo de local especificado. |
withValue(value) | DeveloperMetadataFinder | Limita esta pesquisa para considerar apenas 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 Range para o 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 Range para o 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 dos metadados do desenvolvedor associados à planilha de nível superior. |
SHEET | Enum | É o tipo de local dos metadados do desenvolvedor associados a uma página inteira. |
ROW | Enum | É o tipo de local dos metadados do desenvolvedor associados a uma linha. |
COLUMN | Enum | O tipo de local dos metadados do desenvolvedor associados a uma coluna. |
DeveloperMetadataVisibility
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
DOCUMENT | Enum | Os metadados visíveis ao documento podem ser acessados em 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 da 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 | Extrai informações sobre onde o desenho está posicionado na folha. |
getHeight() | Integer | Retorna a altura real do desenho em pixels. |
getOnAction() | String | Retorna o nome da macro anexada a este desenho. |
getSheet() | Sheet | Retorna a página em que o desenho aparece. |
getWidth() | Integer | Retorna a largura real do 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 do desenho em pixels. |
setOnAction(macroName) | Drawing | Atribui uma função macro a este desenho. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | Drawing | Define a posição em que o desenho aparece na folha. |
setWidth(width) | Drawing | Define a largura real do 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 este builder 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 um 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 criador modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que ele aparece na planilha. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que o criador modifica. |
reverseCategories() | EmbeddedAreaChartBuilder | Inverte o desenho da série no eixo de domínio. |
setBackgroundColor(cssValue) | EmbeddedAreaChartBuilder | Define a cor de fundo do gráfico. |
setChartType(type) | EmbeddedChartBuilder | Altera 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 mesclagem a ser usada quando há 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 o local em que 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 da linha e da 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 este builder 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 um 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 criador modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que ele aparece na planilha. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que o criador modifica. |
reverseCategories() | EmbeddedBarChartBuilder | Inverte o desenho da série 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 de fundo do gráfico. |
setChartType(type) | EmbeddedChartBuilder | Altera 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 mesclagem a ser usada quando há 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 o local em que 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 da linha e da 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 de fonte de dados se o gráfico for de fonte de dados ou null caso contrário. |
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 tratados como cabeçalhos. |
getOptions() | ChartOptions | Retorna as opções do gráfico, como altura, cores e eixos. |
getRanges() | Range[] | Retorna os intervalos que este gráfico usa como fonte de dados. |
getTransposeRowsAndColumns() | 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 este builder 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 um 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 criador modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que ele aparece na planilha. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que o criador modifica. |
setChartType(type) | EmbeddedChartBuilder | Altera 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 mesclagem a ser usada quando há 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 o local em que 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 este builder 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 um 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 criador modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que ele aparece na planilha. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que o criador modifica. |
reverseCategories() | EmbeddedColumnChartBuilder | Inverte o desenho da série no eixo de domínio. |
setBackgroundColor(cssValue) | EmbeddedColumnChartBuilder | Define a cor de fundo do gráfico. |
setChartType(type) | EmbeddedChartBuilder | Altera 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 mesclagem a ser usada quando há 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 o local em que 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 da linha e da 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 este builder 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 um 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 criador modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que ele aparece na planilha. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que o criador modifica. |
reverseCategories() | EmbeddedComboChartBuilder | Inverte o desenho da série no eixo de domínio. |
setBackgroundColor(cssValue) | EmbeddedComboChartBuilder | Define a cor de fundo do gráfico. |
setChartType(type) | EmbeddedChartBuilder | Altera 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 mesclagem a ser usada quando há 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 o local em que 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 da linha e da 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 este builder 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 um 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 criador modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que ele aparece na planilha. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que o criador modifica. |
reverseCategories() | EmbeddedHistogramChartBuilder | Inverte o desenho da série no eixo de domínio. |
setBackgroundColor(cssValue) | EmbeddedHistogramChartBuilder | Define a cor de fundo do gráfico. |
setChartType(type) | EmbeddedChartBuilder | Altera 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 mesclagem a ser usada quando há 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 o local em que 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 da linha e da 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 este builder 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 um 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 criador modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que ele aparece na planilha. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que o criador modifica. |
reverseCategories() | EmbeddedLineChartBuilder | Inverte o desenho da série no eixo de domínio. |
setBackgroundColor(cssValue) | EmbeddedLineChartBuilder | Define a cor de fundo do gráfico. |
setChartType(type) | EmbeddedChartBuilder | Altera 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 mesclagem a ser usada quando há 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 o local em que 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 este builder 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 um 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 criador modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que ele aparece na planilha. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que o criador modifica. |
reverseCategories() | EmbeddedPieChartBuilder | Inverte o desenho da série no eixo de domínio. |
set3D() | EmbeddedPieChartBuilder | Define o gráfico como tridimensional. |
setBackgroundColor(cssValue) | EmbeddedPieChartBuilder | Define a cor de fundo do gráfico. |
setChartType(type) | EmbeddedChartBuilder | Altera 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 mesclagem a ser usada quando há 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 o local em que 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 este builder 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 um 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 criador modifica. |
getChartType() | ChartType | Retorna o tipo de gráfico atual. |
getContainer() | ContainerInfo | Retorne o gráfico ContainerInfo , que encapsula o local em que ele aparece na planilha. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que o criador modifica. |
setBackgroundColor(cssValue) | EmbeddedScatterChartBuilder | Define a cor de fundo do gráfico. |
setChartType(type) | EmbeddedChartBuilder | Altera 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 mesclagem a ser usada quando há 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 o local em que 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 | Torna o eixo horizontal em uma escala logarítmica (exige 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 (exige 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 este builder 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 um 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 criador modifica. |
enablePaging(enablePaging) | EmbeddedTableChartBuilder | Define se a paginação pelos dados será ativada. |
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 da página 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 coluna 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 ele aparece na planilha. |
getRanges() | Range[] | Retorna uma cópia da lista de intervalos que atualmente fornecem dados para o gráfico. |
removeRange(range) | EmbeddedChartBuilder | Remove o intervalo especificado do gráfico que o criador modifica. |
setChartType(type) | EmbeddedChartBuilder | Altera 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 deve 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 mesclagem a ser usada quando há 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 o local em que 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 cores alternadas será atribuído às linhas pares e ímpares de um 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. |
getRange() | Range | Extrai 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 | Os critérios deste filtro são copiados e um criador de critérios é criado 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ério 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 adicionadas ao criador de critérios. |
copy() | FilterCriteriaBuilder | Os critérios deste filtro são copiados e um criador de critérios é criado 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ério 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 que serão mostrados em uma tabela dinâmica. |
whenCellEmpty() | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células vazias. |
whenCellNotEmpty() | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células que não estão vazias. |
whenDateAfter(date) | FilterCriteriaBuilder | Define os critérios de filtro que mostram células com datas posteriores à data especificada. |
whenDateAfter(date) | FilterCriteriaBuilder | Define os critérios de filtro que mostram células com datas posteriores à data relativa especificada. |
whenDateBefore(date) | FilterCriteriaBuilder | Define os critérios de filtro que mostram células com datas anteriores à data especificada. |
whenDateBefore(date) | FilterCriteriaBuilder | Define os critérios de filtro que mostram células com datas anteriores à data relativa especificada. |
whenDateEqualTo(date) | FilterCriteriaBuilder | Define os critérios de filtro que mostram células com datas iguais à data especificada. |
whenDateEqualTo(date) | FilterCriteriaBuilder | Define os critérios de filtro que mostram células com datas iguais à data relativa especificada. |
whenDateEqualToAny(dates) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com datas que sejam iguais a qualquer uma das datas especificadas. |
whenDateNotEqualTo(date) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células que não são 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 deles. |
whenNumberEqualTo(number) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com um número igual ao número 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 número 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 número 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 que as células com um número são iguais e não são nenhum dos 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 seja 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 contenha o texto especificado. |
whenTextEndsWith(text) | FilterCriteriaBuilder | Define os critérios de filtro para mostrar células com texto que termina 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 qualquer um 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 | São atualizados toda semana, em determinados dias da semana. |
MONTHLY | Enum | Atualizar 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 dessa condição de gradiente. |
getMaxType() | InterpolationType | Recebe o tipo de interpolação para o valor máximo dessa 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 de 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 de controle desse grupo. |
getDepth() | Integer | Retorna a profundidade desse grupo. |
getRange() | Range | Retorna o intervalo no qual esse 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 o 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 de função 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 horizontal do pixel da célula âncora. |
getAnchorCellYOffset() | Integer | Retorna o deslocamento vertical do pixel da célula âncora. |
getHeight() | Integer | Retorna a altura real da imagem em pixels. |
getInherentHeight() | Integer | Retorna a altura inerente dessa imagem em pixels. |
getInherentWidth() | Integer | Retorna a altura inerente dessa imagem em pixels. |
getScript() | String | Retorna o nome da função atribuída a essa imagem. |
getSheet() | Sheet | Retorna a página em que essa imagem aparece. |
getUrl() | String | Recebe o URL de origem da imagem. Retorna null se o URL não está disponível. |
getWidth() | Integer | Retorna a largura real dessa imagem em pixels. |
remove() | void | Exclui a imagem da planilha. |
replace(blob) | OverGridImage | Substitui essa imagem pela especificada pelo BlobSource fornecido. |
replace(url) | OverGridImage | Substitui essa imagem pela do URL especificado. |
resetSize() | OverGridImage | Redefine a imagem para as dimensões inerentes. |
setAltTextDescription(description) | OverGridImage | Define a descrição de texto alternativo para esta imagem. |
setAltTextTitle(title) | OverGridImage | Define o título do texto alternativo para esta imagem. |
setAnchorCell(cell) | OverGridImage | Define a célula onde uma imagem está ancorada. |
setAnchorCellXOffset(offset) | OverGridImage | Define o deslocamento horizontal do pixel a partir da célula âncora. |
setAnchorCellYOffset(offset) | OverGridImage | Define o deslocamento vertical do pixel da célula âncora. |
setHeight(height) | OverGridImage | Define a altura real da imagem em pixels. |
setWidth(width) | OverGridImage | Define a largura real da 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 da fonte de dados em que o filtro opera. |
remove() | void | Remove o filtro dinâmico da tabela. |
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 para este grupo dinâmico. |
areLabelsRepeated() | Boolean | Retorna se os rótulos são exibidos como repetidos. |
clearGroupingRule() | PivotGroup | Remove todas as regras de agrupamento deste grupo dinâmico. |
clearSort() | PivotGroup | Remove qualquer classificação aplicada a este grupo. |
getDateTimeGroupingRule() | DateTimeGroupingRule | Retorna a regra de agrupamento de data e hora no grupo dinâmico ou null se nenhuma regra de agrupamento de data-hora estiver definida. |
getDimension() | Dimension | Retorna se este é um grupo de linhas ou colunas. |
getGroupLimit() | PivotGroupLimit | Retorna o limite do grupo dinâmico. |
getIndex() | Integer | Retorna o índice desse grupo dinâmico na ordem de grupo atual. |
getPivotTable() | PivotTable | Retorna o PivotTable ao qual esse 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 na qual o grupo dinâmico opera. |
hideRepeatedLabels() | PivotGroup | Oculta os rótulos repetidos deste agrupamento. |
isSortAscending() | Boolean | Retorna true se a classificação for crescente, retorna false se a ordem de classificação 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 o 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 deste 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 deste 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 mostrados ou não 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 no momento para este grupo dinâmico. |
PivotGroupLimit
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getCountLimit() | Integer | Extrai o limite de contagem em linhas ou colunas no grupo dinâmico. |
getPivotGroup() | PivotGroup | Retorna o grupo dinâmico ao qual 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 com base no formula especificado com
o name especificado. |
addColumnGroup(sourceDataColumn) | PivotGroup | Define um novo agrupamento de colunas dinâmicas na tabela dinâmica. |
addFilter(sourceDataColumn, filterCriteria) | PivotFilter | Cria um novo filtro dinâmico para a tabela dinâmica. |
addPivotValue(sourceDataColumn, summarizeFunction) | PivotValue | Define um novo valor dinâmico na tabela com o summarizeFunction especificado. |
addRowGroup(sourceDataColumn) | PivotGroup | Define um novo agrupamento de linhas dinâmicas na tabela dinâmica. |
asDataSourcePivotTable() | DataSourcePivotTable | Retorna a tabela dinâmica como uma tabela dinâmica de fonte de dados se ela estiver vinculada a um DataSource , ou null , caso contrário. |
getAnchorCell() | Range | Retorna o Range que representa a célula em que esta 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 da 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 CONT.NÚM |
COUNTUNIQUE | Enum | A função COUNTUNIQUE |
AVERAGE | Enum | A função AVERAGE |
MAX | Enum | A função MÁXIMO |
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 é mostrado 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 que o valor dinâmico resume. |
getSourceDataSourceColumn() | DataSourceColumn | Retorna a coluna de fonte de dados resumido 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 | Mostra valores dinâmicos como porcentagem do total de uma linha. |
PERCENT_OF_COLUMN_TOTAL | Enum | Exibe valores dinâmicos como uma porcentagem do total de uma 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 especificado à lista de editores da página ou do intervalo protegido. |
addEditor(user) | Protection | Adiciona o usuário especificado à 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 protegida. |
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 da página protegida. |
getEditors() | User[] | Extrai a lista de editores para o intervalo ou a página protegida. |
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 IDs 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 "com base 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 da página ou do intervalo protegido. |
setDomainEdit(editable) | Protection | Define se todos os usuários no domínio proprietário da planilha têm permissão para editar a página ou o intervalo protegido. |
setNamedRange(namedRange) | Protection | Associa o intervalo protegido a um intervalo nomeado existente. |
setRange(range) | Protection | Ajusta o intervalo que é protegido. |
setRangeName(rangeName) | Protection | Associa o intervalo protegido a um intervalo nomeado existente. |
setUnprotectedRanges(ranges) | Protection | Desprotege a matriz de intervalos especificada em uma página protegida. |
setWarningOnly(warningOnly) | Protection | Define se esse 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 o 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 do desenvolvedor com a chave especificada ao intervalo. |
addDeveloperMetadata(key, visibility) | Range | Adiciona metadados do desenvolvedor com a chave especificada e a visibilidade ao intervalo. |
|