Builder para gráficos de tabela. Para mais detalhes, consulte a documentação da Gviz.
Métodos
| Método | Tipo de retorno | Breve descrição | 
|---|---|---|
| add | Embedded | Adiciona um intervalo ao gráfico que este builder modifica. | 
| as | Embedded | Define o tipo de gráfico como AreaChart e retorna um Embedded. | 
| as | Embedded | Define o tipo de gráfico como BarChart e retorna um Embedded. | 
| as | Embedded | Define o tipo de gráfico como "ColumnChart" e retorna um Embedded. | 
| as | Embedded | Define o tipo de gráfico como "ComboChart" e retorna um Embedded. | 
| as | Embedded | Define o tipo de gráfico como HistogramChart e retorna um Embedded. | 
| as | Embedded | Define o tipo de gráfico como LineChart e retorna um Embedded. | 
| as | Embedded | Define o tipo de gráfico como PieChart e retorna um Embedded. | 
| as | Embedded | Define o tipo de gráfico como "ScatterChart" e retorna um Embedded. | 
| as | Embedded | Define o tipo de gráfico como TableChart e retorna um Embedded. | 
| build() | Embedded | Cria o gráfico para refletir todas as mudanças feitas nele. | 
| clear | Embedded | Remove todos os intervalos do gráfico que este builder modifica. | 
| enable | Embedded | Define se a paginação dos dados será ativada. | 
| enable | Embedded | Ativa a paginação e define o número de linhas em cada página. | 
| enable | Embedded | Ativa a paginação, define o número de linhas em cada página e a primeira página da tabela a ser exibida (os números das páginas são baseados em zero). | 
| enable | Embedded | Adiciona suporte básico para idiomas da direita para a esquerda (como árabe ou hebraico) invertendo a ordem das colunas da tabela. Assim, a coluna zero é a mais à direita, e a última coluna é a mais à esquerda. | 
| enable | Embedded | Define se as colunas serão classificadas quando o usuário clicar em um cabeçalho de coluna. | 
| get | Chart | Retorna o tipo de gráfico atual. | 
| get | Container | Retorna o gráfico Container, que encapsula onde ele aparece na planilha. | 
| get | Range[] | Retorna uma cópia da lista de intervalos que fornecem dados para este gráfico. | 
| remove | Embedded | Remove o intervalo especificado do gráfico que este builder modifica. | 
| set | Embedded | Muda o tipo de gráfico. | 
| set | Embedded | Define o número da primeira linha na tabela de dados. | 
| set | Embedded | Define a estratégia a ser usada para linhas e colunas ocultas. | 
| set | Embedded | Define o índice da coluna de acordo com a qual a tabela deve ser classificada inicialmente (em ordem crescente). | 
| set | Embedded | Define o índice da coluna de acordo com a qual a tabela deve ser classificada inicialmente (em ordem decrescente). | 
| set | Embedded | Define a estratégia de mesclagem a ser usada quando houver mais de um intervalo. | 
| set | Embedded | Define o número de linhas ou colunas do intervalo que devem ser tratados como cabeçalhos. | 
| set | Embedded | Define opções avançadas para este gráfico. | 
| set | Embedded | Define a posição, mudando onde o gráfico aparece na planilha. | 
| set | Embedded | Define se as linhas e colunas do gráfico são transpostas. | 
| show | Embedded | Define se o número da linha vai aparecer como a primeira coluna da tabela. | 
| use | Embedded | Define se o estilo de cores alternadas é atribuído a linhas pares e ímpares de um gráfico de tabela. | 
Documentação detalhada
add
Adiciona um intervalo ao gráfico que este builder modifica. Não adiciona o intervalo se ele já foi adicionado ao gráfico.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange('A1:B8')) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| range | Range | O intervalo a ser adicionado. | 
Retornar
Embedded: este builder, para encadeamento.
as
Define o tipo de gráfico como AreaChart e retorna um Embedded.
Retornar
Embedded: um builder para um gráfico de área.
as
Define o tipo de gráfico como BarChart e retorna um Embedded.
Retornar
Embedded: um criador de gráficos de barras.
as
Define o tipo de gráfico como "ColumnChart" e retorna um Embedded.
Retornar
Embedded: um builder para um gráfico de colunas.
as
Define o tipo de gráfico como "ComboChart" e retorna um Embedded.
Retornar
Embedded: um builder para um gráfico de combinação.
as
Define o tipo de gráfico como HistogramChart e retorna um Embedded.
Retornar
Embedded: um criador de histograma.
as
Define o tipo de gráfico como LineChart e retorna um Embedded.
Retornar
Embedded: um criador para um gráfico de linhas.
as
Define o tipo de gráfico como PieChart e retorna um Embedded.
Retornar
Embedded: um builder para um gráfico de pizza.
as
Define o tipo de gráfico como "ScatterChart" e retorna um Embedded.
Retornar
Embedded: um builder para um gráfico de dispersão.
as
Define o tipo de gráfico como TableChart e retorna um Embedded.
Retornar
Embedded: um criador de gráficos de tabela.
build()
Cria o gráfico para refletir todas as mudanças feitas nele.
Esse método não desenha automaticamente o gráfico na parte de cima da planilha. Um novo gráfico precisa ser inserido usando sheet.insertChart(chart), e um gráfico atual precisa ser atualizado usando sheet.updateChart(chart).
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Retornar
Embedded: o gráfico criado, que ainda precisa ser adicionado à planilha.
clear
Remove todos os intervalos do gráfico que este builder modifica.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This code updates the chart to use only the new ranges while preserving the // existing formatting of the chart. const chart = sheet.getCharts()[0]; const newChart = chart.modify() .clearRanges() .addRange(sheet.getRange('A1:A5')) .addRange(sheet.getRange('B1:B5')) .build(); sheet.updateChart(newChart);
Retornar
Embedded: este builder, para encadeamento.
enable
Define se a paginação dos dados será ativada.
O comportamento padrão é a paginação desativada. Se a paginação estiver ativada, o tamanho de página padrão será 10.
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| enable | Boolean | truese a paginação estiver ativada,falsecaso contrário. | 
Retornar
Embedded: esse builder, útil para encadeamento.
enable
Ativa a paginação e define o número de linhas em cada página.
O tamanho de página padrão é 10.
// Creates a table chart builder and enables paging with page size of 5. const builder = Charts.newTableChart(); builder.enablePaging(5);
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| page | Integer | O número de linhas em cada página da tabela. | 
Retornar
Embedded: esse builder, útil para encadeamento.
enable
Ativa a paginação, define o número de linhas em cada página e a primeira página da tabela a ser exibida (os números das páginas são baseados em zero).
O tamanho de página padrão é 10, e a página inicial padrão é 0.
// Creates a table chart builder and enables paging with page size of 5 and // displays page 2 first. const builder = Charts.newTableChart(); builder.enablePaging(5, 2);
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| page | Integer | O número de linhas em cada página da tabela. | 
| start | Integer | A primeira página da tabela a ser mostrada. Os números das páginas são baseados em zero. | 
Retornar
Embedded: esse builder, útil para encadeamento.
enable
Adiciona suporte básico para idiomas da direita para a esquerda (como árabe ou hebraico) invertendo a ordem das colunas da tabela. Assim, a coluna zero é a mais à direita, e a última coluna é a mais à esquerda.
Isso não afeta o índice da coluna nos dados subjacentes, apenas a ordem de exibição. A exibição completa de idiomas bidirecionais (BiDi) não é compatível com a visualização de tabela, mesmo com essa opção. Essa opção é ignorada se você ativar a paginação (usando a opção "Página") ou se a tabela tiver barras de rolagem porque você especificou opções de altura e largura menores que o tamanho necessário da tabela. O comportamento padrão é o suporte a RTL desativado.
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| rtl | Boolean | truese o suporte da direita para a esquerda precisar ser ativado. Caso contrário,false. | 
Retornar
Embedded: esse builder, útil para encadeamento.
enable
Define se as colunas serão classificadas quando o usuário clicar em um cabeçalho de coluna.
Se a classificação estiver ativada, quando os usuários clicarem no cabeçalho da coluna, as linhas serão classificadas automaticamente. O comportamento padrão é a classificação ativada.
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| enable | Boolean | truepara ativar a classificação clicando nos cabeçalhos das colunas oufalsecaso contrário. | 
Retornar
Embedded: esse builder, útil para encadeamento.
get
get
Retorna o gráfico Container, que encapsula onde ele aparece na planilha.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const chartBuilder = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange('A1:B8')) .setPosition(5, 5, 0, 0); // This method returns the exact same data as Chart#getContainerInfo() const containerInfo = chartBuilder.getContainer(); // Logs the values used in setPosition() Logger.log( 'Anchor Column: %s\r\nAnchor Row %s\r\nOffset X %s\r\nOffset Y %s', containerInfo.getAnchorColumn(), containerInfo.getAnchorRow(), containerInfo.getOffsetX(), containerInfo.getOffsetY(), );
Retornar
Container: um objeto que contém a posição do contêiner do gráfico.
get
Retorna uma cópia da lista de intervalos que fornecem dados para este gráfico. Use add e remove para modificar essa lista.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const chartBuilder = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange('A1:B8')) .setPosition(5, 5, 0, 0); const ranges = chartBuilder.getRanges(); // There's only one range as a data source for this chart, // so this logs "A1:B8" for (const i in ranges) { const range = ranges[i]; Logger.log(range.getA1Notation()); }
Retornar
Range[]: uma matriz de intervalos que servem como fonte de dados do gráfico a ser criado.
remove
Remove o intervalo especificado do gráfico que este builder modifica. Não gera um erro se o intervalo não estiver no gráfico.
O intervalo removido precisa corresponder a um intervalo adicionado via add. Caso contrário, nenhuma mudança será feita no gráfico. Esse método não pode ser usado para remover parcialmente valores de um intervalo.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const firstRange = sheet.getRange('A1:B5'); const secondRange = sheet.getRange('A6:B8'); const chartBuilder = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(firstRange) // This range renders in a different color .addRange(secondRange) .setPosition(5, 5, 0, 0); // Note that you can use either of these two formats, but the range // MUST match up with a range that was added via addRange(), or it // is not removed, and does not throw an exception chartBuilder.removeRange(firstRange); chartBuilder.removeRange(sheet.getRange('A6:B8')); const chart = chartBuilder.build(); sheet.insertChart(chart);
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| range | Range | O intervalo a ser removido. | 
Retornar
Embedded: este builder, para encadeamento.
set
Muda o tipo de gráfico. No momento, nem todos os tipos de gráficos incorporados são compatíveis. Consulte Chart.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| type | Chart | O tipo para mudar este gráfico. | 
Retornar
Embedded: este builder, para encadeamento.
set
Define o número da primeira linha na tabela de dados.
O número padrão da primeira linha é 1.
// Creates a table chart builder and sets the first row to be 2. const builder = Charts.newTableChart(); builder.setFirstRowNumber(2);
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| number | Integer | O número da primeira linha na tabela de dados. | 
Retornar
Embedded: esse builder, útil para encadeamento.
set
Define a estratégia a ser usada para linhas e colunas ocultas. O valor padrão é IGNORE_ROWS.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setHiddenDimensionStrategy( Charts.ChartHiddenDimensionStrategy.IGNORE_COLUMNS, ) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| strategy | Chart | A estratégia a ser usada para linhas e colunas ocultas. | 
Retornar
Embedded: este builder, para encadeamento.
set
Define o índice da coluna de acordo com a qual a tabela deve ser classificada inicialmente (em ordem crescente).
A coluna é classificada em ordem crescente e marcada com uma pequena seta indicando isso.
// Creates a table chart builder and sorts it by the second column (ascending). const builder = Charts.newTableChart(); builder.setInitialSortingAscending(2);
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| column | Integer | O número da coluna de acordo com a qual a tabela deve ser classificada inicialmente. | 
Retornar
Embedded: esse builder, útil para encadeamento.
set
Define o índice da coluna de acordo com a qual a tabela deve ser classificada inicialmente (em ordem decrescente).
A coluna é classificada em ordem decrescente e marcada com uma pequena seta indicando isso.
// Creates a table chart builder and sorts it by the second column (descending). const builder = Charts.newTableChart(); builder.setInitialSortingDescending(2);
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| column | Integer | O número da coluna de acordo com a qual a tabela deve ser classificada inicialmente. | 
Retornar
Embedded: esse builder, útil para encadeamento.
set
Define a estratégia de mesclagem a ser usada quando houver mais de um intervalo. Se MERGE_ROWS, as linhas serão mescladas. Se MERGE_COLUMNS, as colunas serão mescladas. O valor padrão é MERGE_COLUMNS.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B10'); const range2 = sheet.getRange('C:C10'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .addRange(range2) .setMergeStrategy(Charts.ChartMergeStrategy.MERGE_ROWS) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| merge | Chart | A estratégia de fusão a ser usada. | 
Retornar
Embedded: este builder, para encadeamento.
set
Define o número de linhas ou colunas do intervalo que devem ser tratados como cabeçalhos.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setNumHeaders(1) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| headers | Integer | O número de linhas ou colunas a serem tratadas como cabeçalhos. Valores negativos fazem com que os cabeçalhos sejam detectados automaticamente. | 
Retornar
Embedded: este builder, para encadeamento.
set
Define opções avançadas para este gráfico. Para conferir uma lista das opções disponíveis, consulte Opções de configuração de gráficos.
Esse método não valida se a opção especificada é válida para esse tipo de gráfico nem se o valor está no formato/estrutura correto.
Este exemplo mostra como mudar o título e definir uma legenda.
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); const sheet = spreadsheet.getSheets()[0]; const chart = sheet.newChart() .setOption('title', 'Earnings projections') .setOption('legend', { position: 'top', textStyle: { color: 'blue', fontSize: 16 }, }).build();
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| option | String | O nome da opção. | 
| value | Object | O valor da opção. | 
Retornar
Embedded: este builder, para encadeamento.
set
Define a posição, mudando onde o gráfico aparece na planilha. anchor e
anchor são indexados em 1.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| anchor | Integer | A parte superior do gráfico fica ancorada nessa linha. | 
| anchor | Integer | O lado esquerdo do gráfico está fixado nessa coluna. | 
| offsetX | Integer | O canto superior direito do gráfico é deslocado por essa quantidade de pixels. | 
| offsetY | Integer | O canto inferior esquerdo do gráfico é deslocado por esse número de pixels. | 
Retornar
Embedded: este builder, para encadeamento.
set
Define se as linhas e colunas do gráfico são transpostas. Se definido como true, as linhas e colunas serão trocadas. O padrão é false.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setTransposeRowsAndColumns(true) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| transpose | Boolean | Se true, as linhas e colunas usadas para construir o gráfico serão transpostas. | 
Retornar
Embedded: este builder, para encadeamento.
show
Define se o número da linha vai aparecer como a primeira coluna da tabela.
O comportamento padrão é não mostrar os números das linhas.
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| show | Boolean | truese a primeira coluna da tabela mostrar o número da linha,falsecaso contrário. | 
Retornar
Embedded: esse builder, útil para encadeamento.
use
Define se o estilo de cores alternadas é atribuído a linhas pares e ímpares de um gráfico de tabela.
O comportamento padrão é que as linhas tenham um estilo de cor alternada.
Parâmetros
| Nome | Tipo | Descrição | 
|---|---|---|
| alternate | Boolean | truese os estilos de cores precisarem ser alternados. Caso contrário,false. | 
Retornar
Embedded: esse builder, útil para encadeamento.