Esta página foi traduzida pela API Cloud Translation.

Class EmbeddedTableChartBuilder

Criador de gráficos de tabela. Veja mais detalhes na documentação da Gviz (em inglês).

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 builder modifica.
`enablePaging(enablePaging)`	`EmbeddedTableChartBuilder`	Define se a paginação será ativada pelos dados.
`enablePaging(pageSize)`	`EmbeddedTableChartBuilder`	Ativa a paginação e define o número de linhas em cada página.
`enablePaging(pageSize, startPage)`	`EmbeddedTableChartBuilder`	Ativa a paginação, define o número de linhas em cada página e a primeira página de tabela a ser exibida (os números de página são baseados em zero).
`enableRtlTable(rtlEnabled)`	`EmbeddedTableChartBuilder`	Adiciona compatibilidade básica com idiomas da direita para a esquerda (como árabe ou hebraico) invertendo a ordem das colunas da tabela, de modo que a coluna zero seja a coluna mais à direita e a última coluna seja a mais à esquerda.
`enableSorting(enableSorting)`	`EmbeddedTableChartBuilder`	Define se as colunas serão classificadas quando o usuário clicar no título 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 página.
`getRanges()`	`Range[]`	Retorna uma cópia da lista de intervalos que estão fornecendo dados para este gráfico no momento.
`removeRange(range)`	`EmbeddedChartBuilder`	Remove o intervalo especificado do gráfico que este builder 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 em que a tabela precisa ser classificada inicialmente (crescente).
`setInitialSortingDescending(column)`	`EmbeddedTableChartBuilder`	Define o índice da coluna em que a tabela precisa ser classificada inicialmente (decrescente).
`setMergeStrategy(mergeStrategy)`	`EmbeddedChartBuilder`	Define a estratégia de combinação a ser usada quando houver mais de um intervalo.
`setNumHeaders(headers)`	`EmbeddedChartBuilder`	Define o número de linhas ou colunas do intervalo que deve ser tratado como cabeçalhos.
`setOption(option, value)`	`EmbeddedChartBuilder`	Define opções avançadas para este gráfico.
`setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)`	`EmbeddedChartBuilder`	Define a posição, alterando o local em que o gráfico aparece na página.
`setTransposeRowsAndColumns(transpose)`	`EmbeddedChartBuilder`	Define se as linhas e as colunas do gráfico são transpostas.
`showRowNumberColumn(showRowNumber)`	`EmbeddedTableChartBuilder`	Define se o número da linha deve ser exibido como a primeira coluna da tabela.
`useAlternatingRowStyle(alternate)`	`EmbeddedTableChartBuilder`	Define se o estilo de cores alternadas é atribuído a linhas pares e ímpares de um gráfico de tabela.

Documentação detalhada

`addRange(range)`

Adiciona um intervalo ao gráfico que este builder modifica. Não adiciona o intervalo se ele já foi adicionado 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

Nome	Tipo	Descrição
`range`	`Range`	O intervalo a ser adicionado.

Retornar

EmbeddedChartBuilder: este builder, para encadeamento

`asAreaChart()`

Define o tipo de gráfico como AreaChart e retorna um EmbeddedAreaChartBuilder.

Retornar

EmbeddedAreaChartBuilder: um criador para um gráfico de área

`asBarChart()`

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

Retornar

EmbeddedBarChartBuilder: um builder para um gráfico de barras

`asColumnChart()`

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

Retornar

EmbeddedColumnChartBuilder: um builder para um gráfico de colunas

`asComboChart()`

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

Retornar

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

`asHistogramChart()`

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

Retornar

EmbeddedHistogramChartBuilder: um builder para um gráfico de histograma

`asLineChart()`

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

Retornar

EmbeddedLineChartBuilder: um criador para um gráfico de linhas

`asPieChart()`

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

Retornar

EmbeddedPieChartBuilder: um criador para um gráfico de pizza

`asScatterChart()`

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

Retornar

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

`asTableChart()`

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

Retornar

