Excel.ChartAxes class

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

Extends

Комментарии

[ Набор API: ExcelApi 1.1 ]

Свойства

categoryAxis

Представляет ось категорий на диаграмме.

context

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

seriesAxis

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

valueAxis

Представляет ось значений для оси.

Методы

getItem(type, group)

Возвращает указанную ось, определенную по типу и группе.

getItem(typeString, groupString)

Возвращает указанную ось, определенную по типу и группе.

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

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

set(properties)

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

toJSON()

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

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

categoryAxis

Представляет ось категорий на диаграмме.

readonly categoryAxis: Excel.ChartAxis;

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

context

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

context: RequestContext;

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

seriesAxis

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

readonly seriesAxis: Excel.ChartAxis;

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

valueAxis

Представляет ось значений для оси.

readonly valueAxis: Excel.ChartAxis;

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

// Set the maximum, minimum, majorUnit, minorUnit of valueAxis.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.axes.valueAxis.maximum = 5;
    chart.axes.valueAxis.minimum = 0;
    chart.axes.valueAxis.majorUnit = 1;
    chart.axes.valueAxis.minorUnit = 0.2;
    await context.sync();

    console.log("Axis Settings Changed");
});

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

getItem(type, group)

Возвращает указанную ось, определенную по типу и группе.

getItem(type: Excel.ChartAxisType, group?: Excel.ChartAxisGroup): Excel.ChartAxis;

Параметры

type
Excel.ChartAxisType

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

group
Excel.ChartAxisGroup

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

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

Комментарии

[ Набор API: ExcelApi 1.7 ]

getItem(typeString, groupString)

Возвращает указанную ось, определенную по типу и группе.

getItem(typeString: "Invalid" | "Category" | "Value" | "Series", groupString?: "Primary" | "Secondary"): Excel.ChartAxis;

Параметры

typeString

"Invalid" | "Category" | "Value" | "Series"

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

groupString

"Primary" | "Secondary"

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

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

Комментарии

[ Набор API: ExcelApi 1.7 ]

load(options)

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

load(options?: Excel.Interfaces.ChartAxesLoadOptions): Excel.ChartAxes;

Параметры

options
Excel.Interfaces.ChartAxesLoadOptions

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

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

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

set(properties, options)

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

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

Параметры

properties
Excel.Interfaces.ChartAxesUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.ChartAxes): void;

Параметры

properties
Excel.ChartAxes

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

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartAxesData;

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