Class EmbeddedChartBuilder

EmbeddedChartBuilder

Konstruktor użyty do edytowania elementu EmbeddedChart. Zmiany na wykresie są zapisywane dopiero po Funkcja Sheet.updateChart(chart) jest wywoływana na odtworzonym wykresie.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B8");
var 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);

Metody

MetodaZwracany typKrótki opis
addRange(range)EmbeddedChartBuilderDodaje zakres do wykresu edytowanego przez ten kreator.
asAreaChart()EmbeddedAreaChartBuilderUstawia typ wykresu na Wykres warstwowy i zwraca wartość EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderUstawia typ wykresu na Wykres słupkowy i zwraca EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderUstawia typ wykresu na ColumnChart i zwraca EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderUstawia typ wykresu na ComboChart i zwraca wartość EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderUstawia typ wykresu na HistogramChart i zwraca wartość EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderUstawia typ wykresu na Wykres liniowy i zwraca wartość EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderUstawia typ wykresu na Wykres kołowy i zwraca wartość EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderUstawia typ wykresu na wykres punktowy i zwraca wartość EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderUstawia typ wykresu na TableChart i zwraca EmbeddedTableChartBuilder.
build()EmbeddedChartTworzy wykres w sposób odzwierciedlający wszystkie wprowadzone w nim zmiany.
clearRanges()EmbeddedChartBuilderUsuwa wszystkie zakresy z wykresu edytowanego przez ten kreator.
getChartType()ChartTypeZwraca bieżący typ wykresu.
getContainer()ContainerInfoZwraca wykres ContainerInfo, który zawiera informacje o tym, gdzie na wykresie arkusza kalkulacyjnego.
getRanges()Range[]Zwraca kopię listy zakresów, które obecnie dostarczają dane do tego wykresu.
removeRange(range)EmbeddedChartBuilderUsuwa określony zakres z wykresu edytowanego przez ten kreator.
setChartType(type)EmbeddedChartBuilderZmienia typ wykresu.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderOkreśla strategię, która ma być stosowana w przypadku ukrytych wierszy i kolumn.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderUstawia strategię scalania używaną, gdy istnieje więcej niż 1 zakres.
setNumHeaders(headers)EmbeddedChartBuilderOkreśla liczbę wierszy lub kolumn w zakresie, które mają być traktowane jako nagłówki.
setOption(option, value)EmbeddedChartBuilderOkreśla zaawansowane opcje tego wykresu.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderUstawia położenie, zmieniając miejsce, w którym wykres ma pojawić się w arkuszu.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderOkreśla, czy wiersze i kolumny wykresu mają być transponowane.

Szczegółowa dokumentacja

addRange(range)

Dodaje zakres do wykresu edytowanego przez ten kreator. Nie dodaje zakresu, jeśli został już utworzony. który został dodany do wykresu.

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

Parametry

NazwaTypOpis
rangeRangeZakres do dodania.

Powrót

EmbeddedChartBuilder – ten kreator do tworzenia łańcuchów


asAreaChart()

Ustawia typ wykresu na Wykres warstwowy i zwraca wartość EmbeddedAreaChartBuilder.

Powrót

EmbeddedAreaChartBuilder – narzędzie do tworzenia wykresów warstwowych


asBarChart()

Ustawia typ wykresu na Wykres słupkowy i zwraca EmbeddedBarChartBuilder.

Powrót

EmbeddedBarChartBuilder – narzędzie do tworzenia wykresów słupkowych


asColumnChart()

Ustawia typ wykresu na ColumnChart i zwraca EmbeddedColumnChartBuilder.

Powrót

EmbeddedColumnChartBuilder – narzędzie do tworzenia wykresów kolumnowych.


asComboChart()

Ustawia typ wykresu na ComboChart i zwraca wartość EmbeddedComboChartBuilder.

Powrót

EmbeddedComboChartBuilder – narzędzie do tworzenia wykresów mieszanych


asHistogramChart()

Ustawia typ wykresu na HistogramChart i zwraca wartość EmbeddedHistogramChartBuilder.

Powrót

EmbeddedHistogramChartBuilder – narzędzie do tworzenia histogramu


asLineChart()

Ustawia typ wykresu na Wykres liniowy i zwraca wartość EmbeddedLineChartBuilder.

Powrót

EmbeddedLineChartBuilder – narzędzie do tworzenia wykresów liniowych


asPieChart()

Ustawia typ wykresu na Wykres kołowy i zwraca wartość EmbeddedPieChartBuilder.

Powrót

EmbeddedPieChartBuilder – narzędzie do tworzenia wykresu kołowego


asScatterChart()

Ustawia typ wykresu na wykres punktowy i zwraca wartość EmbeddedScatterChartBuilder.

Powrót

EmbeddedScatterChartBuilder – narzędzie do tworzenia wykresu punktowego


asTableChart()

Ustawia typ wykresu na TableChart i zwraca EmbeddedTableChartBuilder.

Powrót

EmbeddedTableChartBuilder – narzędzie do tworzenia wykresów tabelarycznych


build()

Tworzy wykres w sposób odzwierciedlający wszystkie wprowadzone w nim zmiany.

