Excel.ChartLegend class
Представляет легенду в диаграмме.
- Extends
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| format | Представляет форматирование легенды диаграммы, включая заливку и шрифт. |
| height | Указывает высоту легенды на диаграмме (в пунктах). Значение, |
| left | Значение условных обозначений слева (в пунктах) на диаграмме. Значение, |
| legend |
Представляет коллекцию объектов legendEntries в условных обозначениях. |
| overlay | Указывает, должна ли легенда диаграммы перекрываться с основной частью диаграммы. |
| position | Определяет положение легенды на диаграмме. См. |
| show |
Указывает, есть ли в легенде тень на диаграмме. |
| top | Указывает верхнюю часть легенды диаграммы. |
| visible | Указывает, отображается ли легенда диаграммы. |
| width | Ширина легенды на диаграмме (в пунктах). Значение, |
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
format
Представляет форматирование легенды диаграммы, включая заливку и шрифт.
readonly format: Excel.ChartLegendFormat;Значение свойства
Комментарии
height
Указывает высоту легенды на диаграмме (в пунктах). Значение, null если легенда не отображается.
height: number;Значение свойства
number
Комментарии
left
Значение условных обозначений слева (в пунктах) на диаграмме. Значение, null если легенда не отображается.
left: number;Значение свойства
number
Комментарии
legendEntries
Представляет коллекцию объектов legendEntries в условных обозначениях.
readonly legendEntries: Excel.ChartLegendEntryCollection;Значение свойства
Комментарии
overlay
Указывает, должна ли легенда диаграммы перекрываться с основной частью диаграммы.
overlay: boolean;Значение свойства
boolean
Комментарии
position
Определяет положение легенды на диаграмме. См. Excel.ChartLegendPosition дополнительные сведения.
position: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom";Значение свойства
Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom"
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-title-format.yaml
function createChart(context: Excel.RequestContext) {
let sheet = context.workbook.worksheets.getItem("Sample");
let dataRange = sheet.getRange("A3:E7");
let chart = sheet.charts.add("ColumnStacked", dataRange, "Auto");
chart.title.text = "Bicycle Parts Sales";
chart.setPosition("A10", "H33");
chart.legend.position = "Right";
chart.legend.format.fill.setSolidColor("white");
chart.dataLabels.format.font.size = 15;
chart.dataLabels.format.font.color = "black";
}
showShadow
Указывает, есть ли в легенде тень на диаграмме.
showShadow: boolean;Значение свойства
boolean
Комментарии
top
Указывает верхнюю часть легенды диаграммы.
top: number;Значение свойства
number
Комментарии
visible
Указывает, отображается ли легенда диаграммы.
visible: boolean;Значение свойства
boolean
Комментарии
Примеры
// 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();
});
width
Ширина легенды на диаграмме (в пунктах). Значение, null если легенда не отображается.
width: number;Значение свойства
number
Комментарии
Сведения о методе
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.ChartLegendLoadOptions): Excel.ChartLegend;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.ChartLegend;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
Примеры
// 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)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartLegend;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.ChartLegendUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.ChartLegendUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
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;