Class EmbeddedTableChartBuilder

Ajoute une plage au graphique que ce générateur modifie. N'ajoute pas la plage si elle a déjà été ajoutée au graphique.

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

sheet.insertChart(chart);

Paramètres

Renvois

EmbeddedChartBuilder : ce générateur, pour le chaînage.

Définit le type de graphique sur AreaChart et renvoie un EmbeddedAreaChartBuilder.

Renvois

EmbeddedAreaChartBuilder : compilateur pour un graphique en aires.

Définit le type de graphique sur BarChart et renvoie un EmbeddedBarChartBuilder.

Renvois

EmbeddedBarChartBuilder : compilateur pour un graphique à barres.

Définit le type de graphique sur ColumnChart et renvoie un EmbeddedColumnChartBuilder.

Renvois

EmbeddedColumnChartBuilder : compilateur pour un graphique à colonnes.

Définit le type de graphique sur ComboChart et renvoie un EmbeddedComboChartBuilder.

Renvois

EmbeddedComboChartBuilder : compilateur pour un graphique combiné.

Définit le type de graphique sur HistogramChart et renvoie un EmbeddedHistogramChartBuilder.

Renvois

EmbeddedHistogramChartBuilder : compilateur pour un histogramme.

Définit le type de graphique sur LineChart et renvoie un EmbeddedLineChartBuilder.

Renvois

EmbeddedLineChartBuilder : compilateur pour un graphique en courbes.

Définit le type de graphique sur PieChart et renvoie un EmbeddedPieChartBuilder.

Renvois

EmbeddedPieChartBuilder : compilateur pour un graphique à secteurs.

Définit le type de graphique sur ScatterChart et renvoie un EmbeddedScatterChartBuilder.

Renvois

EmbeddedScatterChartBuilder : compilateur pour un graphique à nuage de points.

Définit le type de graphique sur TableChart et renvoie un EmbeddedTableChartBuilder.

Renvois

EmbeddedTableChartBuilder : compilateur pour un tableau.

Crée le graphique pour refléter toutes les modifications qui lui ont été apportées.

Cette méthode ne dessine pas automatiquement le graphique au-dessus de la feuille de calcul. Un nouveau graphique doit être inséré via sheet.insertChart(chart), et un graphique existant doit être mis à jour via sheet.updateChart(chart).

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)
                  .setPosition(5, 5, 0, 0)
                  .build();

sheet.insertChart(chart);

Renvois

EmbeddedChart : graphique créé, qui doit encore être ajouté à la feuille de calcul.

Supprime toutes les plages du graphique que ce générateur modifie.

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

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

Renvois

EmbeddedChartBuilder : ce générateur, pour le chaînage.

Indique s'il faut activer la pagination dans les données.

Le comportement par défaut est la pagination désactivée. Si la pagination est activée, la taille de page par défaut est de 10.

Paramètres

Renvois

EmbeddedTableChartBuilder : ce générateur, utile pour le chaînage.

Active la pagination et définit le nombre de lignes sur chaque page.

La taille de page par défaut est de 10.

// Creates a table chart builder and enables paging with page size of 5.
const builder = Charts.newTableChart();
builder.enablePaging(5);

Paramètres

Renvois

EmbeddedTableChartBuilder : ce générateur, utile pour le chaînage.

Active la pagination, définit le nombre de lignes dans chaque page et la première page du tableau à afficher (les numéros de page sont basés sur zéro).

La taille de page par défaut est de 10 et la page de début par défaut est 0.

// Creates a table chart builder and enables paging with page size of 5 and
// displays page 2 first.
const builder = Charts.newTableChart();
builder.enablePaging(5, 2);

Paramètres

Renvois

EmbeddedTableChartBuilder : ce générateur, utile pour le chaînage.

Ajoute une prise en charge de base des langues de droite à gauche (comme l'arabe ou l'hébreu) en inversant l'ordre des colonnes du tableau. La colonne 0 devient ainsi la colonne la plus à droite et la dernière colonne devient la colonne la plus à gauche.

Cela n'affecte pas l'index de colonne dans les données sous-jacentes, mais uniquement l'ordre d'affichage. L'affichage complet des langues bidirectionnelles (BiDi) n'est pas compatible avec la visualisation de tableau, même avec cette option. Cette option est ignorée si vous activez la pagination (à l'aide de l'option "page") ou si le tableau comporte des barres de défilement parce que vous avez spécifié des options de hauteur et de largeur inférieures à la taille requise du tableau. Le comportement par défaut est la désactivation de la prise en charge du RTL.

Paramètres

Renvois

EmbeddedTableChartBuilder : ce générateur, utile pour le chaînage.

Indique s'il faut trier les colonnes lorsque l'utilisateur clique sur un en-tête de colonne.

Si le tri est activé, les lignes sont automatiquement triées lorsque les utilisateurs cliquent sur l'en-tête de colonne. Le comportement par défaut est le tri activé.

Paramètres

Renvois

EmbeddedTableChartBuilder : ce générateur, utile pour le chaînage.

Renvoie le type de graphique actuel.

Renvois

ChartType : type de graphique.

