Excel.ChartFont class

Пакет:

excel

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

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: ExcelApi 1.1

Используется

• Excel.ChartAreaFormat: шрифт
• Excel.ChartAxisFormat: шрифт
• Excel.ChartAxisTitleFormat: шрифт
• Excel.ChartDataLabelFormat: шрифт
• Excel.ChartDataTableFormat: шрифт
• Excel.ChartFormatString: шрифт
• Excel.ChartLegendFormat: шрифт
• Excel.ChartTitleFormat: шрифт
• Excel.ChartTrendlineLabelFormat: шрифт

Примеры

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-legend.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    let chart = sheet.charts.getItemAt(0);
    chart.legend.visible = true;

    // Format the legend font.
    const font: Excel.ChartFont = chart.legend.format.font;
    font.bold = true;
    font.color = "red";
    font.italic = true;
    font.size = 15;
    font.name = "Calibri";
    font.underline = "Single";

    await context.sync();
});

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

Примеры

// 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.format.font.size = 16;
    title.showShadow = true;

    await context.sync();
});

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

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

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

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