Поделиться через


Excel.Chart class

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

Extends

Комментарии

[ Набор API: ExcelApi 1.1 ]

Свойства

axes

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

context

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

dataLabels

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

format

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

height

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

left

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

legend

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

name

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

series

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

title

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

top

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

width

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

worksheet

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

Методы

delete()

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

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), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

axes

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

readonly axes: Excel.ChartAxes;

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

context

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

context: RequestContext;

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

dataLabels

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

readonly dataLabels: Excel.ChartDataLabels;

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

format

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

readonly format: Excel.ChartAreaFormat;

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

height

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

height: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.1 ]

left

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

left: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.1 ]

legend

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

readonly legend: Excel.ChartLegend;

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

// 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

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

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

series

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

readonly series: Excel.ChartSeriesCollection;

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

title

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

readonly title: Excel.ChartTitle;

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

top

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

top: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.1 ]

width

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

width: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.1 ]

worksheet

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

readonly worksheet: Excel.Worksheet;

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

Комментарии

[ Набор API: ExcelApi 1.2 ]

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

delete()

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

delete(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.delete();
    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

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

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

Комментарии

[ Набор API: ExcelApi 1.2 ]

Примеры

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)

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

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

Параметры

width

number

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

height

number

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

fittingModeString

"Fit" | "FitAndCenter" | "Fill"

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

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

Комментарии

[ Набор API: ExcelApi 1.2 ]

load(options)

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

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

Параметры

options
Excel.Interfaces.ChartLoadOptions

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

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

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Примеры

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

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

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

Параметры

propertyNamesAndPaths

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

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

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

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

// 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"

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

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

void

Комментарии

[ Набор API: ExcelApi 1.1 ]

setPosition(startCell, endCell)

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

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

Параметры

startCell

Excel.Range | string

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

endCell

Excel.Range | string

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

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

void

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

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;

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