Ta metoda nie powoduje automatycznego rysowania w arkuszu kalkulacyjnym. Nowy wykres należy wstawić za pomocą sheet.insertChart(chart), a istniejący wykres powinien zostać zaktualizowany przez: 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);

Powrót

EmbeddedChart – utworzony wykres, który należy jeszcze dodać do arkusza kalkulacyjnego.


clearRanges()

Usuwa wszystkie zakresy z wykresu edytowanego przez ten kreator.

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

Powrót

EmbeddedChartBuilder – ten kreator do tworzenia łańcuchów


getChartType()

Zwraca bieżący typ wykresu.

Powrót

ChartType – typ wykresu,


getContainer()

Zwraca wykres ContainerInfo, który zawiera informacje o tym, gdzie na wykresie arkusza kalkulacyjnego.

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

Powrót

ContainerInfo – obiekt zawierający pozycję kontenera wykresu.


getRanges()

Zwraca kopię listy zakresów, które obecnie dostarczają dane do tego wykresu. Użyj narzędzi addRange(range) i removeRange(range), by zmodyfikować tę listę.

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

Powrót

Range[] – tablica zakresów, która służy jako źródło danych do utworzenia wykresu


removeRange(range)

Usuwa określony zakres z wykresu edytowanego przez ten kreator. Nie zwraca błędu, jeśli: zakresu nie ma na tym wykresie.

Usunięty zakres musi pasować do zakresu dodanego za pomocą funkcji addRange(range); w przeciwnym razie wykres nie ulegnie zmianie. Tej metody nie można używać do częściowego usuwania wartości z zakresu.

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

Parametry

NazwaTypOpis
rangeRangeZakres do usunięcia.

Powrót

EmbeddedChartBuilder – ten kreator do tworzenia łańcuchów


setChartType(type)

Zmienia typ wykresu. Nie wszystkie typy wykresów umieszczanych są obecnie obsługiwane. Zobacz 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);

Parametry

NazwaTypOpis
typeChartTypeTyp, na który ma zostać zmieniony ten wykres.

Powrót

EmbeddedChartBuilder – ten kreator do tworzenia łańcuchów


setHiddenDimensionStrategy(strategy)

Określa strategię, która ma być stosowana w przypadku ukrytych wierszy i kolumn. Domyślna wartość to 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);

Parametry

NazwaTypOpis
strategyChartHiddenDimensionStrategyStrategia stosowana w przypadku ukrytych wierszy i kolumn.

Powrót

EmbeddedChartBuilder – ten kreator do tworzenia łańcuchów


setMergeStrategy(mergeStrategy)

Ustawia strategię scalania używaną, gdy istnieje więcej niż 1 zakres. Jeśli MERGE_ROWS, wiersze są scalane; jeśli MERGE_COLUMNS, kolumny zostaną scalone. Domyślna wartość to 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);

Parametry

NazwaTypOpis
mergeStrategyChartMergeStrategyWybrana strategia scalania.

Powrót

EmbeddedChartBuilder – ten kreator do tworzenia łańcuchów


setNumHeaders(headers)

Określa liczbę wierszy lub kolumn w zakresie, które mają być traktowane jako nagłówki.

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

Parametry

NazwaTypOpis
headersIntegerLiczba wierszy lub kolumn, które mają być traktowane jako nagłówki. Wartości ujemne powodują nagłówki co ma zostać automatycznie wykryte.

Powrót

EmbeddedChartBuilder – ten kreator do tworzenia łańcuchów


setOption(option, value)

Określa zaawansowane opcje tego wykresu. Listę dostępnych opcji znajdziesz w sekcji Wykres opcje konfiguracji.

Ta metoda nie sprawdza, czy podana opcja jest odpowiednia dla tego typu wykresu ani jeśli ma prawidłowy format/strukturę.

Ten przykład pokazuje, jak zmienić tytuł i ustawić legendę.

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

Parametry

NazwaTypOpis
optionStringNazwa opcji.
valueObjectWartość opcji.

Powrót

EmbeddedChartBuilder – narzędzie do tworzenia łańcuchów.


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Ustawia położenie, zmieniając miejsce, w którym wykres ma pojawić się w arkuszu. anchorRowPos i anchorColPos mają 1 indeks.

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

Parametry

NazwaTypOpis
anchorRowPosIntegerGórna strona wykresu jest zakotwiczona w tym wierszu.
anchorColPosIntegerLewa strona wykresu jest zakotwiczona w tej kolumnie.
offsetXIntegerPrawy górny róg wykresu jest przesunięty o taką liczbę pikseli.
offsetYIntegerLewy dolny róg wykresu jest przesunięty o tyle pikseli.

Powrót

EmbeddedChartBuilder – ten kreator do tworzenia łańcuchów


setTransposeRowsAndColumns(transpose)

Określa, czy wiersze i kolumny wykresu mają być transponowane. Jeśli ma wartość true, wiersze i kolumny zostaną przełączone. Domyślna wartość to 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);

Parametry

NazwaTypOpis
transposeBooleanJeśli ustawiona jest wartość true, wiersze i kolumny użyte do utworzenia wykresu są dane transponowane.

Powrót

EmbeddedChartBuilder – ten kreator do tworzenia łańcuchów