Class EmbeddedTableChartBuilder

EmbeddedTableChartBuilder

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

Méthodes

MéthodeType renvoyéBrève description
addRange(range)EmbeddedChartBuilderAjoute une plage au graphique que ce compilateur modifie.
asAreaChart()EmbeddedAreaChartBuilderDéfinit le type de graphique sur AreaChart et renvoie un EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderDéfinit le type de graphique sur BarChart et renvoie un EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderDéfinit le type de graphique sur ColumnChart et renvoie EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderDéfinit le type de graphique sur ComboChart et renvoie EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderDéfinit le type de graphique sur HistogramChart et renvoie EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderDéfinit le type de graphique sur LineChart et renvoie un EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderDéfinit le type de graphique sur PieChart et renvoie un EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderDéfinit le type de graphique sur "ScatterChart", puis renvoie un EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderDéfinit le type de graphique sur TableChart et renvoie EmbeddedTableChartBuilder.
build()EmbeddedChartIl crée le graphique pour refléter toutes les modifications qui y ont été apportées.
clearRanges()EmbeddedChartBuilderSupprime toutes les plages du graphique que ce compilateur modifie.
enablePaging(enablePaging)EmbeddedTableChartBuilderDétermine si la pagination est activée pour les données.
enablePaging(pageSize)EmbeddedTableChartBuilderActive la pagination et définit le nombre de lignes dans chaque page.
enablePaging(pageSize, startPage)EmbeddedTableChartBuilderActive 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)EmbeddedTableChartBuilderAjoute la prise en charge de base pour les langues qui se lisent de droite à gauche (comme l'arabe ou l'hébreu) en inversant l'ordre des colonnes du tableau. La colonne "zéro" correspond alors à la colonne la plus à droite, et la dernière à la colonne la plus à gauche.
enableSorting(enableSorting)EmbeddedTableChartBuilderDétermine si les colonnes doivent être triées lorsque l'utilisateur clique sur un en-tête de colonne.
getChartType()ChartTypeAffiche le type de graphique actuel.
getContainer()ContainerInfoRenvoyez le graphique ContainerInfo, qui encapsule l'emplacement du graphique sur la feuille.
getRanges()Range[]Affiche une copie de la liste des plages contenant actuellement des données pour ce graphique.
removeRange(range)EmbeddedChartBuilderSupprime la plage spécifiée du graphique que ce compilateur modifie.
setChartType(type)EmbeddedChartBuilderModifie le type de graphique.
setFirstRowNumber(number)EmbeddedTableChartBuilderDéfinit le numéro de la première ligne du tableau de données.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderDéfinit la stratégie à utiliser pour les lignes et les colonnes masquées.
setInitialSortingAscending(column)EmbeddedTableChartBuilderDéfinit l'index de la colonne en fonction duquel la table doit être initialement triée (croissant).
setInitialSortingDescending(column)EmbeddedTableChartBuilderDéfinit l'index de la colonne en fonction duquel la table doit être initialement triée (par ordre décroissant).
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderDéfinit la stratégie de fusion à utiliser lorsque plusieurs plages existent.
setNumHeaders(headers)EmbeddedChartBuilderDéfinit le nombre de lignes ou de colonnes de la plage à traiter comme des en-têtes.
setOption(option, value)EmbeddedChartBuilderDéfinit les options avancées de ce graphique.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderDéfinit la position, en changeant l'emplacement du graphique sur la feuille.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderIndique si les lignes et les colonnes du graphique sont transposées.
showRowNumberColumn(showRowNumber)EmbeddedTableChartBuilderDétermine si le numéro de ligne doit s'afficher dans la première colonne du tableau.
useAlternatingRowStyle(alternate)EmbeddedTableChartBuilderIndique si le style de couleur alternée est attribué aux lignes paires et impaires d'un tableau.

Documentation détaillée

addRange(range)

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

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

Paramètres

NomTypeDescription
rangeRangePlage à ajouter.

Aller-retour

EmbeddedChartBuilder : cet outil de création, pour le chaînage


asAreaChart()

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

Aller-retour

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


asBarChart()

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

Aller-retour

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


asColumnChart()

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

Aller-retour

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


asComboChart()

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

