Compilateur pour les graphiques à secteurs. Pour plus de détails, voir le document documentation.
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Ajoute une plage au graphique modifié par ce générateur. |
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 de façon à refléter toutes les modifications qui lui sont apportées. |
clearRanges() | EmbeddedChartBuilder | Supprime toutes les plages du graphique modifié par ce générateur. |
getChartType() | ChartType | Renvoie le type de graphique actuel. |
getContainer() | ContainerInfo | Renvoyez le graphique ContainerInfo , qui encapsule l'emplacement du graphique sur la
feuille. |
getRanges() | Range[] | Affiche une copie de la liste des plages fournissant actuellement des données pour ce graphique. |
removeRange(range) | EmbeddedChartBuilder | Supprime la plage spécifiée du graphique modifié par ce générateur. |
reverseCategories() | EmbeddedPieChartBuilder | Inverse le dessin d'une série sur l'axe du domaine. |
set3D() | EmbeddedPieChartBuilder | Définit le graphique pour qu'il soit tridimensionnel. |
setBackgroundColor(cssValue) | EmbeddedPieChartBuilder | Définit la couleur d'arrière-plan du graphique. |
setChartType(type) | EmbeddedChartBuilder | Modifie le type de graphique. |
setColors(cssValues) | EmbeddedPieChartBuilder | Définit les couleurs des lignes du graphique. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Définit la stratégie à utiliser pour les lignes et les colonnes masquées. |
setLegendPosition(position) | EmbeddedPieChartBuilder | Définit la position de la légende par rapport au graphique. |
setLegendTextStyle(textStyle) | EmbeddedPieChartBuilder | Définit le style du texte de la légende du graphique. |
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 du graphique en modifiant sa position sur la feuille. |
setTitle(chartTitle) | EmbeddedPieChartBuilder | Définit le titre du graphique. |
setTitleTextStyle(textStyle) | EmbeddedPieChartBuilder | Définit le style du texte du titre du graphique. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Détermine si les lignes et les colonnes du graphique sont transposées. |
Documentation détaillée
addRange(range)
Ajoute une plage au graphique modifié par ce générateur. La plage n'est pas ajoutée si elle a déjà été 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
Nom | Type | Description |
---|---|---|
range | Range | Plage à ajouter. |
Renvois
EmbeddedChartBuilder
: 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
: compilateur de graphiques à barres
asColumnChart()
Définit le type de graphique sur "ColumnChart" et renvoie un EmbeddedColumnChartBuilder
.
Renvois
EmbeddedColumnChartBuilder
: compilateur pour un graphique à colonnes
asComboChart()
Définit le type de graphique sur ComboChart et renvoie un EmbeddedComboChartBuilder
.
Renvois
EmbeddedComboChartBuilder
: outil de création d'un graphique combiné
asHistogramChart()
Définit le type de graphique sur HistogramChart et renvoie un EmbeddedHistogramChartBuilder
.
Renvois
EmbeddedHistogramChartBuilder
: outil de création d'histogrammes
asLineChart()
Définit le type de graphique sur "LineChart" et renvoie un EmbeddedLineChartBuilder
.
Renvois
EmbeddedLineChartBuilder
: compilateur pour un graphique en courbes
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
: compilateur pour un graphique à nuage de points
asTableChart()
Définit le type de graphique sur TableChart et renvoie un EmbeddedTableChartBuilder
.
Renvois
EmbeddedTableChartBuilder
: compilateur de tableaux
build()
Crée le graphique de façon à refléter toutes les modifications qui lui sont apportées.
Avec cette méthode, le graphique ne se superpose pas automatiquement à 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)
.
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);
Renvois
EmbeddedChart
: graphique créé, qui doit quand même être ajouté à la feuille de calcul
clearRanges()
Supprime toutes les plages du graphique modifié par ce générateur.
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);
Renvois
EmbeddedChartBuilder
: compilateur, pour le chaînage
getChartType()
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());
Renvois
ContainerInfo
: objet contenant la position du conteneur du graphique
getRanges()
Affiche 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.
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()); }
Renvois
Range[]
: tableau de plages servant de source de données pour le graphique à créer
removeRange(range)
Supprime la plage spécifiée du graphique modifié par ce générateur. 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
à partir 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
Nom | Type | Description |
---|---|---|
range | Range | Plage à supprimer. |
Renvois
EmbeddedChartBuilder
: compilateur, pour le chaînage
reverseCategories()
Inverse le dessin d'une série sur l'axe du domaine. Pour les graphiques à secteurs verticaux (tels que les graphiques en courbes, les graphiques en aires ou à colonnes), cela signifie que l'axe horizontal est tracé de droite à gauche. Pour les graphiques à barres horizontales (comme les graphiques à barres), l'axe vertical est tracé de haut en bas, 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. var builder = Charts.newPieChart(); builder.reverseCategories();
Renvois
EmbeddedPieChartBuilder
: compilateur, utile pour les enchaînements.
set3D()
Définit le graphique pour qu'il soit tridimensionnel.
Renvois
EmbeddedPieChartBuilder
: compilateur, utile pour le chaînage.
setBackgroundColor(cssValue)
Définit la couleur d'arrière-plan du graphique.
// Creates a line chart builder and sets the background color to gray var builder = Charts.newLineChart(); builder.setBackgroundColor("gray");
Paramètres
Nom | Type | Description |
---|---|---|
cssValue | String | Valeur CSS de la couleur (par exemple, "blue" ou "#00f" ). |
Renvois
EmbeddedPieChartBuilder
: compilateur, utile pour les enchaînements.
setChartType(type)
Modifie le type de graphique. Tous les types de graphiques intégrés ne sont pas pris en charge 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
Nom | Type | Description |
---|---|---|
type | ChartType | Type de modification du graphique. |
Renvois
EmbeddedChartBuilder
: compilateur, pour le chaînage
setColors(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. var builder = Charts.newLineChart(); builder.setColors(["green", "red"]);
Paramètres
Nom | Type | Description |
---|---|---|
cssValues | String[] | Tableau de valeurs CSS de couleur, par exemple ["red", "#acf"] . Le n-ième élément
du tableau représente la couleur de la nième ligne du graphique. |
Renvois
EmbeddedPieChartBuilder
: compilateur, utile pour les enchaînements.
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
Nom | Type | Description |
---|---|---|
strategy | ChartHiddenDimensionStrategy | Stratégie à utiliser pour les lignes et les colonnes masquées. |
Renvois
EmbeddedChartBuilder
: compilateur, pour le chaînage
setLegendPosition(position)
Définit la position de la légende par rapport au graphique. Par défaut, il n'y a pas de légende.
// Creates a line chart builder and sets the legend position to right. var builder = Charts.newLineChart(); builder.setLegendPosition(Charts.Position.RIGHT);
Paramètres
Nom | Type | Description |
---|---|---|
position | Position | Position de la légende. |
Renvois
EmbeddedPieChartBuilder
: compilateur, utile pour le chaînage.
setLegendTextStyle(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. var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26); var style = textStyleBuilder.build(); var builder = Charts.newLineChart(); builder.setLegendTextStyle(style);
Paramètres
Nom | Type | Description |
---|---|---|
textStyle | TextStyle | Style de texte à utiliser pour la légende du graphique. |
Renvois
EmbeddedPieChartBuilder
: compilateur, 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 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
Nom | Type | Description |
---|---|---|
mergeStrategy | ChartMergeStrategy | Stratégie de fusion à utiliser. |
Renvois
EmbeddedChartBuilder
: 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.
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
Nom | Type | Description |
---|---|---|
headers | Integer | Nombre de lignes ou de colonnes à traiter comme des en-têtes. Les valeurs négatives provoquent des en-têtes doivent être détectées automatiquement. |
Renvois
EmbeddedChartBuilder
: compilateur, pour le chaînage
setOption(option, value)
Définit les options avancées de ce graphique. Pour afficher la liste des options disponibles, reportez-vous à la section Graphique options de configuration.
Cette méthode ne valide pas l'option spécifiée pour ce type de graphique, ni si le présente un format ou une structure appropriés.
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
Nom | Type | Description |
---|---|---|
option | String | Nom de l'option. |
value | Object | Valeur de l'option. |
Renvois
EmbeddedChartBuilder
: compilateur pour le chaînage.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)
Définit la position du graphique en modifiant sa position sur la feuille. anchorRowPos
et
anchorColPos
sont indexés en 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
Nom | Type | Description |
---|---|---|
anchorRowPos | Integer | La partie supérieure du graphique est ancrée sur cette ligne. |
anchorColPos | Integer | La partie gauche du graphique est ancrée dans cette colonne. |
offsetX | Integer | L'angle 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
EmbeddedChartBuilder
: compilateur, pour le chaînage
setTitle(chartTitle)
Définit le titre du graphique. Le titre est affiché au centre du graphique.
// Creates a line chart builder and title to 'My Line Chart'. var builder = Charts.newLineChart(); builder.setTitle('My Line Chart')
Paramètres
Nom | Type | Description |
---|---|---|
chartTitle | String | le titre du graphique. |
Renvois
EmbeddedPieChartBuilder
: compilateur, utile pour le chaînage.
setTitleTextStyle(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. var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26); var style = textStyleBuilder.build(); var builder = Charts.newLineChart(); builder.setTitleTextStyle(style);
Paramètres
Nom | Type | Description |
---|---|---|
textStyle | TextStyle | Style de texte à utiliser pour le titre du graphique. Vous pouvez créer un objet TextStyleBuilder en appelant Charts.newTextStyle() . |
Renvois
EmbeddedPieChartBuilder
: compilateur, utile pour les enchaînements.
setTransposeRowsAndColumns(transpose)
Détermine 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
Nom | Type | Description |
---|---|---|
transpose | Boolean | Si la valeur est true , les lignes et les colonnes utilisées pour construire le graphique sont
transposée. |
Renvois
EmbeddedChartBuilder
: compilateur, pour le chaînage