Excel.Chart class

Ссылка

Пакет:: excel

Представляет объект диаграммы в книге. Дополнительные сведения об объектной модели диаграмм см. в статье Работа с диаграммами с помощью API JavaScript для Excel.

Extends: OfficeExtension.ClientObject

Свойства

axes	Представляет оси диаграммы.
categoryLabelLevel	Задает константу перечисления уровня меток категории диаграммы, ссылающуюся на уровень исходных меток категорий.
chartType	Указывает тип диаграммы. Дополнительные сведения см. в этой `Excel.ChartType` статье.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
dataLabels	Представляет метки данных на диаграмме.
displayBlanksAs	Указывает способ построения пустых ячеек на диаграмме.
format	Инкапсулирует свойства формата для области диаграммы.
height	Задает высоту объекта диаграммы (в точках).
id	Уникальный идентификатор диаграммы.
left	Расстояние в пунктах от левого края диаграммы до начала листа.
legend	Представляет условные обозначения для диаграммы.
name	Указывает имя объекта диаграммы.
pivotOptions	Объединяет параметры для сводной диаграммы.
plotArea	Представляет область диаграммы.
plotBy	Определяет способ использования столбцов или строк в качестве рядов данных на диаграмме.
plotVisibleOnly	True, если отображаются только видимые ячейки. False, если отображаются как видимые, так и скрытые ячейки.
series	Представляет один ряд данных или коллекцию рядов данных в диаграмме.
seriesNameLevel	Указывает константу перечисления уровня имен рядов диаграммы, ссылающуюся на уровень имен исходных рядов.
showAllFieldButtons	Указывает, должны ли отображаться все кнопки полей в сводной диаграмме.
showDataLabelsOverMaximum	Указывает, следует ли отображать метки данных, если значение больше максимального значения на оси значений. Если ось значений становится меньше, чем размер точек данных, можно использовать это свойство, чтобы задать, следует ли отображать метки данных. Это свойство применяется только к двухd-диаграммам.
style	Задает стиль диаграммы.
title	Представляет заголовок указанной диаграммы, включая его текст, видимость, положение и форматирование.
top	Указывает расстояние (в точках) от верхнего края объекта до верхней строки 1 (на листе) или верхней части области диаграммы (на диаграмме).
width	Задает ширину объекта диаграммы (в точках).
worksheet	Лист, содержащий текущую диаграмму.

Методы

activate()	Активирует диаграмму в пользовательском интерфейсе Excel.
delete()	Удаляет объект диаграммы.
getDataRange()	Возвращает источник данных для всей диаграммы. Если диапазон данных пуст, этот метод вернет ошибку `EmptyChartSeries` .
getDataRangeOrNullObject()	Возвращает источник данных для всей диаграммы. Если диапазон данных пуст, то этот метод возвращает объект со свойством `isNullObjecttrue`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getDataTable()	Возвращает таблицу данных на диаграмме. Если диаграмма не позволяет использовать таблицу данных, она вызовет исключение.
getDataTableOrNullObject()	Возвращает таблицу данных на диаграмме. Если диаграмма не позволяет использовать таблицу данных, то этот метод возвращает объект со свойством `isNullObject` .`true` Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getImage(width, height, fittingMode)	Отрисовывает диаграмму в виде изображения с кодировкой base64, масштабируя ее в соответствии с указанным размером. Пропорции сохраняются при изменении размера.
getImage(width, height, fittingModeString)	Отрисовывает диаграмму в виде изображения с кодировкой base64, масштабируя ее в соответствии с указанным размером. Пропорции сохраняются при изменении размера.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setData(sourceData, seriesBy)	Сбрасывает исходные данные для диаграммы.
setData(sourceData, seriesByString)	Сбрасывает исходные данные для диаграммы.
setPosition(startCell, endCell)	Располагает диаграмму относительно ячеек на листе.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный объект Excel.Chart является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.ChartData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

События

onActivated	Происходит при активации диаграммы.
onDeactivated	Происходит при отключении диаграммы.

Сведения о свойстве

axes

Представляет оси диаграммы.

readonly axes: Excel.ChartAxes;

Значение свойства

Excel.ChartAxes

categoryLabelLevel

Задает константу перечисления уровня меток категории диаграммы, ссылающуюся на уровень исходных меток категорий.

categoryLabelLevel: number;

Значение свойства

number

chartType