Aller-retour

EmbeddedComboChartBuilder : outil de création d'un graphique combiné


asHistogramChart()

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

Aller-retour

EmbeddedHistogramChartBuilder : outil de création d'un histogramme


asLineChart()

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

Aller-retour

EmbeddedLineChartBuilder : outil de création d'un graphique en courbes


asPieChart()

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

Aller-retour

EmbeddedPieChartBuilder : outil de création de graphique à secteurs


asScatterChart()

Définit le type de graphique sur"ScatterChart", puis renvoie un EmbeddedScatterChartBuilder.

Aller-retour

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


asTableChart()

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

Aller-retour

EmbeddedTableChartBuilder : outil de création d'un graphique de table


build()

Il 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. Vous devez insérer un nouveau graphique via sheet.insertChart(chart) et mettre à jour un graphique existant via 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);

Aller-retour

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


clearRanges()

Supprime toutes les plages du graphique que ce compilateur modifie.

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

Aller-retour

EmbeddedChartBuilder : cet outil de création, pour le chaînage


enablePaging(enablePaging)

Détermine si la pagination est activée pour les données.

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

Paramètres

NomTypeDescription
enablePagingBooleantrue si la pagination doit être activée, false dans le cas contraire.

Aller-retour

EmbeddedTableChartBuilder : compilateur, utile pour le chaînage


enablePaging(pageSize)

Active la pagination et définit le nombre de lignes dans 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.
var builder = Charts.newTableChart();
builder.enablePaging(5);

Paramètres

NomTypeDescription
pageSizeIntegerNombre de lignes sur chaque page du tableau.

Aller-retour

EmbeddedTableChartBuilder : compilateur, 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 par défaut de la page est de 10 et celle de la page d'accueil par défaut est de 0.

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

Paramètres

NomTypeDescription
pageSizeIntegerNombre de lignes sur chaque page du tableau.
startPageIntegerPremière page du tableau à afficher (les numéros de page sont basés sur zéro).

Aller-retour

EmbeddedTableChartBuilder : compilateur, utile pour le chaînage


enableRtlTable(rtlEnabled)

Ajoute la prise en charge de base pour les langues qui se lisent de droite à gauche (comme l'arabe ou l'hébreu) en inversant l'ordre des colonnes du tableau. La colonne "zéro" correspond alors à la colonne la plus à droite, et la dernière à la colonne la plus à gauche.

Cela n'affecte pas l'index de colonne des données sous-jacentes, mais uniquement l'ordre d'affichage. L'affichage en langue bidirectionnelle (BiDi) n'est pas compatible avec la visualisation du tableau, 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 contient des barres de défilement, car vous avez spécifié des options de hauteur et de largeur inférieures à la taille de tableau requise. Le comportement par défaut est désactivé.

Paramètres

NomTypeDescription
rtlEnabledBooleantrue si la compatibilité de droite à gauche doit être activée, false dans le cas contraire.

Aller-retour

EmbeddedTableChartBuilder : compilateur, utile pour le chaînage


enableSorting(enableSorting)

Détermine si les colonnes doivent être triées 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

NomTypeDescription
enableSortingBooleantrue pour activer le tri en cliquant sur les en-têtes de colonne (false dans le cas contraire)

Aller-retour

EmbeddedTableChartBuilder : compilateur, utile pour le chaînage


getChartType()

Affiche le type de graphique actuel.

Aller-retour

ChartType : type de graphique


getContainer()

Renvoyez le graphique ContainerInfo, qui encapsule l'emplacement du graphique sur la feuille.

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

Aller-retour

ContainerInfo : objet contenant la position du conteneur de graphique


getRanges()

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

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

Aller-retour

Range[] : tableau de plages servant de graphique pour la source de données à créer


removeRange(range)

Supprime la plage spécifiée du graphique que ce compilateur 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.

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

Paramètres

NomTypeDescription
rangeRangePlage à supprimer.

Aller-retour

EmbeddedChartBuilder : cet outil de création, pour le chaînage


setChartType(type)

Modifie le type de graphique. Tous les types de graphiques intégrés ne sont pas compatibles pour le moment. Consultez les 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);

Paramètres

