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


Excel.ChartTitle class

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

Extends

Комментарии

[ Набор API: ExcelApi 1.1 ]

Свойства

context

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

format

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

height

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

horizontalAlignment

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

left

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

overlay

Указывает, будет ли заголовок диаграммы перекрывать диаграмму.

position

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

showShadow

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

text

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

textOrientation

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

top

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

verticalAlignment

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

visible

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

width

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

Методы

getSubstring(start, length)

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

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.ChartTitle объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ChartTitleData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

context

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

context: RequestContext;

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

format

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

readonly format: Excel.ChartTitleFormat;

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

height

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

readonly height: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.7 ]

horizontalAlignment

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

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

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

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

Комментарии

[ Набор API: ExcelApi 1.7 ]

left

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

left: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.7 ]

overlay

Указывает, будет ли заголовок диаграммы перекрывать диаграмму.

overlay: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

position

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

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

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

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

Комментарии

[ Набор API: ExcelApi 1.7 ]

showShadow

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

showShadow: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

text

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

text: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.1 ]

textOrientation

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

textOrientation: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.7 ]

Примеры

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

Комментарии

[ Набор API: ExcelApi 1.7 ]

verticalAlignment

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

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

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

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

Комментарии

[ Набор API: ExcelApi 1.7 ]

visible

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

visible: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

width

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

readonly width: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.7 ]

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

getSubstring(start, length)

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

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

Параметры

start

number

Начальная позиция извлекаемой подстроки. Используется нулевой индекс.

length

number

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

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

Комментарии

[ Набор API: ExcelApi 1.7 ]

Примеры

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

Параметры

options
Excel.Interfaces.ChartTitleLoadOptions

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

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

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

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

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

void

set(properties)

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

set(properties: Excel.ChartTitle): void;

Параметры

properties
Excel.ChartTitle

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

void

setFormula(formula)

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

setFormula(formula: string): void;

Параметры

formula

string

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

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

void

Комментарии

[ Набор API: ExcelApi 1.7 ]

toJSON()

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

toJSON(): Excel.Interfaces.ChartTitleData;

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