Excel.ChartAxisTitle class

Пакет:

excel

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.1 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
format	Задает форматирование заголовка оси диаграммы.
text	Задает заголовок оси.
textOrientation	Задает угол, на который ориентирован текст для заголовка оси диаграммы. Значение должно быть целым числом от -90 до 90 или целым числом 180 для вертикально ориентированного текста.
visible	Указывает, отображается ли название оси.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setFormula(formula)	Строковое значение, представляющее формулу заголовка оси диаграммы с использованием нотации стиля A1.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.ChartAxisTitle является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ChartAxisTitleData), который содержит мелкие копии всех загруженных дочерних свойств из исходного объекта.

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

context

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

context: RequestContext;

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

Excel.RequestContext

format

Задает форматирование заголовка оси диаграммы.

readonly format: Excel.ChartAxisTitleFormat;

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

Excel.ChartAxisTitleFormat

Комментарии

[ Набор API: ExcelApi 1.1 ]

text

Задает заголовок оси.

text: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.1 ]

textOrientation

Задает угол, на который ориентирован текст для заголовка оси диаграммы. Значение должно быть целым числом от -90 до 90 или целым числом 180 для вертикально ориентированного текста.

textOrientation: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.12 ]

Примеры

await Excel.run(async (context) => {
  // Get a chart named "Sales Chart" from the "Sample" worksheet.
  const sheet = context.workbook.worksheets.getItem("Sample");
  let chart = sheet.charts.getItem("Sales Chart");

  // Set the value axis title to "Profits".
  chart.axes.valueAxis.title.text = "Profits";

  /* Set the value axis text orientation to 0.
    For charts with a y-axis, this makes the label on the y-axis horizontal, 
    instead of the default look of rotated-vertically.
    */ 
  chart.axes.valueAxis.title.textOrientation = 0;
  await context.sync();
});

visible

Указывает, отображается ли название оси.

visible: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

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

load(options)

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

load(options?: Excel.Interfaces.ChartAxisTitleLoadOptions): Excel.ChartAxisTitle;

Параметры

options

Excel.Interfaces.ChartAxisTitleLoadOptions

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

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

Excel.ChartAxisTitle

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.ChartAxisTitle

Примеры

// Add "Values" as the title for the value Axis.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1"); 
    chart.axes.valueAxis.title.text = "Values";
    await context.sync();
    
    console.log("Axis Title Added ");
});

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.ChartAxisTitle

set(properties, options)

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

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

Параметры

properties

Excel.Interfaces.ChartAxisTitleUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.ChartAxisTitle): void;

Параметры

properties

Excel.ChartAxisTitle

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

void

setFormula(formula)

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

setFormula(formula: string): void;

Параметры

formula

string

Строка, представляющая заданную формулу.

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

void

Комментарии

[ Набор API: ExcelApi 1.8 ]

toJSON()

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

toJSON(): Excel.Interfaces.ChartAxisTitleData;

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

Excel.Interfaces.ChartAxisTitleData