Excel.ChartTitle interface

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

Свойства

format

Представляет форматирование названия диаграммы, включая формат заливки и шрифта.

height

Возвращает высоту заголовка диаграммы (в пунктах). Значение null, если заголовок диаграммы не отображается.

horizontalAlignment

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

left

Задает расстояние от левого края заголовка диаграммы до левого края области диаграммы (в пунктах). Значение null, если заголовок диаграммы не отображается.

overlay

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

position

Представляет положение заголовка диаграммы. Дополнительные сведения см. в статье Excel. Чарттитлепоситион.

showShadow

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

text

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

textOrientation

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

top

Задает расстояние от верхнего края заголовка диаграммы до верха области диаграммы (в пунктах). Значение null, если заголовок диаграммы не отображается.

verticalAlignment

Задает вертикальное выравнивание заголовка диаграммы. Дополнительные сведения см. в статье Excel. Чарттекствертикалалигнмент.

visible

Указывает, является ли название диаграммы Visible.

width

Задает ширину заголовка диаграммы (в пунктах). Значение null, если заголовок диаграммы не отображается.

Методы

getSubstring(start, length)

Получение подстроки заголовка диаграммы. Разрыв строки '\n также подсчитывает один символ.

load(propertyNames)

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

setFormula(formula)

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

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

format

Представляет форматирование названия диаграммы, включая формат заливки и шрифта.

readonly format: ChartTitleFormat;

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

height

Возвращает высоту заголовка диаграммы (в пунктах). Значение null, если заголовок диаграммы не отображается.

readonly height: number;

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

number

horizontalAlignment

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

horizontalAlignment:
            | ChartTextHorizontalAlignment
            | "Center"
            | "Left"
            | "Right"
            | "Justify"
            | "Distributed";

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

| ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"

left

Задает расстояние от левого края заголовка диаграммы до левого края области диаграммы (в пунктах). Значение null, если заголовок диаграммы не отображается.

left: number;

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

number

overlay

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

overlay: boolean;

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

boolean

position

Представляет положение заголовка диаграммы. Дополнительные сведения см. в статье Excel. Чарттитлепоситион.

position:
            | ChartTitlePosition
            | "Automatic"
            | "Top"
            | "Bottom"
            | "Left"
            | "Right";

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

| ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right"

showShadow

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

showShadow: boolean;

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

boolean

text

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

text: string;

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

string

textOrientation

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

textOrientation: number;

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

number

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let title = sheet.charts.getItemAt(0).title;
    title.textOrientation = -45;

    await context.sync();
}

top

Задает расстояние от верхнего края заголовка диаграммы до верха области диаграммы (в пунктах). Значение null, если заголовок диаграммы не отображается.

top: number;

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

number

verticalAlignment

Задает вертикальное выравнивание заголовка диаграммы. Дополнительные сведения см. в статье Excel. Чарттекствертикалалигнмент.

verticalAlignment:
            | ChartTextVerticalAlignment
            | "Center"
            | "Bottom"
            | "Top"
            | "Justify"
            | "Distributed";

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

| ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"

visible

Указывает, является ли название диаграммы Visible.

visible: boolean;

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

boolean

width

Задает ширину заголовка диаграммы (в пунктах). Значение null, если заголовок диаграммы не отображается.

readonly width: number;

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

number

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

getSubstring(start, length)

Получение подстроки заголовка диаграммы. Разрыв строки '\n также подсчитывает один символ.

getSubstring(start: number, length: number): ChartFormatString;

Параметры

start
number

Начальное положение подстроки, которую необходимо получить. Позиция начинается с 0.

length
number

Длина извлекаемой подстроки.

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

Примеры

async function main(context: Excel.RequestContext) {
    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(propertyNames)

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

load(propertyNames?: string | string[]): void;

Параметры

propertyNames
string | string[]

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

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

void

setFormula(formula)

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

setFormula(formula: string): void;

Параметры

formula
string

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

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

void