Указывает тип диаграммы. Дополнительные сведения см. в этой Excel.ChartType статье.

chartType: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel";

Значение свойства

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

dataLabels

Представляет метки данных на диаграмме.

readonly dataLabels: Excel.ChartDataLabels;

Значение свойства

Excel.ChartDataLabels

displayBlanksAs

Указывает способ построения пустых ячеек на диаграмме.

displayBlanksAs: Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted";

Значение свойства

Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted"

format

Инкапсулирует свойства формата для области диаграммы.

readonly format: Excel.ChartAreaFormat;

Значение свойства

Excel.ChartAreaFormat

height

Задает высоту объекта диаграммы (в точках).

height: number;

Значение свойства

number

id

Уникальный идентификатор диаграммы.

readonly id: string;

Значение свойства

string

left

Расстояние в пунктах от левого края диаграммы до начала листа.

left: number;

Значение свойства

number

legend

Представляет условные обозначения для диаграммы.

readonly legend: Excel.ChartLegend;

Значение свойства

Excel.ChartLegend

Примеры

// Set to show legend of Chart1 and make it on top of the chart.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.legend.visible = true;
    chart.legend.position = "Top"; 
    chart.legend.overlay = false; 
    await context.sync()
    
    console.log("Legend Shown ");
});

name

Указывает имя объекта диаграммы.

name: string;

Значение свойства

string

Примеры

// Rename the chart to new name, resize the chart to 200 points in both height and weight.
// Move Chart1 to 100 points to the top and left.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.name = "New Name";
    chart.top = 100;
    chart.left = 100;
    chart.height = 200;
    chart.width = 200;
    await context.sync(); 
});

pivotOptions

Объединяет параметры для сводной диаграммы.

readonly pivotOptions: Excel.ChartPivotOptions;

Значение свойства

Excel.ChartPivotOptions

plotArea

Представляет область диаграммы.

readonly plotArea: Excel.ChartPlotArea;

Значение свойства

Excel.ChartPlotArea

plotBy

Определяет способ использования столбцов или строк в качестве рядов данных на диаграмме.

plotBy: Excel.ChartPlotBy | "Rows" | "Columns";

Значение свойства

Excel.ChartPlotBy | "Rows" | "Columns"

plotVisibleOnly

True, если отображаются только видимые ячейки. False, если отображаются как видимые, так и скрытые ячейки.

plotVisibleOnly: boolean;

Значение свойства

boolean

series

Представляет один ряд данных или коллекцию рядов данных в диаграмме.

readonly series: Excel.ChartSeriesCollection;

Значение свойства

Excel.ChartSeriesCollection

seriesNameLevel

Указывает константу перечисления уровня имен рядов диаграммы, ссылающуюся на уровень имен исходных рядов.

seriesNameLevel: number;

Значение свойства

number

showAllFieldButtons

Указывает, должны ли отображаться все кнопки полей в сводной диаграмме.

showAllFieldButtons: boolean;

Значение свойства

boolean

showDataLabelsOverMaximum

Указывает, следует ли отображать метки данных, если значение больше максимального значения на оси значений. Если ось значений становится меньше, чем размер точек данных, можно использовать это свойство, чтобы задать, следует ли отображать метки данных. Это свойство применяется только к двухd-диаграммам.

showDataLabelsOverMaximum: boolean;

Значение свойства

boolean

style

Задает стиль диаграммы.

style: number;

Значение свойства

number

title

Представляет заголовок указанной диаграммы, включая его текст, видимость, положение и форматирование.

readonly title: Excel.ChartTitle;

Значение свойства

Excel.ChartTitle

top

Указывает расстояние (в точках) от верхнего края объекта до верхней строки 1 (на листе) или верхней части области диаграммы (на диаграмме).

top: number;

Значение свойства

number

width

Задает ширину объекта диаграммы (в точках).

width: number;

Значение свойства

number

worksheet

Лист, содержащий текущую диаграмму.

readonly worksheet: Excel.Worksheet;

Значение свойства

Excel.Worksheet

Сведения о методе

activate()

Активирует диаграмму в пользовательском интерфейсе Excel.

activate(): void;

Возвращаемое значение

void

delete()

Удаляет объект диаграммы.

delete(): void;

Возвращаемое значение

void

Примеры

await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.delete();
    await context.sync(); 
});

