Class EmbeddedTableChartBuilder

Outil de création detableauxgraphiques intégré

Outil de création de tableaux Pour en savoir plus, consultez la documentation de Gviz.

Méthodes

Méthode	Type renvoyé	Brève description
addRange(range)	EmbeddedChartBuilder	Ajoute une plage au graphique que ce générateur modifie.
asAreaChart()	EmbeddedAreaChartBuilder	Définit le type de graphique sur "AreaChart" et renvoie un EmbeddedAreaChartBuilder.
asBarChart()	EmbeddedBarChartBuilder	Définit le type de graphique sur "BarChart" et renvoie un EmbeddedBarChartBuilder.
asColumnChart()	EmbeddedColumnChartBuilder	Définit le type de graphique sur "ColumnChart" et renvoie un EmbeddedColumnChartBuilder.
asComboChart()	EmbeddedComboChartBuilder	Définit le type de graphique sur "ComboChart" et renvoie un EmbeddedComboChartBuilder.
asHistogramChart()	EmbeddedHistogramChartBuilder	Définit le type de graphique sur HistogramChart et renvoie un EmbeddedHistogramChartBuilder.
asLineChart()	EmbeddedLineChartBuilder	Définit le type de graphique sur "LineChart" et renvoie un EmbeddedLineChartBuilder.
asPieChart()	EmbeddedPieChartBuilder	Définit le type de graphique sur PieChart et renvoie un EmbeddedPieChartBuilder.
asScatterChart()	EmbeddedScatterChartBuilder	Définit le type de graphique sur ScatterChart et renvoie un EmbeddedScatterChartBuilder.
asTableChart()	EmbeddedTableChartBuilder	Définit le type de graphique sur "TableChart" et renvoie un EmbeddedTableChartBuilder.
build()	EmbeddedChart	Crée le graphique pour refléter toutes les modifications qui y ont été apportées.
clearRanges()	EmbeddedChartBuilder	Supprime toutes les plages du graphique que ce générateur modifie.
enablePaging(enablePaging)	EmbeddedTableChartBuilder	Indique si la pagination des données doit être activée.
enablePaging(pageSize)	EmbeddedTableChartBuilder	Active la pagination et définit le nombre de lignes de chaque page.
enablePaging(pageSize, startPage)	EmbeddedTableChartBuilder	Active la pagination, définit le nombre de lignes sur chaque page et la première page du tableau à afficher (les numéros de page sont basés sur zéro).
enableRtlTable(rtlEnabled)	EmbeddedTableChartBuilder	Ajoute une compatibilité de base avec les langues de droite à gauche (comme l'arabe ou l'hébreu) en inversant l'ordre des colonnes du tableau, de sorte que la colonne 0 soit la colonne la plus à droite et la dernière colonne la plus à gauche.
enableSorting(enableSorting)	EmbeddedTableChartBuilder	Indique si les colonnes doivent être triées lorsque l'utilisateur clique sur un titre de colonne.
getChartType()	ChartType	Renvoie le type de graphique actuel.
getContainer()	ContainerInfo	Renvoie le ContainerInfo du graphique, qui encapsule l'emplacement du graphique sur la feuille.
getRanges()	Range[]	Renvoie une copie de la liste des plages qui fournissent actuellement des données pour ce graphique.
removeRange(range)	EmbeddedChartBuilder	Supprime la plage spécifiée du graphique que ce générateur modifie.
setChartType(type)	EmbeddedChartBuilder	Permet de modifier le type de graphique.
setFirstRowNumber(number)	EmbeddedTableChartBuilder	Définit le numéro de la première ligne du tableau de données.
setHiddenDimensionStrategy(strategy)	EmbeddedChartBuilder	Définit la stratégie à utiliser pour les lignes et colonnes masquées.
setInitialSortingAscending(column)	EmbeddedTableChartBuilder	Définit l'index de la colonne en fonction de laquelle le tableau doit être trié initialement (par ordre croissant).
setInitialSortingDescending(column)	EmbeddedTableChartBuilder	Définit l'index de la colonne en fonction de laquelle le tableau doit être trié initialement (décroissant).
setMergeStrategy(mergeStrategy)	EmbeddedChartBuilder	Définit la stratégie de fusion à utiliser lorsqu'il existe plusieurs plages.
setNumHeaders(headers)	EmbeddedChartBuilder	Définit le nombre de lignes ou de colonnes de la plage à traiter comme des en-têtes.
setOption(option, value)	EmbeddedChartBuilder	Définit les options avancées de ce graphique.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	EmbeddedChartBuilder	Définit la position, ce qui modifie l'emplacement du graphique sur la feuille.
setTransposeRowsAndColumns(transpose)	EmbeddedChartBuilder	Indique si les lignes et les colonnes du graphique doivent être transposées.
showRowNumberColumn(showRowNumber)	EmbeddedTableChartBuilder	Indique si le numéro de ligne doit être affiché dans la première colonne du tableau.
useAlternatingRowStyle(alternate)	EmbeddedTableChartBuilder	Indique si un style de couleur alterné est attribué aux lignes impaires et paires d'un tableau.

