Excel.ChartLegend class

Ссылка

Пакет:: excel

Представляет легенду в диаграмме.

Extends: OfficeExtension.ClientObject

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
format	Представляет форматирование легенды диаграммы, включая заливку и шрифт.
height	Указывает высоту (в точках) условных обозначений на диаграмме. Значение равно, `null` если легенда не видна.
left	Указывает левое значение (в пунктах) условных обозначений на диаграмме. Значение равно, `null` если легенда не видна.
legendEntries	Представляет коллекцию объектов legendEntries в условных обозначениях.
overlay	Указывает, должно ли условные обозначения диаграммы перекрываться с основным текстом диаграммы.
position	Указывает положение условных обозначений на диаграмме. Дополнительные сведения см. в этой `Excel.ChartLegendPosition` статье.
showShadow	Указывает, имеет ли условный обозначения тень на диаграмме.
top	Указывает верхнюю часть условных обозначений диаграммы.
visible	Указывает, отображается ли условный обозначения диаграммы.
width	Задает ширину (в точках) условных обозначений на диаграмме. Значение равно, `null` если легенда не видна.

Методы

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

format

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

readonly format: Excel.ChartLegendFormat;

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

Excel.ChartLegendFormat

height

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

height: number;

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

number

left

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

left: number;

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

number

legendEntries

Представляет коллекцию объектов legendEntries в условных обозначениях.

readonly legendEntries: Excel.ChartLegendEntryCollection;

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

Excel.ChartLegendEntryCollection

overlay

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

overlay: boolean;

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

boolean

position

Указывает положение условных обозначений на диаграмме. Дополнительные сведения см. в этой Excel.ChartLegendPosition статье.

position: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom";

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

showShadow

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

showShadow: boolean;

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

boolean

top

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

top: number;

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

number

visible

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

visible: boolean;

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

boolean

width

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

width: number;

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

number

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

load(options)

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

load(options?: Excel.Interfaces.ChartLegendLoadOptions): Excel.ChartLegend;

Параметры

options: Excel.Interfaces.ChartLegendLoadOptions

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

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

Excel.ChartLegend

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.ChartLegend

Примеры

// Get the position of Chart Legend from Chart1.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    const legend = chart.legend;
    legend.load('position');
    await context.sync();

    console.log(legend.position);
});

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Excel.ChartLegend

set(properties, options)

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

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

Параметры

properties: Excel.Interfaces.ChartLegendUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.ChartLegend): void;

Параметры

properties: Excel.ChartLegend

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

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartLegendData;

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

Excel.Interfaces.ChartLegendData

Excel.ChartLegend class

Комментарии

Свойства

Методы

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

context

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

format

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

Комментарии

height

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

Комментарии

left

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

Комментарии

legendEntries

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

Комментарии

overlay

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

Комментарии

position

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

Комментарии

showShadow

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

Комментарии

top

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

Комментарии

visible

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

Комментарии

width

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

Комментарии

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

load(options)

Параметры

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

load(propertyNames)

Параметры

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

Примеры

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

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

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