Class EmbeddedChartBuilder

Obudowany wykres

Kreator służy do edycji elementu EmbeddedChart. Zmiany na wykresie zostaną zapisane dopiero po wywołaniu interfejsu Sheet.updateChart(chart) na nowo 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 do wykresu zakres, który zmienia ten konstruktor.
asAreaChart()EmbeddedAreaChartBuilderUstawia typ wykresu na AreaWykres i zwraca EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderUstawia typ wykresu na wykres słupkowy i zwraca EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderUstawia typ wykresu na COLUMNWykres i zwraca EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderUstawia typ wykresu na Połączony i zwraca EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderUstawia typ wykresu na histogram i zwraca EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderUstawia typ wykresu na wykres liniowy i zwraca EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderUstawia typ wykresu na wykres kołowy i zwraca EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderUstawia typ wykresu na Wykres rozproszony i zwraca EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderUstawia typ wykresu na tabelę tabel i zwraca EmbeddedTableChartBuilder.
build()EmbeddedChartTworzy wykres, aby odzwierciedlić wszystkie wprowadzone w nim zmiany.
clearRanges()EmbeddedChartBuilderUsuwa wszystkie zakresy z wykresu, który zmienia ten konstruktor.
getChartType()ChartTypeZwraca bieżący typ wykresu.
getContainer()ContainerInfoZwraca wykres ContainerInfo, który przedstawia miejsce na wykresie.
getRanges()Range[]Zwraca kopię listy zakresów, która zawiera obecnie dane dla tego wykresu.
removeRange(range)EmbeddedChartBuilderUsuwa określony zakres z wykresu, który jest modyfikowany przez ten konstruktor.
setChartType(type)EmbeddedChartBuilderZmienia typ wykresu.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderOkreśla strategię ukrywania wierszy i kolumn.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderUstawia strategię scalania, która ma być używana, gdy istnieje więcej niż 1 zakres.
setNumHeaders(headers)EmbeddedChartBuilderOkreśla liczbę wierszy lub kolumn zakresu, które mają być traktowane jako nagłówki.
setOption(option, value)EmbeddedChartBuilderUstawia na tym wykresie opcje zaawansowane.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderUstawia pozycję, zmieniając miejsce wyświetlania wykresu na arkuszu.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderOkreśla, czy wiersze i kolumny wykresu są transponowane.

Szczegółowa dokumentacja

addRange(range)

Dodaje do wykresu zakres, który zmienia ten konstruktor. 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.

Zwróć

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


asAreaChart()

Ustawia typ wykresu na AreaWykres i zwraca EmbeddedAreaChartBuilder.

Zwróć

EmbeddedAreaChartBuilder – konstrukcja do wykresu warstwowego


asBarChart()

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

Zwróć

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


asColumnChart()

Ustawia typ wykresu na COLUMNWykres i zwraca EmbeddedColumnChartBuilder.

Zwróć

EmbeddedColumnChartBuilder – narzędzie do tworzenia wykresów kolumnowych


asComboChart()

Ustawia typ wykresu na Połączony i zwraca EmbeddedComboChartBuilder.

Zwróć

EmbeddedComboChartBuilder – konstrukcja wykresu mieszanego


asHistogramChart()

Ustawia typ wykresu na histogram i zwraca EmbeddedHistogramChartBuilder.

Zwróć

EmbeddedHistogramChartBuilder – narzędzie do tworzenia histogramu


asLineChart()

Ustawia typ wykresu na wykres liniowy i zwraca EmbeddedLineChartBuilder.

Zwróć

EmbeddedLineChartBuilder – narzędzie do tworzenia wykresów liniowych


asPieChart()

Ustawia typ wykresu na wykres kołowy i zwraca EmbeddedPieChartBuilder.

Zwróć

EmbeddedPieChartBuilder – konstrukcja do wykresu kołowego


asScatterChart()

Ustawia typ wykresu na Wykres rozproszony i zwraca EmbeddedScatterChartBuilder.

Zwróć

EmbeddedScatterChartBuilder – konstruktor do wykresu punktowego


asTableChart()

Ustawia typ wykresu na tabelę tabel i zwraca EmbeddedTableChartBuilder.

Zwróć

EmbeddedTableChartBuilder – edytor tabel


build()

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

Ta metoda nie powoduje automatycznego rysowania wykresu u góry arkusza kalkulacyjnego. Nowy wykres należy wstawić za pomocą metody sheet.insertChart(chart), a istniejący wykres należy zaktualizować za pomocą metody 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);

Zwróć

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


clearRanges()

Usuwa wszystkie zakresy z wykresu, który zmienia 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);

Zwróć

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


getChartType()

Zwraca bieżący typ wykresu.

Zwróć

ChartType – typ wykresu,


getContainer()

Zwraca wykres ContainerInfo, który przedstawia miejsce na wykresie.

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

Zwróć

ContainerInfo – obiekt zawierający pozycję kontenera wykresu,


getRanges()

Zwraca kopię listy zakresów, która zawiera obecnie dane dla tego wykresu. Aby zmodyfikować tę listę, użyj wartości addRange(range) i removeRange(range).

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

Zwróć

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


removeRange(range)

Usuwa określony zakres z wykresu, który jest modyfikowany przez ten konstruktor. Nie zwraca błędu, jeśli zakres nie znajduje się na tym wykresie.

Zakres musi być zgodny z zakresem dodanym za pomocą 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.

Zwróć

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


setChartType(type)

Zmienia typ wykresu. Nie wszystkie typy osadzonych 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, do którego należy przekształcić ten wykres.

Zwróć

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


setHiddenDimensionStrategy(strategy)

Określa strategię ukrywania 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.

Zwróć

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


setMergeStrategy(mergeStrategy)

Ustawia strategię scalania, która ma być używana, gdy istnieje więcej niż 1 zakres. Jeśli MERGE_ROWS, wiersze są scalone, a MERGE_COLUMNS – kolumny. 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 używana.

Zwróć

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


setNumHeaders(headers)

Określa 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.

Zwróć

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


setOption(option, value)

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

Ta metoda nie sprawdza poprawności wybranej opcji dla tego typu wykresu ani gdy wartość ma prawidłowy format lub 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.

Zwróć

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


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Ustawia pozycję, zmieniając miejsce wyświetlania wykresu na arkuszu. Roboty anchorRowPos i anchorColPos są indeksowane.

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órny bok wykresu jest zakotwiczony 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 tyle pikseli.

Zwróć

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


setTransposeRowsAndColumns(transpose)

Określa, czy wiersze i kolumny wykresu są transponowane. Jeśli ma wartość true, wiersze i kolumny są przełączane. 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 true, wiersze i kolumny użyte do utworzenia wykresu są transponowane.

Zwróć

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