Documentation détaillée

addRange(range)

Ajoute une plage au graphique que ce générateur modifie. Ne l'ajoute pas 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

Nom	Type	Description
range	Range	Plage à ajouter.

Renvois

EmbeddedChartBuilder : ce compilateur, pour le chaînage

---

asAreaChart()

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

Renvois

EmbeddedAreaChartBuilder : outil de création d'un graphique en aires

---

asBarChart()

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

Renvois

EmbeddedBarChartBuilder : outil de création d'un graphique à barres

---

asColumnChart()

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

Renvois

EmbeddedColumnChartBuilder : outil de création d'un graphique à colonnes

---

asComboChart()

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

Renvois

EmbeddedComboChartBuilder : compilateur pour un graphique combiné

---

asHistogramChart()

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

Renvois

EmbeddedHistogramChartBuilder : générateur d'un histogramme

---

asLineChart()

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

Renvois

EmbeddedLineChartBuilder : outil de création d'un graphique linéaire

---

asPieChart()

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

Renvois

EmbeddedPieChartBuilder : outil de création d'un graphique à secteurs

---

asScatterChart()

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

Renvois

EmbeddedScatterChartBuilder : outil de création d'un graphique à nuage de points

---

asTableChart()

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

Renvois

EmbeddedTableChartBuilder : compilateur pour un graphique sous forme de tableau

---

build()

Crée le graphique pour refléter toutes les modifications qui y 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

---

clearRanges()

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 compilateur, pour le chaînage

---

enablePaging(enablePaging)

Indique si la pagination des données doit être activée.

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

Paramètres

Nom	Type	Description
enablePaging	Boolean	true si la pagination doit être activée, false dans le cas contraire.

Renvois

EmbeddedTableChartBuilder : ce compilateur est utile pour le chaînage.

---

enablePaging(pageSize)

Active la pagination et définit le nombre de lignes de 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

Nom	Type	Description
pageSize	Integer	Nombre de lignes sur chaque page de la table.

Renvois

EmbeddedTableChartBuilder : ce compilateur est utile pour le chaînage.

---

enablePaging(pageSize, startPage)

Active la pagination, définit le nombre de lignes sur 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émarrage 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

Nom	Type	Description
pageSize	Integer	Nombre de lignes sur chaque page de la table.
startPage	Integer	Première page du tableau à afficher (les numéros de page sont basés sur zéro).

Renvois

EmbeddedTableChartBuilder : ce compilateur est utile pour le chaînage.

---

enableRtlTable(rtlEnabled)

Ajoute une compatibilité de base avec les langues de droite à gauche (comme l'arabe ou l'hébreu) en inversant l'ordre des colonnes du tableau, de sorte que la colonne 0 soit la colonne la plus à droite et la dernière colonne la plus à gauche.

Cela n'affecte pas l'indice de colonne dans les données sous-jacentes, mais uniquement l'ordre d'affichage. La visualisation de la table n'est pas compatible avec l'affichage complet des langues bidirectionnelles, même avec cette option. Cette option est ignorée si vous activez la pagination (à l'aide de l'option de page) ou si le tableau comporte des barres de défilement, car vous avez spécifié des options de hauteur et de largeur inférieures à la taille requise du tableau. Par défaut, la prise en charge de l'écriture arabe est désactivée.

Paramètres

Nom	Type	Description
rtlEnabled	Boolean	true si la prise en charge de la lecture de droite à gauche doit être activée, false dans le cas contraire.

Renvois

EmbeddedTableChartBuilder : ce compilateur est utile pour le chaînage.

---

enableSorting(enableSorting)

Indique si les colonnes doivent être triées lorsque l'utilisateur clique sur un titre de colonne.

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

Paramètres

Nom	Type	Description
enableSorting	Boolean	true pour activer le tri en cliquant sur les en-têtes de colonne, false dans le cas contraire.

Renvois

EmbeddedTableChartBuilder : ce compilateur est utile pour le chaînage.

---

getChartType()

Renvoie le type de graphique actuel.

