Class EmbeddedChartBuilder

Umieszczaniewykresuw kreatorze

Kreator służący do edytowania EmbeddedChart. Zmiany wprowadzone w tabeli nie są zapisywane, dopóki nie zostanie wywołana funkcja Sheet.updateChart(chart) w przypadku odtworzonej tabeli.

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

Metody

MetodaZwracany typKrótki opis
addRange(range)EmbeddedChartBuilderDodaje zakres do wykresu modyfikowanego przez ten kreator.
asAreaChart()EmbeddedAreaChartBuilderUstawia typ wykresu na AreaChart i zwraca EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderUstawia typ wykresu na „BarChart” i zwraca EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderUstawia typ wykresu na ColumnChart i zwraca EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderUstawia typ wykresu na „ComboChart” i zwraca EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderUstawia typ wykresu na HistogramChart i zwraca EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderUstawia typ wykresu na „LineChart” i zwraca EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderUstawia typ wykresu na PieChart i zwraca EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderUstawia typ wykresu na ScatterChart i zwraca EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderUstawia typ wykresu na „Tabela” i zwraca EmbeddedTableChartBuilder.
build()EmbeddedChartTworzy wykres, uwzględniając wszystkie wprowadzone w nim zmiany.
clearRanges()EmbeddedChartBuilderUsuwa z wykresu wszystkie zakresy, które modyfikuje ten kreator.
getChartType()ChartTypeZwraca bieżący typ wykresu.
getContainer()ContainerInfoZwraca wykres ContainerInfo, który zawiera informacje o tym, gdzie wykres jest widoczny w arkuszu.
getRanges()Range[]Zwraca kopię listy zakresów, które obecnie dostarczają dane na potrzeby tego wykresu.
removeRange(range)EmbeddedChartBuilderUsuwa określony zakres z wykresu modyfikowanego przez ten kreator.
setChartType(type)EmbeddedChartBuilderZmienia typ wykresu.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderOkreśla strategię używaną w przypadku ukrytych wierszy i kolumn.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderOkreśla strategię scalania, której należy użyć, 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 zaawansowane opcje wykresu.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderUstawia położenie wykresu na arkuszu.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderOkreśla, czy wiersze i kolumny wykresu mają być zamieniane miejscami.

Szczegółowa dokumentacja

addRange(range)

Dodaje zakres do wykresu modyfikowanego przez ten kreator. Nie dodaje zakresu, jeśli został on już dodany do wykresu.

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

Parametry

NazwaTypOpis
rangeRangeZakres do dodania.

Powrót

EmbeddedChartBuilder – ten kreator do łańcuchowania


asAreaChart()

Ustawia typ wykresu na AreaChart i zwraca EmbeddedAreaChartBuilder.

Powrót

EmbeddedAreaChartBuilder – kreator wykresu warstwowego


asBarChart()

Ustawia typ wykresu na „BarChart” i zwraca EmbeddedBarChartBuilder.

Powrót

EmbeddedBarChartBuilder – kreator wykresu słupkowego,


asColumnChart()

Ustawia typ wykresu na ColumnChart i zwraca EmbeddedColumnChartBuilder.

Powrót

EmbeddedColumnChartBuilder – kreator wykresu kolumnowego


asComboChart()

Ustawia typ wykresu na „ComboChart” i zwraca EmbeddedComboChartBuilder.

Powrót

EmbeddedComboChartBuilder – kreator wykresu mieszanego


asHistogramChart()

Ustawia typ wykresu na HistogramChart i zwraca EmbeddedHistogramChartBuilder.

Powrót

EmbeddedHistogramChartBuilder – kreator histogramu


asLineChart()

Ustawia typ wykresu na „LineChart” i zwraca EmbeddedLineChartBuilder.

Powrót

EmbeddedLineChartBuilder – kreator wykresu liniowego


asPieChart()

Ustawia typ wykresu na PieChart i zwraca EmbeddedPieChartBuilder.

Powrót

EmbeddedPieChartBuilder – kreator wykresu kołowego


asScatterChart()

Ustawia typ wykresu na ScatterChart i zwraca EmbeddedScatterChartBuilder.

Powrót

EmbeddedScatterChartBuilder – kreator wykresu punktowego


asTableChart()

Ustawia typ wykresu na „Tabela” i zwraca EmbeddedTableChartBuilder.

Powrót

EmbeddedTableChartBuilder – kreator wykresu tabelarycznego


build()

Tworzy wykres, uwzględniając wszystkie wprowadzone w nim zmiany.

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

Powrót

