Excel.ChartFill class

Пакет:
excel

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

Extends
OfficeExtension.ClientObject

Комментарии

Набор API: ExcelApi 1.1

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

Свойства

context

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

Методы

clear()

Снимает цвет заливки элемента диаграммы.
getSolidColor()

Получение равномерного форматирования заливки цвета элемента диаграммы.
setSolidColor(color)

Устанавливает форматирование заливки элемента диаграммы на единый цвет.
toJSON()

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

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

clear()

Снимает цвет заливки элемента диаграммы.

clear(): void;

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

void

Комментарии

Набор API: ExcelApi 1.1

Примеры

// Clear the line format of the major gridlines on the value axis of the chart named "Chart1".
await Excel.run(async (context) => { 
    const gridlines = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines;
    gridlines.format.line.clear();
    await context.sync();
    
    console.log("Chart Major Gridlines Format Cleared");
});

getSolidColor()

Получение равномерного форматирования заливки цвета элемента диаграммы.

getSolidColor(): OfficeExtension.ClientResult<string>;

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

OfficeExtension.ClientResult<string>

Комментарии

Набор API: ExcelApi 1.16

Примеры

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

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

    let pointsCollection = sheet.charts.getItemAt(0).series.getItemAt(0).points;
    let point = pointsCollection.getItemAt(2);

    // Get the solid color of the chart point.
    const colorResult = point.format.fill.getSolidColor();

    await context.sync();

    console.log(`Chart point color: ${colorResult.value}`);
});

setSolidColor(color)

Устанавливает форматирование заливки элемента диаграммы на единый цвет.

setSolidColor(color: string): void;

Параметры

color

string

Цветовой код HTML, представляющий цвет фона, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").

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

void

Комментарии

Набор API: ExcelApi 1.1

Примеры

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

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

    let pointsCollection = sheet.charts.getItemAt(0).series.getItemAt(0).points;
    let point = pointsCollection.getItemAt(2);

    // Set color for chart point.
    point.format.fill.setSolidColor('red');

    await context.sync();
});

toJSON()

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

toJSON(): {
            [key: string]: string;
        };

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

{ [key: string]: string; }