Excel.ChartTitle class
Представляет объект заголовка диаграммы.
- Extends
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| format | Представляет форматирование названия диаграммы, включая формат заливки и шрифта. |
| height | Возвращает высоту заголовка диаграммы (в пунктах). Значение, |
| horizontal |
Выравнивание заголовка диаграммы по горизонтали. |
| left | Указывает расстояние (в пунктах) от левого края заголовка диаграммы до левого края области диаграммы. Значение, |
| overlay | Определяет, будет ли название диаграммы накладываться на диаграмму. |
| position | Представляет положение заголовка диаграммы. См. |
| show |
Представляет логическое значение, которое определяет, есть ли тень в заголовке диаграммы. |
| text | Указывает текст заголовка диаграммы. |
| text |
Указывает угол, под которым ориентирован текст для заголовка диаграммы. Значение должно быть либо целым числом от -90 до 90, либо целым числом 180 для вертикально ориентированного текста. |
| top | Указывает расстояние (в пунктах) от верхнего края заголовка диаграммы до вершины области диаграммы. Значение, |
| vertical |
Выравнивание заголовка диаграммы по вертикали. См. |
| visible | Указывает, виден ли заголовок диаграммы. |
| width | Ширина заголовка диаграммы (в пунктах). Значение, |
Методы
| get |
Получить подстроку названия диаграммы. Разрыв строки "\n" отсчитывает один символ. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| set |
Задает строковое значение, представляющее формулу заголовка диаграммы с использованием нотации стиля A1. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
format
Представляет форматирование названия диаграммы, включая формат заливки и шрифта.
readonly format: Excel.ChartTitleFormat;Значение свойства
Комментарии
height
Возвращает высоту заголовка диаграммы (в пунктах). Значение, null если название диаграммы не отображается.
readonly height: number;Значение свойства
number
Комментарии
horizontalAlignment
Выравнивание заголовка диаграммы по горизонтали.
horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";Значение свойства
Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"
Комментарии
left
Указывает расстояние (в пунктах) от левого края заголовка диаграммы до левого края области диаграммы. Значение, null если название диаграммы не отображается.
left: number;Значение свойства
number
Комментарии
overlay
Определяет, будет ли название диаграммы накладываться на диаграмму.
overlay: boolean;Значение свойства
boolean
Комментарии
position
Представляет положение заголовка диаграммы. См. Excel.ChartTitlePosition дополнительные сведения.
position: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right";Значение свойства
Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right"
Комментарии
showShadow
Представляет логическое значение, которое определяет, есть ли тень в заголовке диаграммы.
showShadow: boolean;Значение свойства
boolean
Комментарии
text
Указывает текст заголовка диаграммы.
text: string;Значение свойства
string
Комментарии
textOrientation
Указывает угол, под которым ориентирован текст для заголовка диаграммы. Значение должно быть либо целым числом от -90 до 90, либо целым числом 180 для вертикально ориентированного текста.
textOrientation: number;Значение свойства
number
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-title-format.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const title = sheet.charts.getItemAt(0).title;
title.textOrientation = -45;
await context.sync();
});
top
Указывает расстояние (в пунктах) от верхнего края заголовка диаграммы до вершины области диаграммы. Значение, null если название диаграммы не отображается.
top: number;Значение свойства
number
Комментарии
verticalAlignment
Выравнивание заголовка диаграммы по вертикали. См. Excel.ChartTextVerticalAlignment дополнительные сведения.
verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";Значение свойства
Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"
Комментарии
visible
Указывает, виден ли заголовок диаграммы.
visible: boolean;Значение свойства
boolean
Комментарии
width
Ширина заголовка диаграммы (в пунктах). Значение, null если название диаграммы не отображается.
readonly width: number;Значение свойства
number
Комментарии
Сведения о методе
getSubstring(start, length)
Получить подстроку названия диаграммы. Разрыв строки "\n" отсчитывает один символ.
getSubstring(start: number, length: number): Excel.ChartFormatString;Параметры
- start
-
number
Начальная позиция извлекаемой подстроки. Используется нулевой индекс.
- length
-
number
Длина извлекаемой подстроки.
Возвращаемое значение
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-title-format.yaml
await Excel.run(async (context) => {
let sheet = context.workbook.worksheets.getItem("Sample");
let chart = sheet.charts.getItemAt(0);
// Get first seven characters of the title and color them green.
chart.title.getSubstring(0, 7).font.color = "Yellow";
await context.sync();
});
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.ChartTitleLoadOptions): Excel.ChartTitle;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.ChartTitle;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
Примеры
// Set the text of the chart title to "My Chart" and display it as an overlay on the chart.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.title.text= "My Chart";
chart.title.visible=true;
chart.title.overlay=true;
await context.sync();
console.log("Char Title Changed");
});
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartTitle;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.ChartTitleUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.ChartTitleUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Excel.ChartTitle): void;Параметры
- properties
- Excel.ChartTitle
Возвращаемое значение
void
setFormula(formula)
Задает строковое значение, представляющее формулу заголовка диаграммы с использованием нотации стиля A1.
setFormula(formula: string): void;Параметры
- formula
-
string
Строка, представляющая формулу, которую нужно задать.
Возвращаемое значение
void
Комментарии
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ChartTitle объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ChartTitleData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.ChartTitleData;