NomTypeDescription
typeChartTypeType dans lequel transformer ce graphique.

Aller-retour

EmbeddedChartBuilder : cet outil de création, 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 la première ligne par défaut est 1.

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

Paramètres

NomTypeDescription
numberIntegerNuméro de la première ligne du tableau de données.

Aller-retour

EmbeddedTableChartBuilder : compilateur, utile pour le chaînage


setHiddenDimensionStrategy(strategy)

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

sheet.insertChart(chart);

Paramètres

NomTypeDescription
strategyChartHiddenDimensionStrategyStratégie à utiliser pour les lignes et les colonnes masquées.

Aller-retour

EmbeddedChartBuilder : cet outil de création, pour le chaînage


setInitialSortingAscending(column)

Définit l'index de la colonne en fonction duquel la table doit être initialement triée (croissant).

La colonne "os" triée par ordre croissant est indiquée par une petite flèche.

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

Paramètres

NomTypeDescription
columnIntegerNombre de colonnes selon lesquelles le tableau doit être initialement trié.

Aller-retour

EmbeddedTableChartBuilder : compilateur, utile pour le chaînage


setInitialSortingDescending(column)

Définit l'index de la colonne en fonction duquel la table doit être initialement triée (par ordre décroissant).

La colonne "os" triée par ordre décroissant est indiquée par une petite flèche.

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

Paramètres

NomTypeDescription
columnIntegerNombre de colonnes selon lesquelles le tableau doit être initialement trié.

Aller-retour

EmbeddedTableChartBuilder : compilateur, utile pour le chaînage


setMergeStrategy(mergeStrategy)

Définit la stratégie de fusion à utiliser lorsque plusieurs plages existent. 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("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);

Paramètres

NomTypeDescription
mergeStrategyChartMergeStrategyStratégie de fusion à utiliser.

Aller-retour

EmbeddedChartBuilder : cet outil de création, pour le chaînage


setNumHeaders(headers)

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

sheet.insertChart(chart);

Paramètres

NomTypeDescription
headersIntegerNombre de lignes ou de colonnes à traiter comme des en-têtes. Les valeurs négatives déclenchent la détection automatique des en-têtes.

Aller-retour

EmbeddedChartBuilder : cet outil de création, 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 page Options de configuration du graphique.

Cette méthode ne vérifie pas que l'option spécifiée est valide pour ce type de graphique, ni si la valeur est au format/structure approprié.

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

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

Paramètres

NomTypeDescription
optionStringNom de l'option.
valueObjectValeur de l'option.

Aller-retour

EmbeddedChartBuilder : cet outil de création, pour le chaînage


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

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

Paramètres

NomTypeDescription
anchorRowPosIntegerLe dessus du graphique est ancré sur cette ligne.
anchorColPosIntegerLe côté gauche du graphique est ancré dans cette colonne.
offsetXIntegerL'angle supérieur droit du graphique est décalé de plusieurs pixels.
offsetYIntegerLe décalage en bas à gauche du graphique est décalé de plusieurs pixels.

Aller-retour

EmbeddedChartBuilder : cet outil de création, pour le chaînage


setTransposeRowsAndColumns(transpose)

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

sheet.insertChart(chart);

Paramètres

NomTypeDescription
transposeBooleanSi la valeur est true, les lignes et les colonnes utilisées pour construire le graphique sont transposées.

Aller-retour

EmbeddedChartBuilder : cet outil de création, pour le chaînage


showRowNumberColumn(showRowNumber)

Détermine si le numéro de ligne doit s'afficher dans la première colonne du tableau.

Le comportement par défaut n'affiche pas les numéros de ligne.

Paramètres

NomTypeDescription
showRowNumberBooleantrue si la première colonne de la table doit afficher le numéro de ligne, sinon false.

Aller-retour

EmbeddedTableChartBuilder : compilateur, utile pour le chaînage


useAlternatingRowStyle(alternate)

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

Le comportement par défaut correspond aux lignes avec un style de couleur en alternance.

Paramètres

NomTypeDescription
alternateBooleantrue si les styles de couleur doivent être alternés, sinon false.

Aller-retour

EmbeddedTableChartBuilder : compilateur, utile pour le chaînage