getDataRange()

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает источник данных для всей диаграммы. Если диапазон данных пуст, этот метод вернет ошибку EmptyChartSeries .

getDataRange(): OfficeExtension.ClientResult<string>;

Возвращаемое значение

OfficeExtension.ClientResult<string>

getDataRangeOrNullObject()

Примечание

Возвращает источник данных для всей диаграммы. Если диапазон данных пуст, то этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getDataRangeOrNullObject(): OfficeExtension.ClientResult<string>;

Возвращаемое значение

OfficeExtension.ClientResult<string>

getDataTable()

Возвращает таблицу данных на диаграмме. Если диаграмма не позволяет использовать таблицу данных, она вызовет исключение.

getDataTable(): Excel.ChartDataTable;

Возвращаемое значение

Excel.ChartDataTable

getDataTableOrNullObject()

Возвращает таблицу данных на диаграмме. Если диаграмма не позволяет использовать таблицу данных, то этот метод возвращает объект со свойством isNullObject .true Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getDataTableOrNullObject(): Excel.ChartDataTable;

Возвращаемое значение

Excel.ChartDataTable

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-table.yaml

// This function adds a data table to a chart that already exists on the worksheet. 
await Excel.run(async (context) => {
  // Retrieve the chart named "SalesChart" from the "Sample" worksheet.
  const chart = context.workbook.worksheets.getItem("Sample").charts.getItem("SalesChart");

  // Get the data table object for the chart and set it to visible.
  const chartDataTable = chart.getDataTableOrNullObject();
  chartDataTable.load("visible");
  chartDataTable.visible = true;
  await context.sync();
});

getImage(width, height, fittingMode)

Отрисовывает диаграмму в виде изображения с кодировкой base64, масштабируя ее в соответствии с указанным размером. Пропорции сохраняются при изменении размера.

getImage(width?: number, height?: number, fittingMode?: Excel.ImageFittingMode): OfficeExtension.ClientResult<string>;

Параметры

width: number

Необязательный параметр. Нужная ширина создаваемого изображения.

height: number

Необязательный параметр. Нужная высота создаваемого изображения.

fittingMode: Excel.ImageFittingMode

Необязательный параметр. Метод, используемый для масштабирования диаграммы до заданных измерений (если заданы высота и ширина).

Возвращаемое значение

OfficeExtension.ClientResult<string>

Примеры

await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    const image = chart.getImage();
    await context.sync(); 
});

getImage(width, height, fittingModeString)

getImage(width?: number, height?: number, fittingModeString?: "Fit" | "FitAndCenter" | "Fill"): OfficeExtension.ClientResult<string>;

Параметры

width: number

Необязательный параметр. Нужная ширина создаваемого изображения.

height: number

Необязательный параметр. Нужная высота создаваемого изображения.

fittingModeString: "Fit" | "FitAndCenter" | "Fill"

Возвращаемое значение

OfficeExtension.ClientResult<string>

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.ChartLoadOptions): Excel.Chart;

Параметры

options: Excel.Interfaces.ChartLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

Excel.Chart

load(propertyNames)

load(propertyNames?: string | string[]): Excel.Chart;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Excel.Chart

Примеры

// Get a chart named "Chart1".
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.load('name');
    await context.sync();

    console.log(chart.name);
});

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Chart;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Excel.Chart

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.ChartUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Excel.Interfaces.ChartUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Excel.Chart): void;

Параметры

properties: Excel.Chart

Возвращаемое значение

void

setData(sourceData, seriesBy)

Сбрасывает исходные данные для диаграммы.

setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy): void;

Параметры

sourceData: Excel.Range

Объект диапазона, соответствующий исходным данным.

seriesBy: Excel.ChartSeriesBy

Определяет способ использования столбцов или строк в качестве рядов данных на диаграмме. Может быть одним из следующих значений: Auto (по умолчанию), Rows и Columns. Дополнительные сведения см. в этой Excel.ChartSeriesBy статье.

Возвращаемое значение

void

Примеры

// Set the sourceData to be the range at "A1:B4" and seriesBy to be "Columns".
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sheet1");
    const chart = sheet.charts.getItem("Chart1");
    const sourceData = sheet.getRange("A1:B4");
    chart.setData(sourceData, "Columns");
    await context.sync();
});

setData(sourceData, seriesByString)

Сбрасывает исходные данные для диаграммы.

setData(sourceData: Range, seriesByString?: "Auto" | "Columns" | "Rows"): void;

