Class EmbeddedChart

EmbeddedChart

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

Cet exemple montre comment modifier un graphique existant : 

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A2:B8');
let 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) {
  const sheet = SpreadsheetApp.getActiveSheet();
  const 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()DataSourceChartEffectue un cast vers une instance de graphique de source de données si le graphique est un graphique de source de données, ou null dans le cas contraire.
getAs(contentType)BlobRenvoie les données de cet objet sous forme de blob converti au type de contenu spécifié.
getBlob()BlobRenvoie les données de cet objet sous forme de blob.
getChartId()IntegerRenvoie un identifiant stable pour le graphique, qui est unique dans la feuille de calcul contenant le 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 de la plage traitées comme des en-têtes.
getOptions()ChartOptionsRenvoie les options de ce graphique, telles que la hauteur, les couleurs et les axes.
getRanges()Range[]Renvoie les plages que ce graphique utilise comme source de données.
getTransposeRowsAndColumns()BooleanSi la valeur est true, les lignes et les colonnes utilisées pour remplir le graphique sont inversées.
modify()EmbeddedChartBuilderRenvoie un EmbeddedChartBuilder qui peut être utilisé pour modifier ce graphique.

Documentation détaillée

asDataSourceChart()

Effectue un cast vers une instance de graphique de source de données si le graphique est un graphique de source de données, ou null dans le cas contraire.

Renvois

DataSourceChart : graphique de la source de données.

getAs(contentType)

Renvoie les données de cet objet sous forme de blob converti au type de contenu spécifié. Cette méthode ajoute l'extension appropriée au nom de fichier (par exemple, "myfile.pdf"). Toutefois, il suppose que la partie du nom de fichier qui suit le dernier point (le cas échéant) est une extension existante qui doit être remplacée. Par conséquent, "ShoppingList.12.25.2014" devient "ShoppingList.12.25.pdf".

Pour consulter les quotas quotidiens pour les conversions, consultez Quotas pour les services Google. Les domaines Google Workspace nouvellement créés peuvent être temporairement soumis à des quotas plus stricts.

Paramètres

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

Renvois

Blob : données sous forme de blob.

getBlob()

Renvoie les données de 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 le graphique, ou null si le graphique ne se trouve pas dans une feuille de calcul.

Renvois

Integer : identifiant stable du graphique.

getContainerInfo()

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

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

const containerInfo = chart.getContainerInfo();

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

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. 

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

// 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 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. 

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

const range = sheet.getRange('A1:B10');
const range2 = sheet.getRange('C1:C10');
const 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 des lignes sont fusionnées sur plusieurs plages ; MERGE_COLUMNS si des colonnes sont fusionnées sur plusieurs plages.

getNumHeaders()

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

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

// 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 que les en-têtes sont détectés automatiquement.

getOptions()

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

Renvoie les plages que ce graphique utilise comme source de données. 

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

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

Renvois

Range[] : tableau de plages qui servent de source de données pour ce graphique.

getTransposeRowsAndColumns()

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

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

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

const sheet = SpreadsheetApp.getActiveSheet();
let 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 permettant de créer des graphiques intégrés.