Compilateur utilisé pour modifier un Embedded
. Les modifications apportées au graphique ne sont pas enregistrées tant que Sheet.updateChart(chart)
n'est pas appelé sur le graphique reconstruit.
const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('A1: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);
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. |
set | Embedded | Modifie le type de graphique. |
set | Embedded | Définit la stratégie à utiliser pour les lignes et colonnes masquées. |
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 la position du graphique dans la feuille. |
set | Embedded | Indique si les lignes et les colonnes du graphique sont transposées. |
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.
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 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 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 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 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.