Параметры

sourceData: Excel.Range

Объект диапазона, соответствующий исходным данным.

seriesByString: "Auto" | "Columns" | "Rows"

Возвращаемое значение

void

setPosition(startCell, endCell)

Располагает диаграмму относительно ячеек на листе.

setPosition(startCell: Range | string, endCell?: Range | string): void;

Параметры

startCell: Excel.Range | string

Начальная ячейка. Место, куда будет перемещена диаграмма. Начальная ячейка — это верхняя левая или верхняя правая ячейка (это зависит от того, использует ли пользователь параметры отображения справа налево).

endCell: Excel.Range | string

Необязательный параметр. Конечная ячейка. Если указан этот параметр, значения ширины и высоты диаграммы будут заданы так, чтобы полностью покрыть данную ячейку или диапазон.

Возвращаемое значение

void

Примеры

await Excel.run(async (context) => { 
    const sheetName = "Charts";
    const rangeSelection = "A1:B4";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeSelection);
    const sourceData = sheetName + "!" + "A1:B4";
    const chart = context.workbook.worksheets.getItem(sheetName).charts.add("pie", range, "auto");
    chart.width = 500;
    chart.height = 300;
    chart.setPosition("C2", null);
    await context.sync(); 
});

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.Chart является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ChartData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.ChartData;

Возвращаемое значение

Excel.Interfaces.ChartData

Сведения о событии

onActivated

Происходит при активации диаграммы.

readonly onActivated: OfficeExtension.EventHandlers<Excel.ChartActivatedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.ChartActivatedEventArgs>

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-chart-activated.yaml

await Excel.run(async (context) => {

    const pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");

    // Register the onActivated and onDeactivated event handlers.
    pieChart.onActivated.add(chartActivated);
    pieChart.onDeactivated.add(chartDeactivated);

    await context.sync();

    console.log("Added handlers for Chart onActivated and onDeactivated events.");
});

...

async function chartActivated(event) {
    await Excel.run(async (context) => {
        // Retrieve the worksheet.
        const sheet = context.workbook.worksheets.getActiveWorksheet();

        // Retrieve the activated chart by ID and load the name of the chart. 
        const activatedChart = sheet.charts.getItem(event.chartId);
        activatedChart.load(["name"]);
        await context.sync();

        // Print out the activated chart's data.
        console.log(`A chart was activated. ID: ${event.chartId}. Chart name: ${activatedChart.name}.`);
    });
}

onDeactivated

Происходит при отключении диаграммы.

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.ChartDeactivatedEventArgs>;

Тип события

OfficeExtension.EventHandlers<Excel.ChartDeactivatedEventArgs>

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-chart-activated.yaml

await Excel.run(async (context) => {

    const pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");

    // Register the onActivated and onDeactivated event handlers.
    pieChart.onActivated.add(chartActivated);
    pieChart.onDeactivated.add(chartDeactivated);

    await context.sync();

    console.log("Added handlers for Chart onActivated and onDeactivated events.");
});

...

async function chartDeactivated(event) {
    await Excel.run(async (context) => {
        // Callback function for when the chart is deactivated.
        console.log("The pie chart is NOT active.");
    });
}

Excel.Chart class

Комментарии

Свойства

Методы

События

Сведения о свойстве

axes

Значение свойства

Комментарии

categoryLabelLevel

Значение свойства

Комментарии

chartType

Значение свойства

Комментарии

context

Значение свойства

dataLabels

Значение свойства

Комментарии

displayBlanksAs

Значение свойства

Комментарии

format

Значение свойства

Комментарии

height

Значение свойства

Комментарии

id

Значение свойства

Комментарии

left

Значение свойства

Комментарии

legend

Значение свойства

Комментарии

Примеры

name

Значение свойства

Комментарии

Примеры

pivotOptions

Значение свойства

Комментарии

plotArea

Значение свойства

Комментарии

plotBy

Значение свойства

Комментарии

plotVisibleOnly

Значение свойства

Комментарии

series

Значение свойства

Комментарии

seriesNameLevel

Значение свойства

Комментарии

showAllFieldButtons

Значение свойства

Комментарии

showDataLabelsOverMaximum

Значение свойства

Комментарии

style

Значение свойства

Комментарии

title

Значение свойства

Комментарии

top

Значение свойства

Комментарии

width

Значение свойства

Комментарии

worksheet