Excel.ChartFont class

Пакет:

excel

Этот объект представляет атрибуты шрифта (например, имя шрифта, размер шрифта и цвет) для объекта диаграммы.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

// Set the chart title font to Calibri, size 10, bold, and the color red.
await Excel.run(async (context) => { 
    const title = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").title;
    title.format.font.name = "Calibri";
    title.format.font.size = 12;
    title.format.font.color = "#FF0000";
    title.format.font.italic =  false;
    title.format.font.bold = true;
    title.format.font.underline = "None";
    await context.sync();
});

Свойства

bold	Указывает, является ли шрифт полужирным.
color	Представление цветового кода HTML для цвета текста (например, #FF0000 представляет красный цвет).
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
italic	Указывает, применяется ли курсив.
name	Имя шрифта (например, "Calibri")
size	Размер шрифта (например, 11)
underline	Тип подчеркивания, применяемый для шрифта. Дополнительные сведения см. в этой Excel.ChartUnderlineStyle статье.

Методы

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

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

bold

Указывает, является ли шрифт полужирным.

bold: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

color

Представление цветового кода HTML для цвета текста (например, #FF0000 представляет красный цвет).

color: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.1 ]

context

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

context: RequestContext;

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

Excel.RequestContext

italic

Указывает, применяется ли курсив.

italic: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

name

Имя шрифта (например, "Calibri")

name: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.1 ]

size

Размер шрифта (например, 11)

size: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.1 ]

underline

Тип подчеркивания, применяемый для шрифта. Дополнительные сведения см. в этой Excel.ChartUnderlineStyle статье.

underline: Excel.ChartUnderlineStyle | "None" | "Single";

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

Excel.ChartUnderlineStyle | "None" | "Single"

Комментарии

[ Набор API: ExcelApi 1.1 ]

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

load(options)

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

load(options?: Excel.Interfaces.ChartFontLoadOptions): Excel.ChartFont;

Параметры

options

Excel.Interfaces.ChartFontLoadOptions

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

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

Excel.ChartFont

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.ChartFont

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.ChartFont

set(properties, options)

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

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

Параметры

properties

Excel.Interfaces.ChartFontUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.ChartFont): void;

Параметры

properties

Excel.ChartFont

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

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartFontData;

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

Excel.Interfaces.ChartFontData