EmbeddedTableChartBuilder: um builder para um gráfico de tabela

`build()`

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 via sheet.insertChart(chart), e um gráfico existente precisa ser atualizado por 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.

`clearRanges()`

Remove todos os intervalos do gráfico que este builder 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

`enablePaging(enablePaging)`

Define se a paginação será ativada pelos dados.

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
`enablePaging`	`Boolean`	`true` se a paginação for ativada. Caso contrário, `false`.

Retornar

EmbeddedTableChartBuilder: este builder, útil para encadeamentos.

`enablePaging(pageSize)`

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

Nome	Tipo	Descrição
`pageSize`	`Integer`	o número de linhas em cada página da tabela;

Retornar

EmbeddedTableChartBuilder: este builder, útil para encadeamentos.

`enablePaging(pageSize, startPage)`

Ativa a paginação, define o número de linhas em cada página e a primeira página de tabela a ser exibida (os números de página são baseados em zero).

O tamanho padrão da página é 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

Nome	Tipo	Descrição
`pageSize`	`Integer`	o número de linhas em cada página da tabela;
`startPage`	`Integer`	A primeira página da tabela a ser exibida (os números das páginas são baseados em zero).

Retornar

EmbeddedTableChartBuilder: este builder, útil para encadeamentos.

`enableRtlTable(rtlEnabled)`

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

Isso não afeta o índice da coluna nos dados, apenas a ordem de exibição. A visualização em tabela bidirecional (BiDi) completa não é compatível com a visualização em tabela, mesmo com essa opção. Essa opção será ignorada se você ativar a paginação (usando a opção de página) ou se a tabela tiver barras de rolagem porque as opções de altura e largura especificadas são menores que o tamanho da tabela necessário. O comportamento padrão é a compatibilidade com RTL desativada.

Parâmetros

Nome	Tipo	Descrição
`rtlEnabled`	`Boolean`	`true`, se o suporte da direita para a esquerda precisar ser ativado. Caso contrário, use `false`.

Retornar

EmbeddedTableChartBuilder: este builder, útil para encadeamentos.

`enableSorting(enableSorting)`

Define se as colunas serão classificadas quando o usuário clicar no título de uma 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 é classificação ativada.

Parâmetros

Nome	Tipo	Descrição
`enableSorting`	`Boolean`	Use `true` para ativar a classificação clicando nos cabeçalhos das colunas. Caso contrário, use `false`.

Retornar

EmbeddedTableChartBuilder: este builder, útil para encadeamentos.

`getChartType()`

Retorna o tipo de gráfico atual.

Retornar

ChartType: o tipo de gráfico

`getContainer()`

Retorne o gráfico ContainerInfo, que encapsula o local em que ele aparece na página.

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 de gráfico

`getRanges()`

Retorna uma cópia da lista de intervalos que estão fornecendo dados para este gráfico no momento. 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 gráfico para ser criada a fonte de dados

`removeRange(range)`

Remove o intervalo especificado do gráfico que este builder modifica. Não gera um erro se o intervalo não está neste gráfico.

O intervalo removido precisa corresponder a um intervalo adicionado usando addRange(range). 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.

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

Nome	Tipo	Descrição
`range`	`Range`	O intervalo a ser removido.

Retornar

EmbeddedChartBuilder: este builder, para encadeamento

`setChartType(type)`

Altera o tipo de gráfico. Nem todos os tipos de gráficos incorporados estão disponíveis no momento. Consulte os 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

Nome	Tipo	Descrição
`type`	`ChartType`	O tipo para o qual este gráfico será alterado.

Retornar

EmbeddedChartBuilder: este builder, para encadeamento

`setFirstRowNumber(number)`

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

Nome	Tipo	Descrição
`number`	`Integer`	O número da primeira linha na tabela de dados.

Retornar

EmbeddedTableChartBuilder: este builder, útil para encadeamentos.

`setHiddenDimensionStrategy(strategy)`

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

Nome	Tipo	Descrição
`strategy`	`ChartHiddenDimensionStrategy`	A estratégia a ser usada para linhas e colunas ocultas.

