Class EmbeddedChartBuilder

EmbeddedChartBuilder

Builder utilizzato per modificare un EmbeddedChart. Le modifiche apportate al grafico vengono salvate solo Sheet.updateChart(chart) viene chiamato nel grafico ricreato.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B8");
var chart = sheet.getCharts()[0];
chart = chart.modify()
    .addRange(range)
    .setOption('title', 'Updated!')
    .setOption('animation.duration', 500)
    .setPosition(2,2,0,0)
    .build();
sheet.updateChart(chart);

Metodi

MetodoTipo restituitoBreve descrizione
addRange(range)EmbeddedChartBuilderAggiunge un intervallo al grafico modificato da questo generatore.
asAreaChart()EmbeddedAreaChartBuilderImposta il tipo di grafico su AreaChart e restituisce un EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderImposta il tipo di grafico su Grafico a barre e restituisce un EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderImposta il tipo di grafico su ColumnChart e restituisce un EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderImposta il tipo di grafico su ComboChart e restituisce un EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderImposta il tipo di grafico su IstogramChart e restituisce un EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderImposta il tipo di grafico su LineChart e restituisce un EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderImposta il tipo di grafico su Grafico a torta e restituisce un EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderImposta il tipo di grafico su Grafico a dispersione e restituisce un EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderImposta il tipo di grafico su TableChart e restituisce un EmbeddedTableChartBuilder.
build()EmbeddedChartCrea il grafico per riflettere tutte le modifiche apportate.
clearRanges()EmbeddedChartBuilderRimuove tutti gli intervalli dal grafico modificato da questo builder.
getChartType()ChartTypeRestituisce il tipo di grafico corrente.
getContainer()ContainerInfoRestituisce il grafico ContainerInfo, che racchiude il punto in cui appare il grafico in un foglio di calcolo.
getRanges()Range[]Restituisce una copia dell'elenco di intervalli che attualmente forniscono dati per il grafico.
removeRange(range)EmbeddedChartBuilderRimuove l'intervallo specificato dal grafico modificato da questo builder.
setChartType(type)EmbeddedChartBuilderModifica il tipo di grafico.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderConsente di impostare la strategia da utilizzare per le righe e le colonne nascoste.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderImposta la strategia di unione da utilizzare quando è presente più di un intervallo.
setNumHeaders(headers)EmbeddedChartBuilderImposta il numero di righe o colonne dell'intervallo che devono essere trattate come intestazioni.
setOption(option, value)EmbeddedChartBuilderImposta le opzioni avanzate per questo grafico.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderImposta la posizione, modificando la posizione del grafico nel foglio.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderImposta la trasposizione di righe e colonne del grafico.

Documentazione dettagliata

addRange(range)

Aggiunge un intervallo al grafico modificato da questo generatore. Non aggiunge l'intervallo se è già stato aggiunte al grafico.

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);

Parametri

NomeTipoDescrizione
rangeRangeL'intervallo da aggiungere.

Invio

EmbeddedChartBuilder: questo builder, per il concatenamento


asAreaChart()

Imposta il tipo di grafico su AreaChart e restituisce un EmbeddedAreaChartBuilder.

Invio

EmbeddedAreaChartBuilder: uno strumento per la creazione di un grafico ad area


asBarChart()

Imposta il tipo di grafico su Grafico a barre e restituisce un EmbeddedBarChartBuilder.

Invio

EmbeddedBarChartBuilder: uno strumento per la creazione di un grafico a barre


asColumnChart()

Imposta il tipo di grafico su ColumnChart e restituisce un EmbeddedColumnChartBuilder.

Invio

EmbeddedColumnChartBuilder: uno strumento per la creazione di grafici a colonne


asComboChart()

Imposta il tipo di grafico su ComboChart e restituisce un EmbeddedComboChartBuilder.

Invio

EmbeddedComboChartBuilder: uno strumento di creazione per un grafico combinato


asHistogramChart()

Imposta il tipo di grafico su IstogramChart e restituisce un EmbeddedHistogramChartBuilder.

Invio

EmbeddedHistogramChartBuilder: uno strumento per la creazione di un istogramma


asLineChart()

Imposta il tipo di grafico su LineChart e restituisce un EmbeddedLineChartBuilder.

Invio

EmbeddedLineChartBuilder: uno strumento per la creazione di un grafico a linee


asPieChart()

Imposta il tipo di grafico su Grafico a torta e restituisce un EmbeddedPieChartBuilder.

Invio

EmbeddedPieChartBuilder: uno strumento per la creazione di grafici a torta


asScatterChart()

Imposta il tipo di grafico su Grafico a dispersione e restituisce un EmbeddedScatterChartBuilder.

Invio

EmbeddedScatterChartBuilder: uno strumento per la creazione di un grafico a dispersione


asTableChart()

Imposta il tipo di grafico su TableChart e restituisce un EmbeddedTableChartBuilder.

Invio

EmbeddedTableChartBuilder: uno strumento per la creazione di un grafico a tabella


