Class EmbeddedChart

EmbeddedChart

Représente un graphique qui a été intégré dans une feuille de calcul.

Cet exemple montre comment modifier un graphique existant: 

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A2: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);

Cet exemple montre comment créer un graphique: 

function newChart(range, sheet) {
  var sheet = SpreadsheetApp.getActiveSheet();
  var chartBuilder = sheet.newChart();
  chartBuilder.addRange(range)
      .setChartType(Charts.ChartType.LINE)
      .setOption('title', 'My Line Chart!');
  sheet.insertChart(chartBuilder.build());
}

Méthodes

MéthodeType renvoyéBrève description
asDataSourceChart()DataSourceChartConvertit en instance de graphique de source de données s'il s'agit d'un graphique de source de données, ou null sinon.
getAs(contentType)BlobRenvoyez les données contenues dans cet objet sous la forme d'un blob converti dans le type de contenu spécifié.
getBlob()BlobRenvoyez les données contenues dans cet objet sous forme de blob.
getChartId()IntegerRenvoie un identifiant stable pour le graphique, qui est unique dans la feuille de calcul contenant la graphique ou null si le graphique ne se trouve pas dans une feuille de calcul.
getContainerInfo()ContainerInfoRenvoie des informations sur la position du graphique dans une feuille.
getHiddenDimensionStrategy()ChartHiddenDimensionStrategyRenvoie la stratégie à utiliser pour gérer les lignes et les colonnes masquées.
getMergeStrategy()ChartMergeStrategyRenvoie la stratégie de fusion utilisée lorsqu'il existe plusieurs plages.
getNumHeaders()IntegerRenvoie le nombre de lignes ou de colonnes dans la plage qui sont traitées comme des en-têtes.
getOptions()ChartOptionsAffiche les options de ce graphique, telles que la hauteur, les couleurs et les axes.
getRanges()Range[]Affiche les plages utilisées par ce graphique comme source de données.
getTransposeRowsAndColumns()BooleanSi la valeur est true, les lignes et les colonnes utilisées pour renseigner le graphique sont inversées.
modify()EmbeddedChartBuilderRenvoie un EmbeddedChartBuilder qui peut être utilisé pour modifier ce graphique.

Documentation détaillée

asDataSourceChart()

Convertit en instance de graphique de source de données s'il s'agit d'un graphique de source de données, ou null sinon.

Renvois

DataSourceChart : graphique de source de données.

getAs(contentType)

Renvoyez les données contenues dans cet objet sous la forme d'un blob converti dans le type de contenu spécifié. Ce ajoute l'extension appropriée au nom du fichier (par exemple, "myfile.pdf"). Cependant, il suppose que la partie du nom de fichier qui suit le dernier point (le cas échéant) est une à remplacer. Par conséquent, "ShoppingList.12.25.2014" devient "ShoppingList.12.25.pdf".

Pour connaître les quotas quotidiens de conversion, consultez la page Quotas Services. Les domaines Google Workspace nouvellement créés peuvent être temporairement soumis à des règles des quotas.

Paramètres

NomTypeDescription
contentTypeStringType MIME vers lequel effectuer la conversion. Pour la plupart des blobs, 'application/pdf' correspond à est la seule option valide. Pour les images au format BMP, GIF, JPEG ou PNG, les valeurs 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' le sont également. valide. Pour un document Google Docs, 'text/markdown' est également valide.

Renvois

Blob : données sous forme de blob.

getBlob()

Renvoyez les données contenues dans cet objet sous forme de blob.

Renvois

Blob : données sous forme de blob.

getChartId()

Renvoie un identifiant stable pour le graphique, qui est unique dans la feuille de calcul contenant la graphique ou null si le graphique ne se trouve pas dans une feuille de calcul.

Renvois

Integer : identifiant de graphique stable.

getContainerInfo()

Renvoie des informations sur la position du graphique dans une feuille. 

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

var containerInfo = chart.getContainerInfo();

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

Renvois

ContainerInfo : objet contenant la position du conteneur du graphique

getHiddenDimensionStrategy()

Renvoie la stratégie à utiliser pour gérer les lignes et les colonnes masquées. La valeur par défaut est 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()

// Logs the strategy to use for hidden rows and columns which is
// Charts.ChartHiddenDimensionStrategy.IGNORE_COLUMNS in this case.
Logger.log(chart.getHiddenDimensionStrategy());

Renvois

ChartHiddenDimensionStrategy : stratégie à utiliser pour les lignes et les colonnes masquées.

getMergeStrategy()

Renvoie la stratégie de fusion utilisée lorsqu'il existe plusieurs plages. Si la valeur est MERGE_ROWS, les lignes sont fusionnées. Si la valeur est MERGE_COLUMNS, les colonnes sont fusionnées. La valeur par défaut est MERGE_COLUMNS. 

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

var range = sheet.getRange("A1:B10");
var range2 = sheet.getRange("C1:C10");
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(range)
    .addRange(range2)
    .setMergeStrategy(Charts.ChartMergeStrategy.MERGE_ROWS)
    .setPosition(5, 5, 0, 0)
    .build()

// Logs whether rows of multiple ranges are merged, which is MERGE_ROWS in this case.
Logger.log(chart.getMergeStrategy());

Renvois

ChartMergeStrategy : MERGE_ROWS si les lignes sont fusionnées sur plusieurs plages ; MERGE_COLUMNS si les colonnes sont fusionnées sur plusieurs plages

getNumHeaders()

Renvoie le nombre de lignes ou de colonnes dans la plage qui sont traitées comme des en-têtes. 

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

// Logs the number of rows or columns to use as headers, which is 1 in this case.
Logger.log(chart.getHeaders());

Renvois

Integer : nombre de lignes ou de colonnes traitées comme des en-têtes. Les valeurs négatives indiquent les en-têtes sont détectés automatiquement.

getOptions()

Affiche les options de ce graphique, telles que la hauteur, les couleurs et les axes.

Les options renvoyées sont immuables.

Renvois

ChartOptions : options de ce graphique, telles que la hauteur, les couleurs et les axes.

getRanges()

Affiche les plages utilisées par ce graphique comme source de données. 

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

var ranges = chart.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());
}

Renvois

Range[] : tableau de plages servant de source de données pour ce graphique

getTransposeRowsAndColumns()

Si la valeur est true, les lignes et les colonnes utilisées pour renseigner le graphique sont inversées. La valeur par défaut est false. 

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

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

// Logs whether rows and columns should be transposed, which is true in this case.
Logger.log(chart.getTransposeRowsAndColumns());

Renvois

Boolean : true si les lignes et les colonnes utilisées pour construire le graphique sont transposées.

modify()

Renvoie un EmbeddedChartBuilder qui peut être utilisé pour modifier ce graphique. Appelez sheet.updateChart(chart) pour enregistrer les modifications. 

var sheet = SpreadsheetApp.getActiveSheet();
var chart = sheet.getCharts()[0];
chart = chart.modify()
    .setOption('width', 800)
    .setOption('height', 640)
    .setPosition(5, 5, 0, 0)
    .build();
sheet.updateChart(chart);

Renvois

EmbeddedChartBuilder : compilateur pour créer des graphiques intégrés