EmbeddedChart – utworzony wykres, który musi zostać dodany do arkusza kalkulacyjnego.


clearRanges()

Usuwa z wykresu wszystkie zakresy, które modyfikuje ten kreator.

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

Powrót

EmbeddedChartBuilder – ten kreator do łańcuchowania


getChartType()

Zwraca bieżący typ wykresu.

Powrót

ChartType – typ wykresu


getContainer()

Zwraca wykres ContainerInfo, który zawiera informacje o tym, gdzie wykres jest widoczny w arkuszu.

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

Powrót

ContainerInfo – obiekt zawierający położenie kontenera wykresu


getRanges()

Zwraca kopię listy zakresów, które obecnie dostarczają dane na potrzeby tego wykresu. Aby zmodyfikować tę listę, użyj opcji addRange(range) i removeRange(range).

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

Powrót

Range[] – tablica zakresów, które służą jako źródło danych wykresu, który ma zostać utworzony


removeRange(range)

Usuwa określony zakres z wykresu modyfikowanego przez ten kreator. Nie powoduje błędu, jeśli zakres nie znajduje się na tym wykresie.

Usuwany zakres musi być zgodny z zakresem dodanym za pomocą addRange(range). W przeciwnym razie wykres nie ulegnie zmianie. Tej metody nie można użyć do częściowego usuwania wartości z zakresu.

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

const chart = chartBuilder.build();

sheet.insertChart(chart);

Parametry

NazwaTypOpis
rangeRangeZakres do usunięcia.

Powrót

EmbeddedChartBuilder – ten kreator do łańcuchowania


setChartType(type)

Zmienia typ wykresu. Obecnie nie wszystkie typy osadzonych wykresów są obsługiwane. Zobacz ChartType.

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

Parametry

NazwaTypOpis
typeChartTypeTyp, na który chcesz zmienić ten wykres.

Powrót

EmbeddedChartBuilder – ten kreator do łańcuchowania


setHiddenDimensionStrategy(strategy)

Określa strategię używaną w przypadku ukrytych wierszy i kolumn. Domyślna wartość to 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);

Parametry

NazwaTypOpis
strategyChartHiddenDimensionStrategyStrategia stosowana w przypadku ukrytych wierszy i kolumn.

Powrót

EmbeddedChartBuilder – ten kreator do łańcuchowania


setMergeStrategy(mergeStrategy)

Określa strategię scalania, której należy użyć, gdy istnieje więcej niż 1 zakres. Jeśli MERGE_ROWS, wiersze są scalane; jeśli MERGE_COLUMNS, kolumny są scalane. Domyślna wartość to 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);

Parametry

NazwaTypOpis
mergeStrategyChartMergeStrategyStrategia łączenia do użycia.

Powrót

EmbeddedChartBuilder – ten kreator do łańcuchowania


setNumHeaders(headers)

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

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

Parametry

NazwaTypOpis
headersIntegerLiczba wierszy lub kolumn, które mają być traktowane jako nagłówki. Wartości ujemne powodują automatyczne wykrywanie nagłówków.

Powrót

EmbeddedChartBuilder – ten kreator do łańcuchowania


setOption(option, value)

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

Ta metoda nie sprawdza, czy wybrana opcja jest odpowiednia dla tego typu wykresu ani czy wartość ma prawidłowy format lub strukturę.

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

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

Parametry

NazwaTypOpis
optionStringNazwa opcji.
valueObjectWartość opcji.

Powrót

EmbeddedChartBuilder – ten kreator do łańcuchowania.


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Ustawia położenie wykresu na arkuszu. Funkcje anchorRowPosanchorColPos są indeksowane od 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);

Parametry

NazwaTypOpis
anchorRowPosIntegerGórna krawędź wykresu jest przypięta do tego wiersza.
anchorColPosIntegerLewa strona wykresu jest zakotwiczona w tej kolumnie.
offsetXIntegerPrawy górny róg wykresu jest przesunięty o tyle pikseli.
offsetYIntegerLewym dolnym rogu wykresu przesuwa się o tyle pikseli.

Powrót

EmbeddedChartBuilder – ten kreator do łańcuchowania


setTransposeRowsAndColumns(transpose)

Określa, czy wiersze i kolumny wykresu mają być zamieniane miejscami. Jeśli ustawisz wartość true, wiersze i kolumny zostaną zamienione. Domyślna wartość to 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);

Parametry

NazwaTypOpis
transposeBooleanJeśli true, wiersze i kolumny użyte do stworzenia wykresu zostaną zamienione miejscami.

Powrót

EmbeddedChartBuilder – ten kreator do łańcuchowania