Excel.ChartAreaFormat class

Ссылка

Пакет:: excel

Инкапсулирует свойства формата для всей области диаграммы.

Extends: OfficeExtension.ClientObject

Свойства

border	Представляет формат границы области диаграммы, включающую цвет, стиль линий и вес.
colorScheme	Задает цветовую схему диаграммы.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
fill	Представляет формат заливки объекта, включая сведения о форматировании фона.
font	Представляет атрибуты шрифта (имя шрифта, размер шрифта, цвет и т. д.) для текущего объекта.
roundedCorners	Указывает, имеет ли область диаграммы скругленные углы.

Методы

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

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

border

Представляет формат границы области диаграммы, включающую цвет, стиль линий и вес.

readonly border: Excel.ChartBorder;

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

Excel.ChartBorder

colorScheme

Задает цветовую схему диаграммы.

colorScheme: Excel.ChartColorScheme | "ColorfulPalette1" | "ColorfulPalette2" | "ColorfulPalette3" | "ColorfulPalette4" | "MonochromaticPalette1" | "MonochromaticPalette2" | "MonochromaticPalette3" | "MonochromaticPalette4" | "MonochromaticPalette5" | "MonochromaticPalette6" | "MonochromaticPalette7" | "MonochromaticPalette8" | "MonochromaticPalette9" | "MonochromaticPalette10" | "MonochromaticPalette11" | "MonochromaticPalette12" | "MonochromaticPalette13";

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

context

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

context: RequestContext;

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

Excel.RequestContext

fill

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

readonly fill: Excel.ChartFill;

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

Excel.ChartFill

font

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

readonly font: Excel.ChartFont;

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

Excel.ChartFont

roundedCorners

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

roundedCorners: boolean;

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

boolean

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

load(options)

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

load(options?: Excel.Interfaces.ChartAreaFormatLoadOptions): Excel.ChartAreaFormat;

Параметры

options: Excel.Interfaces.ChartAreaFormatLoadOptions

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

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

Excel.ChartAreaFormat

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.ChartAreaFormat

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Excel.ChartAreaFormat

set(properties, options)

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

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

Параметры

properties: Excel.Interfaces.ChartAreaFormatUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.ChartAreaFormat): void;

Параметры

properties: Excel.ChartAreaFormat

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

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartAreaFormatData;

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

Excel.Interfaces.ChartAreaFormatData

Excel.ChartAreaFormat class

Комментарии

Свойства

Методы

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

border

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

Комментарии

colorScheme

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

Комментарии

context

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

fill

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

Комментарии

font

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

Комментарии

roundedCorners

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

Комментарии

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

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

Обратная связь

Дополнительные ресурсы