Class EmbeddedTableChartBuilder

Adiciona um intervalo ao gráfico que este construtor modifica. Não adiciona o intervalo se já tiver sido adicionados ao gráfico.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(sheet.getRange("A1:B8"))
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

Parâmetros

Retornar

EmbeddedChartBuilder: este builder para encadeamento

Define o tipo de gráfico como Gráfico de Área e retorna um EmbeddedAreaChartBuilder.

Retornar

EmbeddedAreaChartBuilder: um builder para um gráfico de área.

Define o tipo de gráfico como BarChart e retorna um EmbeddedBarChartBuilder.

Retornar

EmbeddedBarChartBuilder: um builder para um gráfico de barras.

Define o tipo de gráfico como ColumnChart e retorna um EmbeddedColumnChartBuilder.

Retornar

EmbeddedColumnChartBuilder: um builder para um gráfico de colunas.

Define o tipo de gráfico como ComboChart e retorna um EmbeddedComboChartBuilder.

Retornar

EmbeddedComboChartBuilder: um builder para um gráfico de combinação.

Define o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder.

Retornar

EmbeddedHistogramChartBuilder: um builder para um gráfico de histograma.

Define o tipo de gráfico como LineChart e retorna um EmbeddedLineChartBuilder.

Retornar

EmbeddedLineChartBuilder: um builder para um gráfico de linhas.

Define o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder.

Retornar

EmbeddedPieChartBuilder: um builder para um gráfico de pizza.

Define o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder.

Retornar

EmbeddedScatterChartBuilder: um builder para um gráfico de dispersão.

Define o tipo de gráfico como TableChart e retorna um EmbeddedTableChartBuilder.

Retornar

EmbeddedTableChartBuilder: um builder para um gráfico de tabela.

Cria o gráfico para refletir todas as alterações feitas nele.

Esse método não desenha automaticamente o gráfico na parte superior da planilha. Um novo gráfico precisa ser inserido por meio de sheet.insertChart(chart) e atualizar um gráfico existente via sheet.updateChart(chart).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(range)
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

Retornar

EmbeddedChart: o gráfico criado, que ainda precisa ser adicionado à planilha.

Remove todos os intervalos do gráfico que este criador modifica.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This code updates the chart to use only the new ranges while preserving the existing
// formatting of the chart.
var chart = sheet.getCharts()[0];
var newChart = chart
    .modify()
    .clearRanges()
    .addRange(sheet.getRange("A1:A5"))
    .addRange(sheet.getRange("B1:B5"))
    .build();
sheet.updateChart(newChart);

Retornar

EmbeddedChartBuilder: este builder para encadeamento

Define se a paginação pelos 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

Retornar

EmbeddedTableChartBuilder: esse builder, útil para encadeamentos.

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.
var builder = Charts.newTableChart();
builder.enablePaging(5);

Parâmetros

Retornar

EmbeddedTableChartBuilder: esse builder, útil para encadeamentos.

