Compilateur pour les graphiques en courbes. Pour en savoir plus, consultez la documentation de Gviz.
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
add | Embedded | Ajoute une plage au graphique que ce générateur modifie. |
as | Embedded | Définit le type de graphique sur AreaChart et renvoie un Embedded . |
as | Embedded | Définit le type de graphique sur BarChart et renvoie un Embedded . |
as | Embedded | Définit le type de graphique sur ColumnChart et renvoie un Embedded . |
as | Embedded | Définit le type de graphique sur ComboChart et renvoie un Embedded . |
as | Embedded | Définit le type de graphique sur HistogramChart et renvoie un Embedded . |
as | Embedded | Définit le type de graphique sur LineChart et renvoie un Embedded . |
as | Embedded | Définit le type de graphique sur PieChart et renvoie un Embedded . |
as | Embedded | Définit le type de graphique sur ScatterChart et renvoie un Embedded . |
as | Embedded | Définit le type de graphique sur TableChart et renvoie un Embedded . |
build() | Embedded | Crée le graphique pour refléter toutes les modifications qui lui ont été apportées. |
clear | Embedded | Supprime toutes les plages du graphique que ce générateur modifie. |
get | Chart | Renvoie le type de graphique actuel. |
get | Container | Renvoie le graphique Container , qui indique où il apparaît sur la feuille. |
get | Range[] | Renvoie une copie de la liste des plages fournissant actuellement des données pour ce graphique. |
remove | Embedded | Supprime la plage spécifiée du graphique que ce générateur modifie. |
reverse | Embedded | Inverse l'ordre de tracé des séries sur l'axe du domaine. |
set | Embedded | Définit la couleur de l'arrière-plan du graphique. |
set | Embedded | Modifie le type de graphique. |
set | Embedded | Définit les couleurs des lignes du graphique. |
set | Embedded | Définit le style à utiliser pour les courbes du graphique. |
set | Embedded | Définit la stratégie à utiliser pour les lignes et colonnes masquées. |
set | Embedded | Définit la position de la légende par rapport au graphique. |
set | Embedded | Définit le style du texte de la légende du graphique. |
set | Embedded | Définit la stratégie de fusion à utiliser lorsqu'il existe plusieurs plages. |
set | Embedded | Définit le nombre de lignes ou de colonnes de la plage à traiter comme des en-têtes. |
set | Embedded | Définit les options avancées de ce graphique. |
set | Embedded | Définit le style des points de la ligne. |
set | Embedded | Définit la position du graphique dans la feuille. |
set | Embedded | Définit la plage du graphique. |
set | Embedded | Définit le titre du graphique. |
set | Embedded | Définit le style du texte du titre du graphique. |
set | Embedded | Indique si les lignes et les colonnes du graphique sont transposées. |
set | Embedded | Définit le style du texte de l'axe horizontal. |
set | Embedded | Ajoute un titre à l'axe horizontal. |
set | Embedded | Définit le style du texte du titre de l'axe horizontal. |
set | Embedded | Définit le style du texte de l'axe vertical. |
set | Embedded | Ajoute un titre à l'axe vertical. |
set | Embedded | Définit le style du texte du titre de l'axe vertical. |
use | Embedded | Convertit l'axe de plage en échelle logarithmique (toutes les valeurs doivent être positives). |
Documentation détaillée
add Range(range)
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
Nom | Type | Description |
---|---|---|
range | Range | Plage à ajouter. |
Renvois
Embedded
: ce générateur, pour le chaînage.
as Area Chart()
Définit le type de graphique sur AreaChart et renvoie un Embedded
.
Renvois
Embedded
: compilateur pour un graphique en aires.
as Bar Chart()
Définit le type de graphique sur BarChart et renvoie un Embedded
.
Renvois
Embedded
: compilateur pour un graphique à barres.
as Column Chart()
Définit le type de graphique sur ColumnChart et renvoie un Embedded
.
Renvois
Embedded
: compilateur pour un graphique à colonnes.
as Combo Chart()
Définit le type de graphique sur ComboChart et renvoie un Embedded
.
Renvois
Embedded
: compilateur pour un graphique combiné.
as Histogram Chart()
Définit le type de graphique sur HistogramChart et renvoie un Embedded
.
Renvois
Embedded
: compilateur pour un histogramme.
as Line Chart()
Définit le type de graphique sur LineChart et renvoie un Embedded
.
Renvois
Embedded
: compilateur pour un graphique en courbes.
as Pie Chart()
Définit le type de graphique sur PieChart et renvoie un Embedded
.
Renvois
Embedded
: compilateur pour un graphique à secteurs.
as Scatter Chart()
Définit le type de graphique sur ScatterChart et renvoie un Embedded
.
Renvois
Embedded
: compilateur pour un graphique à nuage de points.
as Table Chart()
Définit le type de graphique sur TableChart et renvoie un Embedded
.
Renvois
Embedded
: compilateur pour un tableau.
build()
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
Embedded
: graphique créé, qui doit encore être ajouté à la feuille de calcul.
clear Ranges()
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
Embedded
: ce générateur, pour le chaînage.
get Chart Type()
get Container()
Renvoie le graphique Container
, 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
Container
: objet contenant la position du conteneur du graphique.
get Ranges()
Renvoie une copie de la liste des plages fournissant actuellement des données pour ce graphique. Utilisez add
et remove
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.
remove Range(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 add
. 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
Nom | Type | Description |
---|---|---|
range | Range | Plage à supprimer. |
Renvois
Embedded
: ce générateur, pour le chaînage.
reverse Categories()
Inverse l'ordre de tracé des séries sur l'axe du domaine. Pour les graphiques à plage verticale (comme les graphiques en courbes, en aires ou à colonnes), cela signifie que l'axe horizontal est tracé de droite à gauche. Pour les graphiques à plage horizontale (comme les graphiques à barres), cela signifie que l'axe vertical est tracé de haut en bas. Pour les graphiques à secteurs, cela signifie que les secteurs sont dessinés dans le sens inverse des aiguilles d'une montre.
// Creates a pie chart builder and sets drawing of the slices in a // counter-clockwise manner. const builder = Charts.newPieChart(); builder.reverseCategories();
Renvois
Embedded
: ce générateur, utile pour le chaînage.
set Background Color(cssValue)
Définit la couleur de l'arrière-plan du graphique.
// Creates a line chart builder and sets the background color to gray const builder = Charts.newLineChart(); builder.setBackgroundColor('gray');
Paramètres
Nom | Type | Description |
---|---|---|
css | String | Valeur CSS de la couleur (par exemple, "blue" ou "#00f" ). |
Renvois
Embedded
: ce générateur, utile pour le chaînage.
set Chart Type(type)
Modifie le type de graphique. Tous les types de graphiques intégrés ne sont pas compatibles pour le moment. Consultez les 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);
Paramètres
Nom | Type | Description |
---|---|---|
type | Chart | Type de graphique à utiliser. |
Renvois
Embedded
: ce générateur, pour le chaînage.
set Colors(cssValues)
Définit les couleurs des lignes du graphique.
// Creates a line chart builder and sets the first two lines to be drawn in // green and red, respectively. const builder = Charts.newLineChart(); builder.setColors(['green', 'red']);
Paramètres
Nom | Type | Description |
---|---|---|
css | String[] | Tableau de valeurs CSS de couleur, tel que ["red", "#acf"] . Le nième élément du tableau représente la couleur de la nième ligne du graphique. |
Renvois
Embedded
: ce générateur, utile pour le chaînage.
set Curve Style(style)
Définit le style à utiliser pour les courbes du graphique. Consultez Curve
pour connaître les styles de courbe autorisés.
// Creates a line chart builder and curves the lines in the chart. const builder = Charts.newLineChart(); builder.setCurveStyle(Charts.CurveStyle.SMOOTH);
Paramètres
Nom | Type | Description |
---|---|---|
style | Curve | Style des courbes du graphique. |
Renvois
Embedded
: ce générateur, utile pour le chaînage.
Voir aussi
set Hidden Dimension Strategy(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 | Chart | Stratégie à utiliser pour les lignes et colonnes masquées. |
Renvois
Embedded
: ce générateur, pour le chaînage.
set Legend Position(position)
Définit la position de la légende par rapport au graphique. Par défaut, aucune légende n'est affichée.
// Creates a line chart builder and sets the legend position to right. const builder = Charts.newLineChart(); builder.setLegendPosition(Charts.Position.RIGHT);
Paramètres
Nom | Type | Description |
---|---|---|
position | Position | Position de la légende. |
Renvois
Embedded
: ce générateur, utile pour le chaînage.
set Legend Text Style(textStyle)
Définit le style du texte de la légende du graphique.
// Creates a line chart builder and sets it up for a blue, 26-point legend. const textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26); const style = textStyleBuilder.build(); const builder = Charts.newLineChart(); builder.setLegendTextStyle(style);
Paramètres
Nom | Type | Description |
---|---|---|
text | Text | Style de texte à utiliser pour la légende du graphique. |
Renvois
Embedded
: ce générateur, utile pour le chaînage.
set Merge Strategy(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 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
Nom | Type | Description |
---|---|---|
merge | Chart | Stratégie de fusion à utiliser. |
Renvois
Embedded
: ce générateur, pour le chaînage.
set Num Headers(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
Embedded
: ce générateur, pour le chaînage.
set Option(option, value)
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
Nom | Type | Description |
---|---|---|
option | String | Nom de l'option. |
value | Object | Valeur de l'option. |
Renvois
Embedded
: ce générateur, pour le chaînage.
set Point Style(style)
Définit le style des points de la ligne. Par défaut, les points n'ont pas de style particulier et seule la ligne est visible.
// Creates a line chart builder and sets large point style. const builder = Charts.newLineChart(); builder.setPointStyle(Charts.PointStyle.LARGE);
Paramètres
Nom | Type | Description |
---|---|---|
style | Point | Style à utiliser pour les points de la ligne. |
Renvois
Embedded
: ce générateur, utile pour le chaînage.
Voir aussi
set Position(anchorRowPos, anchorColPos, offsetX, offsetY)
Définit la position du graphique dans la feuille. anchor
et anchor
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
Nom | Type | Description |
---|---|---|
anchor | Integer | Le haut du graphique est ancré dans cette ligne. |
anchor | 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 | L'angle inférieur gauche du graphique est décalé de ce nombre de pixels. |
Renvois
Embedded
: ce générateur, pour le chaînage.
set Range(start, end)
Définit la plage du graphique.
Si des points de données se trouvent en dehors de la plage, celle-ci est étendue pour les inclure.
Paramètres
Nom | Type | Description |
---|---|---|
start | Number | Valeur de la ligne de grille la plus basse de l'axe de plage. |
end | Number | Valeur de la ligne de grille la plus élevée de l'axe de plage. |
Renvois
Embedded
: ce générateur, utile pour le chaînage.
set Title(chartTitle)
Définit le titre du graphique. Le titre s'affiche au centre, au-dessus du graphique.
// Creates a line chart builder and title to 'My Line Chart'. const builder = Charts.newLineChart(); builder.setTitle('My Line Chart');
Paramètres
Nom | Type | Description |
---|---|---|
chart | String | le titre du graphique. |
Renvois
Embedded
: ce générateur, utile pour le chaînage.
set Title Text Style(textStyle)
Définit le style du texte du titre du graphique.
// Creates a line chart builder and sets it up for a blue, 26-point title. const textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26); const style = textStyleBuilder.build(); const builder = Charts.newLineChart(); builder.setTitleTextStyle(style);
Paramètres
Nom | Type | Description |
---|---|---|
text | Text | Style de texte à utiliser pour le titre du graphique. Vous pouvez créer un objet Text en appelant Charts.newTextStyle() . |
Renvois
Embedded
: ce générateur, utile pour le chaînage.
set Transpose Rows And Columns(transpose)
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
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
Embedded
: ce générateur, pour le chaînage.
set XAxis Text Style(textStyle)
Définit le style du texte de l'axe horizontal.
// Creates a line chart builder and sets the X-axis text style to blue, 18-point // font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setXAxisTextStyle(textStyle);
Paramètres
Nom | Type | Description |
---|---|---|
text | Text | Style de texte à utiliser pour le titre de l'axe horizontal. Vous pouvez créer un objet Text en appelant Charts.newTextStyle() . |
Renvois
Embedded
: ce générateur, utile pour le chaînage.
set XAxis Title(title)
Ajoute un titre à l'axe horizontal. Le titre est centré et apparaît sous les libellés des valeurs de l'axe.
// Creates a line chart builder and sets the X-axis title. const builder = Charts.newLineChart(); builder.setTitle('X-axis Title');
Paramètres
Nom | Type | Description |
---|---|---|
title | String | Titre de l'axe X. |
Renvois
Embedded
: ce générateur, utile pour le chaînage.
set XAxis Title Text Style(textStyle)
Définit le style du texte du titre de l'axe horizontal.
// Creates a line chart builder and sets the X-axis title text style to blue, // 18-point font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setXAxisTitleTextStyle(textStyle);
Paramètres
Nom | Type | Description |
---|---|---|
text | Text | Style de texte à utiliser pour le titre de l'axe horizontal. Vous pouvez créer un objet Text en appelant Charts.newTextStyle() . |
Renvois
Embedded
: ce générateur, utile pour le chaînage.
set YAxis Text Style(textStyle)
Définit le style du texte de l'axe vertical.
// Creates a line chart builder and sets the Y-axis text style to blue, 18-point // font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setYAxisTextStyle(textStyle);
Paramètres
Nom | Type | Description |
---|---|---|
text | Text | Style de texte à utiliser pour le titre de l'axe horizontal. Vous pouvez créer un objet Text en appelant Charts.newTextStyle() . |
Renvois
Embedded
: ce générateur, utile pour le chaînage.
set YAxis Title(title)
Ajoute un titre à l'axe vertical. Le titre est centré et apparaît à gauche des libellés de valeurs.
// Creates a line chart builder and sets the Y-axis title. const builder = Charts.newLineChart(); builder.setYAxisTitle('Y-axis Title');
Paramètres
Nom | Type | Description |
---|---|---|
title | String | Titre de l'axe Y. |
Renvois
Embedded
: ce générateur, utile pour le chaînage.
set YAxis Title Text Style(textStyle)
Définit le style du texte du titre de l'axe vertical.
// Creates a line chart builder and sets the Y-axis title text style to blue, // 18-point font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setYAxisTitleTextStyle(textStyle);
Paramètres
Nom | Type | Description |
---|---|---|
text | Text | Style de texte à utiliser pour le titre de l'axe horizontal. Vous pouvez créer un objet Text en appelant Charts.newTextStyle() . |
Renvois
Embedded
: ce générateur, utile pour le chaînage.
use Log Scale()
Convertit l'axe de plage en échelle logarithmique (toutes les valeurs doivent être positives). L'axe de plage est l'axe vertical pour les graphiques verticaux (comme les graphiques en courbes, en aires ou à colonnes) et l'axe horizontal pour les graphiques horizontaux (comme les graphiques à barres).
Renvois
Embedded
: ce générateur, utile pour le chaînage.