Excel.ChartPoint class
Представляет точку из ряда в диаграмме.
- Extends
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-labels.yaml
// This function adds data labels to specific chart points
// and sets their text and position.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem(sheetName);
const chart = sheet.charts.getItemAt(0);
await context.sync();
const series = chart.series.getItemAt(0);
series.points.load("dataLabel");
await context.sync();
// Define properties for data label positioning and shape.
const labelProperties = [
{
top: 70,
geometricShapeType: Excel.GeometricShapeType.rectangle
},
{
top: 200,
geometricShapeType: Excel.GeometricShapeType.rectangle
}
];
// Add data labels to specific chart points and set their text and properties.
for (let i = 0; i < dataLabelInfo.length; i++) {
const point = series.points.getItemAt(dataLabelInfo[i].index);
point.hasDataLabel = true;
const dataLabel = point.dataLabel;
dataLabel.text = dataLabelInfo[i].news;
dataLabel.set(labelProperties[i]);
}
await context.sync();
});
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| data |
Возвращает метку данных точки диаграммы. |
| format | Инкапсулирует свойства формата точки диаграммы. |
| has |
Указывает, имеет ли точка данных метку данных. Неприменимо для поверхностных диаграмм. |
| marker |
Html-код цветов представляет цвет фона маркера точки данных (например, #FF0000 представляет красный цвет). |
| marker |
Html-код цветового кода представляет цвет переднего плана маркера точки данных (например, #FF0000 представляет красный цвет). |
| marker |
Представляет размер маркера точки данных. Поддерживаемый диапазон размеров — от 2 до 72. Этот метод возвращает ошибку InvalidArgument, если задан размер за пределами поддерживаемого диапазона. |
| marker |
Представляет стиль маркера точки данных диаграммы. Дополнительные сведения см. в этой |
| value | Возвращает значение точки диаграммы. |
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
dataLabel
Возвращает метку данных точки диаграммы.
readonly dataLabel: Excel.ChartDataLabel;Значение свойства
Комментарии
format
Инкапсулирует свойства формата точки диаграммы.
readonly format: Excel.ChartPointFormat;Значение свойства
Комментарии
hasDataLabel
Указывает, имеет ли точка данных метку данных. Неприменимо для поверхностных диаграмм.
hasDataLabel: boolean;Значение свойства
boolean
Комментарии
markerBackgroundColor
Html-код цветов представляет цвет фона маркера точки данных (например, #FF0000 представляет красный цвет).
markerBackgroundColor: string;Значение свойства
string
Комментарии
markerForegroundColor
Html-код цветового кода представляет цвет переднего плана маркера точки данных (например, #FF0000 представляет красный цвет).
markerForegroundColor: string;Значение свойства
string
Комментарии
markerSize
Представляет размер маркера точки данных. Поддерживаемый диапазон размеров — от 2 до 72. Этот метод возвращает ошибку InvalidArgument, если задан размер за пределами поддерживаемого диапазона.
markerSize: number;Значение свойства
number
Комментарии
markerStyle
Представляет стиль маркера точки данных диаграммы. Дополнительные сведения см. в этой Excel.ChartMarkerStyle статье.
markerStyle: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture";Значение свойства
Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"
Комментарии
value
Возвращает значение точки диаграммы.
readonly value: any;Значение свойства
any
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.ChartPointLoadOptions): Excel.ChartPoint;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.ChartPoint;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartPoint;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.ChartPointUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.ChartPointUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Excel.ChartPoint): void;Параметры
- properties
- Excel.ChartPoint
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ChartPoint объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ChartPointData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Excel.Interfaces.ChartPointData;