Renvois

ChartType : type de graphique

---

getContainer()

Renvoie le ContainerInfo du graphique, qui encapsule l'emplacement du graphique 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

---

getRanges()

Renvoie une copie de la liste des plages qui fournissent 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 au graphique à créer

---

removeRange(range)

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 permet pas de 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 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'));

const chart = chartBuilder.build();

sheet.insertChart(chart);

Paramètres

Nom	Type	Description
range	Range	Plage à supprimer.

Renvois

EmbeddedChartBuilder : ce compilateur, pour le chaînage

---

setChartType(type)

Permet de modifier le type de graphique. Tous les types de graphiques intégrés ne sont pas encore compatibles. 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

Nom	Type	Description
type	ChartType	Type de graphique à remplacer par ce graphique.

Renvois

EmbeddedChartBuilder : ce compilateur, pour le chaînage

---

setFirstRowNumber(number)

Définit le numéro 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

Nom	Type	Description
number	Integer	Numéro de la première ligne du tableau de données.

Renvois

EmbeddedTableChartBuilder : ce compilateur est utile pour le chaînage.

---

setHiddenDimensionStrategy(strategy)

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

Nom	Type	Description
strategy	ChartHiddenDimensionStrategy	Stratégie à utiliser pour les lignes et colonnes masquées.

Renvois

EmbeddedChartBuilder : ce compilateur, pour le chaînage

---

setInitialSortingAscending(column)

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

La colonne est triée par ordre croissant, ce qui est indiqué par 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

Nom	Type	Description
column	Integer	Numéro de la colonne en fonction de laquelle la table doit être triée initialement.

Renvois

EmbeddedTableChartBuilder : ce compilateur est utile pour le chaînage.

---

setInitialSortingDescending(column)

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

La colonne est triée par ordre décroissant et est marquée d'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

Nom	Type	Description
column	Integer	Numéro de la colonne en fonction de laquelle la table doit être triée initialement.

Renvois

EmbeddedTableChartBuilder : ce compilateur est utile pour le chaînage.

---

setMergeStrategy(mergeStrategy)

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 elle 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

Nom	Type	Description
mergeStrategy	ChartMergeStrategy	Stratégie de fusion à utiliser.

Renvois

EmbeddedChartBuilder : ce compilateur, pour le chaînage

---

setNumHeaders(headers)

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

Nom	Type	Description
headers	Integer	Nombre de lignes ou de colonnes à traiter comme des en-têtes. Les valeurs négatives entraînent la détection automatique des en-têtes.

Renvois

EmbeddedChartBuilder : ce compilateur, pour le chaînage

---

setOption(option, value)

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

Cette méthode ne vérifie pas si l'option que vous spécifiez est valide pour ce type de graphique ni si la valeur est au bon format/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

Nom	Type	Description
option	String	Nom de l'option.
value	Object	Valeur de l'option.

Renvois

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

---

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Définit la position, ce qui modifie l'emplacement du graphique sur la feuille. anchorRowPos et anchorColPos sont indexés à 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

Nom	Type	Description
anchorRowPos	Integer	Le bord supérieur du graphique est ancré sur cette ligne.
anchorColPos	Integer	Le côté gauche du graphique est ancré dans cette colonne.
offsetX	Integer	Le coin supérieur droit du graphique est décalé de ce nombre de pixels.
offsetY	Integer	Le coin inférieur gauche du graphique est décalé de ce nombre de pixels.

Renvois

EmbeddedChartBuilder : ce compilateur, pour le chaînage

---

setTransposeRowsAndColumns(transpose)

Indique si les lignes et les colonnes du graphique doivent être 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

Nom	Type	Description
transpose	Boolean	Si la valeur est true, les lignes et les colonnes utilisées pour construire le graphique sont transposées.

Renvois

EmbeddedChartBuilder : ce compilateur, pour le chaînage

---

showRowNumberColumn(showRowNumber)

Indique si le numéro de ligne doit être affiché dans la première colonne du tableau.

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

Paramètres

Nom	Type	Description
showRowNumber	Boolean	true si la première colonne du tableau doit afficher le numéro de ligne, false sinon.

Renvois

EmbeddedTableChartBuilder : ce compilateur est utile pour le chaînage.

---

useAlternatingRowStyle(alternate)

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

Par défaut, les lignes alternent les styles de couleur.

Paramètres

Nom	Type	Description
alternate	Boolean	true si les styles de couleur doivent alterner, false dans le cas contraire.

Renvois

EmbeddedTableChartBuilder : ce compilateur est utile pour le chaînage.