Ativa a paginação, define o número de linhas em cada página e a primeira página da tabela a ser exibida (página e números 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.
var builder = Charts.newTableChart();
builder.enablePaging(5, 2);

Parâmetros

Retornar

EmbeddedTableChartBuilder: esse builder, útil para encadeamentos.

Adiciona suporte básico a idiomas escritos da direita para a esquerda (como árabe ou hebraico) invertendo o a ordem das colunas da tabela, de modo que a coluna zero seja a coluna mais à direita e a última seja na coluna mais à esquerda.

Isso não afeta o índice da coluna nos dados subjacentes, apenas a ordem de exibição. A exibição de idiomas bidirecional (BiDi) total não é suportada pela visualização de tabela, mesmo com essa opção. Esta opção será ignorada se você ativar a paginação (usando a opção de página) ou se a tabela tem barras de rolagem porque você especificou opções de altura e largura menores que as tamanho de tabela necessário. O comportamento padrão é o suporte a RTL desativado.

Parâmetros

Retornar

EmbeddedTableChartBuilder: esse builder, útil para encadeamentos.

Define se as colunas serão classificadas quando o usuário clicar no cabeçalho de uma coluna.

Se a classificação estiver ativada, quando os usuários clicarem no cabeçalho da coluna, as linhas serão automaticamente classificados. O comportamento padrão é a classificação ativada.

Parâmetros

Retornar

EmbeddedTableChartBuilder: esse builder, útil para encadeamentos.

Retorna o tipo de gráfico atual.

Retornar

ChartType: o tipo de gráfico.

Retorne o gráfico ContainerInfo, que encapsula onde ele aparece na folha

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var 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()
var containerInfo = chartBuilder.getContainer();

// Logs the values we 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

ContainerInfo: um objeto que contém a posição do contêiner do gráfico.

Retorna uma cópia da lista de intervalos que atualmente fornecem dados para este gráfico. Use addRange(range) e removeRange(range) para modificar essa lista.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var chartBuilder = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(sheet.getRange("A1:B8"))
    .setPosition(5, 5, 0, 0);

var ranges = chartBuilder.getRanges();

// There's only one range as a data source for this chart,
// so this logs "A1:B8"
for (var i in ranges) {
  var range = ranges[i];
  Logger.log(range.getA1Notation());
}

Retornar

Range[]: uma matriz de intervalos que servem como a fonte de dados do gráfico a ser criado.

Remove o intervalo especificado do gráfico que este construtor modifica. Não gera um erro se o intervalo não consta no gráfico.

O intervalo removido precisa corresponder a um intervalo adicionado por meio de addRange(range). caso contrário, o gráfico não será alterado. Este método não pode ser usado para remover parcialmente valores de um intervalo.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var firstRange = sheet.getRange("A1:B5");
var secondRange = sheet.getRange("A6:B8");

var chartBuilder = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(firstRange)
    // This range will render 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
// will not be removed, and will not throw an exception
chartBuilder.removeRange(firstRange);
chartBuilder.removeRange(sheet.getRange("A6:B8"));

var chart = chartBuilder.build();

sheet.insertChart(chart);

Parâmetros

Retornar

EmbeddedChartBuilder: este builder para encadeamento

Muda o tipo de gráfico. No momento, nem todos os tipos de gráficos incorporados são compatíveis. Consulte ChartType.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(range)
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

Parâmetros

Retornar

EmbeddedChartBuilder: este builder para encadeamento

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.
var builder = Charts.newTableChart();
builder.setFirstRowNumber(2);

Parâmetros

Retornar

EmbeddedTableChartBuilder: esse builder, útil para encadeamentos.

Define a estratégia a ser usada para linhas e colunas ocultas. O valor padrão é IGNORE_ROWS.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var 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

Retornar

EmbeddedChartBuilder: este builder para encadeamento

Define o índice da coluna de acordo com o qual a tabela será inicialmente classificada (crescente).

A coluna está 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).
var builder = Charts.newTableChart();
builder.setInitialSortingAscending(2);

Parâmetros

Retornar

EmbeddedTableChartBuilder: esse builder, útil para encadeamentos.

Define o índice da coluna de acordo com o qual a tabela será inicialmente classificada (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).
var builder = Charts.newTableChart();
builder.setInitialSortingDescending(2);

Parâmetros

Retornar

EmbeddedTableChartBuilder: esse builder, útil para encadeamentos.

Define a estratégia de mesclagem a ser usada quando existir mais de um intervalo. Se for MERGE_ROWS, as linhas serão mescladas. Se for MERGE_COLUMNS, as colunas serão mescladas. O valor padrão é MERGE_COLUMNS.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B10");
var range2 = sheet.getRange("C:C10");
var 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

Retornar

EmbeddedChartBuilder: este builder para encadeamento

Define o número de linhas ou colunas do intervalo que devem ser tratadas como cabeçalhos.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(range)
    .setNumHeaders(1)
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

Parâmetros

Retornar

EmbeddedChartBuilder: este builder para encadeamento

Define opções avançadas para este gráfico. Para visualizar uma lista das opções disponíveis, consulte Gráfico de configuração do Terraform.

Este método não valida a opção especificada como válida para este 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.

builder.setOption('title', 'Earnings projections');
builder.setOption('legend', {position: 'top', textStyle: {color: 'blue', fontSize: 16}});

Parâmetros

Retornar

EmbeddedChartBuilder: este builder para encadeamento.

Define a posição, alterando o local em que o gráfico aparece na página. anchorRowPos e anchorColPos estão indexadas com 1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(range)
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

Parâmetros

Retornar

EmbeddedChartBuilder: este builder para encadeamento

Define se as linhas e colunas do gráfico são transpostas. Se definido como true, as linhas e as colunas são trocadas. O padrão é false.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(range)
    .setTransposeRowsAndColumns(true)
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

Parâmetros

Retornar

EmbeddedChartBuilder: este builder para encadeamento

Define se o número da linha será mostrado como a primeira coluna da tabela.

O comportamento padrão é não mostrar números de linha.

Parâmetros

Retornar

EmbeddedTableChartBuilder: esse builder, útil para encadeamentos.

Define se o estilo de cores alternadas é atribuído a linhas pares e ímpares de um gráfico de tabela.

O comportamento padrão são as linhas com estilo de cores alternadas.

Parâmetros

Retornar

EmbeddedTableChartBuilder: esse builder, útil para encadeamentos.