Retornar

EmbeddedChartBuilder: este builder, para encadeamento

`setInitialSortingAscending(column)`

Define o índice da coluna em que a tabela precisa ser classificada inicialmente (crescente).

A coluna "os" foi classificada em ordem crescente e está marcada com uma seta pequena indicando isso.

// Creates a table chart builder and sorts it by the second column (ascending).
var builder = Charts.newTableChart();
builder.setInitialSortingAscending(2);

Parâmetros

Nome	Tipo	Descrição
`column`	`Integer`	O número da coluna em que a tabela precisa ser classificada inicialmente.

Retornar

EmbeddedTableChartBuilder: este builder, útil para encadeamentos.

`setInitialSortingDescending(column)`

Define o índice da coluna em que a tabela precisa ser classificada inicialmente (decrescente).

A coluna "os" é classificada em ordem decrescente e é marcada com uma seta pequena indicando isso.

// Creates a table chart builder and sorts it by the second column (descending).
var builder = Charts.newTableChart();
builder.setInitialSortingDescending(2);

Parâmetros

Nome	Tipo	Descrição
`column`	`Integer`	O número da coluna em que a tabela precisa ser classificada inicialmente.

Retornar

EmbeddedTableChartBuilder: este builder, útil para encadeamentos.

`setMergeStrategy(mergeStrategy)`

Define a estratégia de combinação a ser usada quando houver mais de um intervalo. Se for MERGE_ROWS, as linhas serão mescladas. Caso 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

Nome	Tipo	Descrição
`mergeStrategy`	`ChartMergeStrategy`	A estratégia de combinação a ser usada.

Retornar

EmbeddedChartBuilder: este builder, para encadeamento

`setNumHeaders(headers)`

Define o número de linhas ou colunas do intervalo que deve ser tratado 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

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

EmbeddedChartBuilder: este builder, para encadeamento

`setOption(option, value)`

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

Esse método não valida a opção que você especifica é válida para esse tipo de gráfico, nem se o valor é do 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

Nome	Tipo	Descrição
`option`	`String`	Nome da opção.
`value`	`Object`	Valor da opção.

Retornar

EmbeddedChartBuilder: este builder, para encadeamento.

`setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)`

Define a posição, alterando o local em que o gráfico aparece na página. anchorRowPos e anchorColPos têm indexação 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

Nome	Tipo	Descrição
`anchorRowPos`	`Integer`	A parte superior do gráfico está ancorada nesta linha.
`anchorColPos`	`Integer`	O lado esquerdo do gráfico está ancorado nesta coluna.
`offsetX`	`Integer`	O canto superior direito do gráfico é deslocado por muitos pixels.
`offsetY`	`Integer`	O canto inferior esquerdo do gráfico está deslocado por muitos pixels.

Retornar

EmbeddedChartBuilder: este builder, para encadeamento

`setTransposeRowsAndColumns(transpose)`

Define se as linhas e as colunas do gráfico são transpostas. Se definido como true, as linhas e colunas serão alternadas. 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

Nome	Tipo	Descrição
`transpose`	`Boolean`	Se `true`, as linhas e colunas usadas para construir o gráfico serão transpostas.

Retornar

EmbeddedChartBuilder: este builder, para encadeamento

`showRowNumberColumn(showRowNumber)`

Define se o número da linha deve ser exibido como a primeira coluna da tabela.

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

Parâmetros

Nome	Tipo	Descrição
`showRowNumber`	`Boolean`	`true`: se a primeira coluna da tabela mostrar o número da linha. Caso contrário, `false`.

Retornar

EmbeddedTableChartBuilder: este builder, útil para encadeamentos.

`useAlternatingRowStyle(alternate)`

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 cor alternada.

Parâmetros

Nome	Tipo	Descrição
`alternate`	`Boolean`	`true` se os estilos de cores forem alternados, caso contrário, `false`.

Retornar

EmbeddedTableChartBuilder: este builder, útil para encadeamentos.