Class EmbeddedChartBuilder

EmbeddedChartBuilder

Konstruktor użyty do edytowania elementu EmbeddedChart. Zmiany wprowadzone na wykresie nie są zapisywane, dopóki na utworzonym wykresie nie zostanie wywołana funkcja Sheet.updateChart(chart).

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, które zmieni to narzędzie.
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 Wykres kolumnowy i zwraca wartość EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderUstawia typ wykresu na Wykres mieszany i zwraca wartość EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderUstawia typ wykresu na HistogramChart i zwraca wartość EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderUstawia typ wykresu na Wykres liniowy i zwraca EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderUstawia typ wykresu na Wykres kołowy i zwraca wartość EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderUstawia typ wykresu na Wykres rozproszony i zwraca wartość EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderUstawia typ wykresu na Wykres tabelaryczny i zwraca wartość EmbeddedTableChartBuilder.
build()EmbeddedChartTworzy wykres, aby odzwierciedlić wszystkie wprowadzone na nim zmiany.
clearRanges()EmbeddedChartBuilderUsuwa wszystkie zakresy z wykresu zmienionego przez ten konstruktor.
getChartType()ChartTypeZwraca bieżący typ wykresu.
getContainer()ContainerInfoZwróć wykres ContainerInfo, który zawiera miejsce na wykresie w arkuszu.
getRanges()Range[]Zwraca kopię listy zakresów, które obecnie dostarczają dane do tego wykresu.
removeRange(range)EmbeddedChartBuilderUsuwa określony zakres z wykresu, które zmieni ten kreator.
setChartType(type)EmbeddedChartBuilderZmienia typ wykresu.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderUstawia strategię, która ma być używana w przypadku ukrytych wierszy i kolumn.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderUstawia strategię scalania, która ma być używana w przypadku, gdy istnieje więcej niż jeden zakres.
setNumHeaders(headers)EmbeddedChartBuilderUstawia liczbę wierszy lub kolumn zakresu, które mają być traktowane jako nagłówki.
setOption(option, value)EmbeddedChartBuilderUstawia zaawansowane opcje wykresu.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderUstawia położenie, zmieniając miejsce, w którym wykres ma się pojawić w arkuszu.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderOkreśla, czy wiersze i kolumny wykresu są transponowane.

Szczegółowa dokumentacja

addRange(range)

Dodaje zakres do wykresu, które zmieni to narzędzie. Nie dodaje zakresu, jeśli został już 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.

Powroty

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


asAreaChart()

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

Powroty

EmbeddedAreaChartBuilder – kreator wykresów warstwowych


asBarChart()

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

Powroty

EmbeddedBarChartBuilder – kreator wykresów słupkowych


asColumnChart()

Ustawia typ wykresu na Wykres kolumnowy i zwraca wartość EmbeddedColumnChartBuilder.

Powroty

EmbeddedColumnChartBuilder – kreator wykresów kolumnowych


asComboChart()

Ustawia typ wykresu na Wykres mieszany i zwraca wartość EmbeddedComboChartBuilder.

Powroty

EmbeddedComboChartBuilder – kreator wykresów mieszanych


asHistogramChart()

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

Powroty

EmbeddedHistogramChartBuilder – narzędzie do tworzenia histogramu


asLineChart()

Ustawia typ wykresu na Wykres liniowy i zwraca EmbeddedLineChartBuilder.

Powroty

EmbeddedLineChartBuilder – kreator wykresów liniowych.


asPieChart()

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

Powroty

EmbeddedPieChartBuilder – narzędzie do tworzenia wykresu kołowego


asScatterChart()

Ustawia typ wykresu na Wykres rozproszony i zwraca wartość EmbeddedScatterChartBuilder.

Powroty

EmbeddedScatterChartBuilder – kreator wykresów punktowych


asTableChart()

Ustawia typ wykresu na Wykres tabelaryczny i zwraca wartość EmbeddedTableChartBuilder.

Powroty

EmbeddedTableChartBuilder – kreator wykresów tabelarycznych


build()

Tworzy wykres, aby odzwierciedlić wszystkie wprowadzone na nim zmiany.

W ten sposób wykres nie zostanie automatycznie rysowany na arkuszu kalkulacyjnym. Nowy wykres należy wstawić za pomocą sheet.insertChart(chart), a istniejący wykres należy zaktualizować przy użyciu 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);

Powroty

EmbeddedChart – utworzony wykres, który trzeba jeszcze dodać do arkusza kalkulacyjnego


clearRanges()

Usuwa wszystkie zakresy z wykresu zmienionego przez ten konstruktor.

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

Powroty

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


getChartType()

Zwraca bieżący typ wykresu.

Powroty

ChartType – typ wykresu,


getContainer()

Zwróć wykres ContainerInfo, który zawiera miejsce na wykresie w arkuszu.

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

Powroty

ContainerInfo – obiekt zawierający pozycję kontenera wykresu.


getRanges()

Zwraca kopię listy zakresów, które obecnie dostarczają dane do tego wykresu. Użyj addRange(range) i removeRange(range), by zmienić 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());
}

Powroty

Range[] – tablica zakresów, które służą jako źródło danych wykresu przeznaczonego do utworzenia.


removeRange(range)

Usuwa określony zakres z wykresu, które zmieni ten kreator. Nie generuje błędu, jeśli zakresu nie ma na tym wykresie.

Usunięty zakres musi odpowiadać zakresowi dodanemu za pomocą funkcji addRange(range). W przeciwnym razie na wykresie nie zostaną wprowadzone żadne zmiany. 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.

Powroty

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


setChartType(type)

Zmienia typ wykresu. Nie wszystkie typy umieszczonych wykresów 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.

Powroty

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


setHiddenDimensionStrategy(strategy)

Ustawia strategię, która ma być używana 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 używana w przypadku ukrytych wierszy i kolumn.

Powroty

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


setMergeStrategy(mergeStrategy)

Ustawia strategię scalania, która ma być używana w przypadku, gdy istnieje więcej niż jeden zakres. Jeśli ustawiona jest wartość MERGE_ROWS, wiersze są scalone, a jeśli ma wartość MERGE_COLUMNS, kolumny są scalane. 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
mergeStrategyChartMergeStrategyStrategia scalania, której chcesz użyć.

Powroty

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


setNumHeaders(headers)

Ustawia liczbę wierszy lub kolumn zakresu, 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ą automatyczne wykrywanie nagłówków.

Powroty

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


setOption(option, value)

Ustawia zaawansowane opcje wykresu. Listę dostępnych opcji znajdziesz w artykule Opcje konfiguracji wykresu.

Ta metoda nie sprawdza poprawności podanej opcji dla tego typu wykresu lub tego, czy wartość 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.

Powroty

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


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Ustawia położenie, zmieniając miejsce, w którym wykres ma się pojawić w arkuszu. Indeks anchorRowPos i anchorColPos mają wartość 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);

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 odsunięty o tyle pikseli.
offsetYIntegerLewy dolny róg wykresu jest odsunięty o tę liczbę pikseli.

Powroty

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


setTransposeRowsAndColumns(transpose)

Określa, czy wiersze i kolumny wykresu są transponowane. Jeśli ma wartość true, wiersze i kolumny się przełączają. 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 zostaną transponowane.

Powroty

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