Excel.ChartDataLabels class
Представляет коллекцию всех меток данных в точке диаграммы.
- Extends
Комментарии
Свойства
| auto |
Указывает, будут ли метки данных автоматически создавать соответствующий текст на основе контекста. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| format | Задает формат меток данных диаграммы, включая форматирование заливки и шрифта. |
| horizontal |
Задает горизонтальное выравнивание метки данных диаграммы. Дополнительные сведения см. в этой |
| link |
Указывает, связан ли числовой формат с ячейками. Если |
| number |
Задает код формата для меток данных. |
| position | Значение, представляющее положение метки данных. Дополнительные сведения см. в этой |
| separator | Строка, представляющая разделитель, который используется для меток данных на диаграмме. |
| show |
Указывает, отображается ли размер пузырька метки данных. |
| show |
Указывает, отображается ли имя категории метки данных. |
| show |
Указывает, отображается ли ключ условных обозначений метки данных. |
| show |
Указывает, отображается ли процент метки данных. |
| show |
Указывает, отображается ли имя ряда меток данных. |
| show |
Указывает, отображается ли значение метки данных. |
| text |
Представляет угол, на который текст ориентирован для меток данных. Значение должно быть целым числом от -90 до 90 или целым числом 180 для вертикально ориентированного текста. |
| vertical |
Представляет вертикальное выравнивание для метки данных диаграммы. Дополнительные сведения см. в этой |
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
autoText
Указывает, будут ли метки данных автоматически создавать соответствующий текст на основе контекста.
autoText: boolean;Значение свойства
boolean
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
format
Задает формат меток данных диаграммы, включая форматирование заливки и шрифта.
readonly format: Excel.ChartDataLabelFormat;Значение свойства
Комментарии
horizontalAlignment
Задает горизонтальное выравнивание метки данных диаграммы. Дополнительные сведения см. в этой Excel.ChartTextHorizontalAlignment статье. Это свойство допустимо, только если TextOrientation метка данных имеет значение 0.
horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";Значение свойства
Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"
Комментарии
linkNumberFormat
Указывает, связан ли числовой формат с ячейками. Если trueзадано значение , числовой формат изменится в метках при изменении в ячейках.
linkNumberFormat: boolean;Значение свойства
boolean
Комментарии
numberFormat
Задает код формата для меток данных.
numberFormat: string;Значение свойства
string
Комментарии
position
Значение, представляющее положение метки данных. Дополнительные сведения см. в этой Excel.ChartDataLabelPosition статье.
position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout";Значение свойства
Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"
Комментарии
separator
Строка, представляющая разделитель, который используется для меток данных на диаграмме.
separator: string;Значение свойства
string
Комментарии
showBubbleSize
Указывает, отображается ли размер пузырька метки данных.
showBubbleSize: boolean;Значение свойства
boolean
Комментарии
showCategoryName
Указывает, отображается ли имя категории метки данных.
showCategoryName: boolean;Значение свойства
boolean
Комментарии
showLegendKey
Указывает, отображается ли ключ условных обозначений метки данных.
showLegendKey: boolean;Значение свойства
boolean
Комментарии
showPercentage
Указывает, отображается ли процент метки данных.
showPercentage: boolean;Значение свойства
boolean
Комментарии
showSeriesName
Указывает, отображается ли имя ряда меток данных.
showSeriesName: boolean;Значение свойства
boolean
Комментарии
showValue
Указывает, отображается ли значение метки данных.
showValue: boolean;Значение свойства
boolean
Комментарии
textOrientation
Представляет угол, на который текст ориентирован для меток данных. Значение должно быть целым числом от -90 до 90 или целым числом 180 для вертикально ориентированного текста.
textOrientation: number;Значение свойства
number
Комментарии
verticalAlignment
Представляет вертикальное выравнивание для метки данных диаграммы. Дополнительные сведения см. в этой Excel.ChartTextVerticalAlignment статье. Это свойство допустимо, только если TextOrientation метка данных имеет значение -90, 90 или 180.
verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";Значение свойства
Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"
Комментарии
Сведения о методе
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.ChartDataLabelsLoadOptions): Excel.ChartDataLabels;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.ChartDataLabels;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
Примеры
// Show the series name in data labels and set the position of the data labels to "top".
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.dataLabels.showValue = true;
chart.dataLabels.position = Excel.ChartDataLabelPosition.top;
chart.dataLabels.showSeriesName = true;
await context.sync();
console.log("Data labels shown");
});
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartDataLabels;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.ChartDataLabelsUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.ChartDataLabelsUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Excel.ChartDataLabels): void;Параметры
- properties
- Excel.ChartDataLabels
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ChartDataLabels объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ChartDataLabelsData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Excel.Interfaces.ChartDataLabelsData;Возвращаемое значение
Office Add-ins