Excel.ChartPoint class

Представляет точку из ряда в диаграмме.

// 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.
dataLabel	Возвращает метку данных точки диаграммы.
format	Инкапсулирует свойства формата точки диаграммы.
hasDataLabel	Указывает, имеется ли у точки данных метка данных. Неприменимо для поверхностных диаграмм.
markerBackgroundColor	Цветовой код HTML представляет цвет фона маркера точки данных (например, #FF0000 представляет красный).
markerForegroundColor	Цветовое представление маркера точки данных с помощью цветового кода в формате HTML (например, #FF0000 представляет красный цвет).
markerSize	Представляет размер маркера точки данных. Поддерживаемый диапазон размеров — от 2 до 72. Этот метод возвращает ошибку InvalidArgument, если его размер задан за пределами поддерживаемого диапазона.
markerStyle	Представляет стиль маркера точки данных диаграммы. См. `Excel.ChartMarkerStyle` дополнительные сведения.
value	Возвращает значение точки диаграммы.

Методы

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

context

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

context: RequestContext;

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

Excel.RequestContext

dataLabel

Возвращает метку данных точки диаграммы.

readonly dataLabel: Excel.ChartDataLabel;

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

Excel.ChartDataLabel

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-leader-lines.yaml

// The following code adds data labels to the chart and positions them to demonstrate leader lines.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem(sheetName);
  const chart = sheet.charts.getItemAt(0);
  const series = chart.series.getItemAt(0);
  
  // Enable data labels for the series. Leader lines are enabled by default.
  series.hasDataLabels = true;
  series.points.load("items");
  await context.sync();
  
  // Load the top position for each data label.
  series.points.items.forEach((point) => point.dataLabel.load("top"));
  await context.sync();

  // Move some data labels to create distance from their chart points.
  const point1 = series.points.items[1]; 
  const point2 = series.points.items[2]; 
  point1.dataLabel.top -= 50; 
  point2.dataLabel.top += 50;
  
  // Format the data labels.
  series.dataLabels.geometricShapeType = Excel.GeometricShapeType.rectangle;
  series.dataLabels.showCategoryName = true;
  series.dataLabels.format.border.weight = 1;
  
  await context.sync();
});

format

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

readonly format: Excel.ChartPointFormat;

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

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";

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

value

Возвращает значение точки диаграммы.

readonly value: any;

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

any

load(options)

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

load(options?: Excel.Interfaces.ChartPointLoadOptions): Excel.ChartPoint;

Параметры

options: Excel.Interfaces.ChartPointLoadOptions

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

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

Excel.ChartPoint

load(propertyNames)

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

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

Параметры

propertyNames: string | string[]

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

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

Excel.ChartPoint

load(propertyNamesAndPaths)

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

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

Параметры

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

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

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

Excel.ChartPoint

set(properties, options)

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

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

Параметры

properties: Excel.Interfaces.ChartPointUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

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;

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

Excel.Interfaces.ChartPointData

Комментарии

Используется

Примеры

Свойства

Методы

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

context

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

dataLabel

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

Комментарии

Примеры

format

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

Комментарии

hasDataLabel

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

Комментарии

markerBackgroundColor

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

Комментарии

markerForegroundColor

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

Комментарии

markerSize

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

Комментарии

markerStyle

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

Комментарии

value

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

Комментарии

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

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

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