Renvoie le graphique ContainerInfo, qui indique où il apparaît sur la feuille.

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

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

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

Renvoie une copie de la liste des plages fournissant actuellement des données pour ce graphique. Utilisez addRange(range) et removeRange(range) pour modifier cette liste.

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

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

const ranges = chartBuilder.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 servant de source de données pour le graphique à créer.

Supprime la plage spécifiée du graphique que ce générateur modifie. Ne génère pas d'erreur si la plage ne figure pas dans ce graphique.

La plage supprimée doit correspondre à une plage ajoutée via addRange(range). Sinon, aucune modification n'est apportée au graphique. Cette méthode ne peut pas être utilisée pour supprimer partiellement des valeurs d'une plage.

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

const firstRange = sheet.getRange('A1:B5');
const secondRange = sheet.getRange('A6:B8');

const chartBuilder = sheet.newChart()
                         .setChartType(Charts.ChartType.BAR)
                         .addRange(firstRange)
                         // This range renders 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
// is not removed, and does not throw an exception
chartBuilder.removeRange(firstRange);
chartBuilder.removeRange(sheet.getRange('A6:B8'));

const chart = chartBuilder.build();

sheet.insertChart(chart);

Paramètres

Renvois

EmbeddedChartBuilder : ce générateur, pour le chaînage.

Modifie le type de graphique. Tous les types de graphiques intégrés ne sont pas compatibles pour le moment. Consultez les ChartType.

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)
                  .setPosition(5, 5, 0, 0)
                  .build();

sheet.insertChart(chart);

Paramètres

Renvois

EmbeddedChartBuilder : ce générateur, pour le chaînage.

Définit le numéro de ligne de la première ligne du tableau de données.

Le numéro de ligne par défaut de la première ligne est 1.

// Creates a table chart builder and sets the first row to be 2.
const builder = Charts.newTableChart();
builder.setFirstRowNumber(2);

Paramètres

Renvois

EmbeddedTableChartBuilder : ce générateur, utile pour le chaînage.

Définit la stratégie à utiliser pour les lignes et 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();

sheet.insertChart(chart);

Paramètres

Renvois

EmbeddedChartBuilder : ce générateur, pour le chaînage.

Définit l'index de la colonne selon laquelle le tableau doit être trié initialement (ordre croissant).

La colonne est triée par ordre croissant et est marquée d'une petite flèche.

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

Paramètres

Renvois

EmbeddedTableChartBuilder : ce générateur, utile pour le chaînage.

Définit l'index de la colonne selon laquelle le tableau doit être trié initialement (ordre décroissant).

La colonne est triée par ordre décroissant et est marquée par une petite flèche.

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

Paramètres

Renvois

EmbeddedTableChartBuilder : ce générateur, utile pour le chaînage.

Définit la stratégie de fusion à utiliser 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('C:C10');
const 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);

Paramètres

Renvois

EmbeddedChartBuilder : ce générateur, pour le chaînage.

Définit le nombre de lignes ou de colonnes de la plage à traiter 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();

sheet.insertChart(chart);

Paramètres

Renvois

EmbeddedChartBuilder : ce générateur, pour le chaînage.

Définit les options avancées de ce graphique. Pour afficher la liste des options disponibles, consultez Options de configuration des graphiques.

Cette méthode ne valide pas si l'option que vous spécifiez est valide pour ce type de graphique ni si la valeur est au bon format/a la bonne structure.

Cet exemple montre comment modifier le titre et définir une légende.

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const sheet = spreadsheet.getSheets()[0];
const chart = sheet.newChart()
 .setOption('title', 'Earnings projections')
 .setOption('legend', {
   position: 'top',
   textStyle: { color: 'blue', fontSize: 16 },
 }).build();

Paramètres

Renvois

EmbeddedChartBuilder : ce générateur, pour le chaînage.

Définit la position du graphique dans la feuille. anchorRowPos et anchorColPos sont indexés à partir de 1.

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)
                  .setPosition(5, 5, 0, 0)
                  .build();

sheet.insertChart(chart);

Paramètres

Renvois

EmbeddedChartBuilder : ce générateur, pour le chaînage.

Indique si les lignes et les colonnes du graphique sont transposées. Si la valeur est true, les lignes et les colonnes 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()
                  .setChartType(Charts.ChartType.BAR)
                  .addRange(range)
                  .setTransposeRowsAndColumns(true)
                  .setPosition(5, 5, 0, 0)
                  .build();

sheet.insertChart(chart);

Paramètres

Renvois

EmbeddedChartBuilder : ce générateur, pour le chaînage.

Indique s'il faut afficher le numéro de ligne comme première colonne du tableau.

Par défaut, les numéros de ligne ne sont pas affichés.

Paramètres

Renvois

EmbeddedTableChartBuilder : ce générateur, utile pour le chaînage.

Indique si un style de couleur en alternance est attribué aux lignes impaires et paires d'un tableau.

Le comportement par défaut est le style de couleur alternée pour les lignes.

Paramètres

Renvois

EmbeddedTableChartBuilder : ce générateur, utile pour le chaînage.