build()

Crea il grafico per riflettere tutte le modifiche apportate.

Questo metodo non disegna automaticamente il grafico nella parte superiore del foglio di lavoro. Un nuovo grafico deve essere inserito tramite sheet.insertChart(chart) e un grafico esistente deve essere aggiornato tramite 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);

Invio

EmbeddedChart: il grafico creato, che deve ancora essere aggiunto al foglio di lavoro


clearRanges()

Rimuove tutti gli intervalli dal grafico modificato da questo builder.

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);

Invio

EmbeddedChartBuilder: questo builder, per il concatenamento


getChartType()

Restituisce il tipo di grafico corrente.

Invio

ChartType: il tipo di grafico


getContainer()

Restituisce il grafico ContainerInfo, che racchiude il punto in cui appare il grafico in un foglio di calcolo.

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());

Invio

ContainerInfo: un oggetto contenente la posizione del contenitore del grafico


getRanges()

Restituisce una copia dell'elenco di intervalli che attualmente forniscono dati per il grafico. Usa addRange(range) e removeRange(range) per modificare questo elenco.

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());
}

Invio

Range[]: un array di intervalli che fungono da origine dati da creare per il grafico


removeRange(range)

Rimuove l'intervallo specificato dal grafico modificato da questo builder. Non restituisce un errore se l'intervallo non è presente in questo grafico.

L'intervallo rimosso deve corrispondere a un intervallo aggiunto tramite addRange(range). altrimenti non vengono apportate modifiche al grafico. Impossibile utilizzare questo metodo per rimuovere parzialmente i valori da un intervallo.

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);

Parametri

NomeTipoDescrizione
rangeRangeL'intervallo da rimuovere.

Invio

EmbeddedChartBuilder: questo builder, per il concatenamento


setChartType(type)

Modifica il tipo di grafico. Non tutti i tipi di grafici incorporati sono attualmente supportati. Leggi i 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);

Parametri

NomeTipoDescrizione
typeChartTypeIl tipo in cui modificare il grafico.

Invio

EmbeddedChartBuilder: questo builder, per il concatenamento


setHiddenDimensionStrategy(strategy)

Consente di impostare la strategia da utilizzare per le righe e le colonne nascoste. Il valore predefinito è 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);

Parametri

NomeTipoDescrizione
strategyChartHiddenDimensionStrategyLa strategia da utilizzare per le righe e le colonne nascoste.

Invio

EmbeddedChartBuilder: questo builder, per il concatenamento


setMergeStrategy(mergeStrategy)

Imposta la strategia di unione da utilizzare quando è presente più di un intervallo. Se MERGE_ROWS, le righe vengono unite; Se MERGE_COLUMNS, le colonne vengono unite. Il valore predefinito è 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);

Parametri

NomeTipoDescrizione
mergeStrategyChartMergeStrategyLa strategia di unione da utilizzare.

Invio

EmbeddedChartBuilder: questo builder, per il concatenamento


setNumHeaders(headers)

Imposta il numero di righe o colonne dell'intervallo che devono essere trattate come intestazioni.

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);

Parametri

NomeTipoDescrizione
headersIntegerIl numero di righe o colonne da trattare come intestazioni. I valori negativi causano le intestazioni il rilevamento automatico.

Invio

EmbeddedChartBuilder: questo builder, per il concatenamento


setOption(option, value)

Imposta le opzioni avanzate per questo grafico. Per visualizzare un elenco delle opzioni disponibili, consulta la sezione Grafico opzioni di configurazione.

Questo metodo non convalida l'opzione specificata sia valida per questo tipo di grafico né se l'elemento siano nel formato/struttura corretto.

Questo esempio mostra come modificare il titolo e impostare una legenda.

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

Parametri

NomeTipoDescrizione
optionStringIl nome dell'opzione.
valueObjectIl valore dell'opzione.

Invio

EmbeddedChartBuilder: questo builder, per il concatenamento.


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Imposta la posizione, modificando la posizione del grafico nel foglio. anchorRowPos e anchorColPos sono indicizzati con 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);

Parametri

NomeTipoDescrizione
anchorRowPosIntegerIl lato superiore del grafico è ancorato a questa riga.
anchorColPosIntegerIl lato sinistro del grafico è ancorato a questa colonna.
offsetXIntegerL'angolo superiore destro del grafico è spostato di questo numero di pixel.
offsetYIntegerL'angolo inferiore sinistro del grafico è spostato di questo numero di pixel.

Invio

EmbeddedChartBuilder: questo builder, per il concatenamento


setTransposeRowsAndColumns(transpose)

Imposta la trasposizione di righe e colonne del grafico. Se impostato su true, le righe e le vengono scambiate tra colonne. Il valore predefinito è 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);

Parametri

NomeTipoDescrizione
transposeBooleanSe true, le righe e le colonne utilizzate per creare il grafico sono trasposta.

Invio

EmbeddedChartBuilder: questo builder, per il concatenamento