Excel.ChartSeries class
Представляет ряд в диаграмме.
- Extends
Комментарии
Свойства
axis |
Указывает группу для указанного ряда. |
bin |
Объединяет параметры интервалов для гистограмм и диаграмм Парето. |
boxwhisker |
Объединяет параметры для диаграмм "ящик с усами" |
bubble |
Может быть целым числом от 0 (нуля) до 300, представляющим процентное значение от размера по умолчанию. Это свойство применяется только к пузырьковым диаграммам. |
chart |
Представляет тип диаграммы для ряда. Дополнительные сведения см. в этой |
context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
data |
Представляет коллекцию всех меток данных в ряде. |
doughnut |
Представляет размер отверстия ряда кольцевой диаграммы. Действителен только для диаграмм с кольцевой и кольцевой диаграммами. Выдает ошибку |
explosion | Задает значение взрыва для круговой диаграммы или среза кольцевой диаграммы. Возвращает нуль (0) при отсутствии развертывания (верхушка сектора — в центре круговой диаграммы). |
filtered | Указывает, фильтруется ли ряд. Неприменимо для поверхностных диаграмм. |
first |
Задает угол первого среза круговой диаграммы или кольцевой диаграммы в градусах (по часовой стрелке по вертикали). Применяется только к круговым, объемным круговым и кольцевым диаграммам. Может находиться в диапазоне от 0 до 360. |
format | Представляет форматирование ряда диаграммы, включая формат заливки и линий. |
gap |
Представляет ширину разрывов рядов диаграммы. Допустимо только для линейчатых и столбцовых диаграмм, а также для определенных классов линейных и круговых диаграмм. Создает исключение недопустимого аргумента на недопустимых диаграммах. |
gradient |
Задает цвет для максимального значения ряда диаграммы карты регионов. |
gradient |
Задает тип максимального значения ряда диаграммы карты регионов. |
gradient |
Задает максимальное значение ряда диаграммы карты регионов. |
gradient |
Задает цвет для среднего значения ряда диаграмм карты регионов. |
gradient |
Задает тип для среднего значения ряда диаграммы карты регионов. |
gradient |
Задает значение в середине ряда диаграммы карты регионов. |
gradient |
Задает цвет для минимального значения ряда диаграммы карты регионов. |
gradient |
Указывает тип минимального значения ряда диаграмм карты региона. |
gradient |
Задает минимальное значение ряда диаграммы карты регионов. |
gradient |
Задает стиль градиента ряда диаграммы карты регионов. |
has |
Указывает, имеет ли ряд метки данных. |
invert |
Задает цвет заливки для отрицательных точек данных в ряде. |
invert |
Значение true, если Excel инвертирует шаблон в элементе, если он соответствует отрицательному числу. |
map |
Объединяет параметры для диаграммы с картой региона. |
marker |
Задает цвет фона маркера ряда диаграммы. |
marker |
Задает цвет маркера переднего плана ряда диаграммы. |
marker |
Задает размер маркера ряда диаграммы. Поддерживаемый диапазон размеров — от 2 до 72. Этот метод возвращает ошибку InvalidArgument, если задан размер за пределами поддерживаемого диапазона. |
marker |
Задает стиль маркера ряда диаграммы. Дополнительные сведения см. в этой |
name | Указывает имя ряда на диаграмме. Длина имени не должна превышать 255 символов. |
overlap | Указывает на расположение строк и столбцов. Может находиться в диапазоне от -100 до 100. Применяется только к двумерным диаграммам и гистограммам. |
parent |
Задает область стратегии родительской метки ряда для диаграммы дерева. |
plot |
Задает порядок построения ряда диаграммы в группе диаграмм. |
points | Возвращает коллекцию всех точек ряда. |
second |
Задает размер вторичного раздела круговой диаграммы или линейчатой круговой диаграммы в процентах от размера основного кругового круга. Может находиться в диапазоне от 5 до 200. |
show |
Указывает, отображаются ли линии соединителя в каскадных диаграммах. |
show |
Указывает, отображаются ли линии-лидеры для каждой метки данных в ряде. |
show |
Указывает, имеет ли ряд тень. |
smooth | Указывает, является ли ряд гладким. Применимо только к линейным диаграммам и точечным диаграммам. |
split |
Указывает способ разделения двух разделов круговой диаграммы или линейчатой диаграммы. |
split |
Задает пороговое значение, разделяющее две части круговой диаграммы или линейчатой диаграммы. |
trendlines | Коллекция линий тренда в серии. |
vary |
Значение true, если Excel присваивает каждому маркеру данных другой цвет или узор. Диаграмма должна содержать только один ряд. |
x |
Представляет объект планки погрешностей для ряда диаграммы. |
y |
Представляет объект планки погрешностей для ряда диаграммы. |
Методы
delete() | Удаляет ряд диаграммы. |
load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
set |
Задает размеры пузырьков для ряда диаграмм. Применяется только для пузырьковых диаграмм. |
set |
Задает значения для ряда диаграммы. Для точечной диаграммы она относится к значениям оси Y. |
set |
Задает значения оси X для ряда диаграммы. |
toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
axisGroup
Указывает группу для указанного ряда.
axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary";
Значение свойства
Excel.ChartAxisGroup | "Primary" | "Secondary"
Комментарии
binOptions
Объединяет параметры интервалов для гистограмм и диаграмм Парето.
readonly binOptions: Excel.ChartBinOptions;
Значение свойства
Комментарии
boxwhiskerOptions
Объединяет параметры для диаграмм "ящик с усами"
readonly boxwhiskerOptions: Excel.ChartBoxwhiskerOptions;
Значение свойства
Комментарии
bubbleScale
Может быть целым числом от 0 (нуля) до 300, представляющим процентное значение от размера по умолчанию. Это свойство применяется только к пузырьковым диаграммам.
bubbleScale: number;
Значение свойства
number
Комментарии
chartType
Представляет тип диаграммы для ряда. Дополнительные сведения см. в этой Excel.ChartType
статье.
chartType: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel";
Значение свойства
Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel"
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;
Значение свойства
dataLabels
Представляет коллекцию всех меток данных в ряде.
readonly dataLabels: Excel.ChartDataLabels;
Значение свойства
Комментарии
doughnutHoleSize
Представляет размер отверстия ряда кольцевой диаграммы. Действителен только для диаграмм с кольцевой и кольцевой диаграммами. Выдает ошибку InvalidArgument
на недопустимых диаграммах.
doughnutHoleSize: number;
Значение свойства
number
Комментарии
explosion
Задает значение взрыва для круговой диаграммы или среза кольцевой диаграммы. Возвращает нуль (0) при отсутствии развертывания (верхушка сектора — в центре круговой диаграммы).
explosion: number;
Значение свойства
number
Комментарии
filtered
Указывает, фильтруется ли ряд. Неприменимо для поверхностных диаграмм.
filtered: boolean;
Значение свойства
boolean
Комментарии
firstSliceAngle
Задает угол первого среза круговой диаграммы или кольцевой диаграммы в градусах (по часовой стрелке по вертикали). Применяется только к круговым, объемным круговым и кольцевым диаграммам. Может находиться в диапазоне от 0 до 360.
firstSliceAngle: number;
Значение свойства
number
Комментарии
format
Представляет форматирование ряда диаграммы, включая формат заливки и линий.
readonly format: Excel.ChartSeriesFormat;
Значение свойства
Комментарии
gapWidth
Представляет ширину разрывов рядов диаграммы. Допустимо только для линейчатых и столбцовых диаграмм, а также для определенных классов линейных и круговых диаграмм. Создает исключение недопустимого аргумента на недопустимых диаграммах.
gapWidth: number;
Значение свойства
number
Комментарии
gradientMaximumColor
Задает цвет для максимального значения ряда диаграммы карты регионов.
gradientMaximumColor: string;
Значение свойства
string
Комментарии
gradientMaximumType
Задает тип максимального значения ряда диаграммы карты регионов.
gradientMaximumType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";
Значение свойства
Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"
Комментарии
gradientMaximumValue
Задает максимальное значение ряда диаграммы карты регионов.
gradientMaximumValue: number;
Значение свойства
number
Комментарии
gradientMidpointColor
Задает цвет для среднего значения ряда диаграмм карты регионов.
gradientMidpointColor: string;
Значение свойства
string
Комментарии
gradientMidpointType
Задает тип для среднего значения ряда диаграммы карты регионов.
gradientMidpointType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";
Значение свойства
Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"
Комментарии
gradientMidpointValue
Задает значение в середине ряда диаграммы карты регионов.
gradientMidpointValue: number;
Значение свойства
number
Комментарии
gradientMinimumColor
Задает цвет для минимального значения ряда диаграммы карты регионов.
gradientMinimumColor: string;
Значение свойства
string
Комментарии
gradientMinimumType
Указывает тип минимального значения ряда диаграмм карты региона.
gradientMinimumType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";
Значение свойства
Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"
Комментарии
gradientMinimumValue
Задает минимальное значение ряда диаграммы карты регионов.
gradientMinimumValue: number;
Значение свойства
number
Комментарии
gradientStyle
Задает стиль градиента ряда диаграммы карты регионов.
gradientStyle: Excel.ChartGradientStyle | "TwoPhaseColor" | "ThreePhaseColor";
Значение свойства
Excel.ChartGradientStyle | "TwoPhaseColor" | "ThreePhaseColor"
Комментарии
hasDataLabels
Указывает, имеет ли ряд метки данных.
hasDataLabels: boolean;
Значение свойства
boolean
Комментарии
invertColor
Задает цвет заливки для отрицательных точек данных в ряде.
invertColor: string;
Значение свойства
string
Комментарии
invertIfNegative
Значение true, если Excel инвертирует шаблон в элементе, если он соответствует отрицательному числу.
invertIfNegative: boolean;
Значение свойства
boolean
Комментарии
mapOptions
Объединяет параметры для диаграммы с картой региона.
readonly mapOptions: Excel.ChartMapOptions;
Значение свойства
Комментарии
markerBackgroundColor
Задает цвет фона маркера ряда диаграммы.
markerBackgroundColor: string;
Значение свойства
string
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml
await Excel.run(async (context) => {
let sheet = context.workbook.worksheets.getItem("Sample");
let salesTable = sheet.tables.getItem("SalesTable");
let dataRange = sheet.getRange("A1:E7");
// Create an XY scatter chart.
let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
chart.title.text = "Bicycle Parts Quarterly Sales";
let series = chart.series;
let series0 = series.getItemAt(0);
let series1 = series.getItemAt(1);
let series2 = series.getItemAt(2);
let series3 = series.getItemAt(3);
// Set markers.
series0.markerStyle = "Dash";
series0.markerForegroundColor = "black";
series1.markerStyle = "Star";
series1.markerForegroundColor = "black";
series2.markerStyle = "X";
series2.markerSize = 12;
series3.markerStyle = "Triangle";
series3.markerBackgroundColor = "purple";
await context.sync();
});
markerForegroundColor
Задает цвет маркера переднего плана ряда диаграммы.
markerForegroundColor: string;
Значение свойства
string
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml
await Excel.run(async (context) => {
let sheet = context.workbook.worksheets.getItem("Sample");
let salesTable = sheet.tables.getItem("SalesTable");
let dataRange = sheet.getRange("A1:E7");
// Create an XY scatter chart.
let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
chart.title.text = "Bicycle Parts Quarterly Sales";
let series = chart.series;
let series0 = series.getItemAt(0);
let series1 = series.getItemAt(1);
let series2 = series.getItemAt(2);
let series3 = series.getItemAt(3);
// Set markers.
series0.markerStyle = "Dash";
series0.markerForegroundColor = "black";
series1.markerStyle = "Star";
series1.markerForegroundColor = "black";
series2.markerStyle = "X";
series2.markerSize = 12;
series3.markerStyle = "Triangle";
series3.markerBackgroundColor = "purple";
await context.sync();
});
markerSize
Задает размер маркера ряда диаграммы. Поддерживаемый диапазон размеров — от 2 до 72. Этот метод возвращает ошибку InvalidArgument, если задан размер за пределами поддерживаемого диапазона.
markerSize: number;
Значение свойства
number
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml
await Excel.run(async (context) => {
let sheet = context.workbook.worksheets.getItem("Sample");
let salesTable = sheet.tables.getItem("SalesTable");
let dataRange = sheet.getRange("A1:E7");
// Create an XY scatter chart.
let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
chart.title.text = "Bicycle Parts Quarterly Sales";
let series = chart.series;
let series0 = series.getItemAt(0);
let series1 = series.getItemAt(1);
let series2 = series.getItemAt(2);
let series3 = series.getItemAt(3);
// Set markers.
series0.markerStyle = "Dash";
series0.markerForegroundColor = "black";
series1.markerStyle = "Star";
series1.markerForegroundColor = "black";
series2.markerStyle = "X";
series2.markerSize = 12;
series3.markerStyle = "Triangle";
series3.markerBackgroundColor = "purple";
await context.sync();
});
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"
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml
await Excel.run(async (context) => {
let sheet = context.workbook.worksheets.getItem("Sample");
let salesTable = sheet.tables.getItem("SalesTable");
let dataRange = sheet.getRange("A1:E7");
// Create an XY scatter chart.
let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
chart.title.text = "Bicycle Parts Quarterly Sales";
let series = chart.series;
let series0 = series.getItemAt(0);
let series1 = series.getItemAt(1);
let series2 = series.getItemAt(2);
let series3 = series.getItemAt(3);
// Set markers.
series0.markerStyle = "Dash";
series0.markerForegroundColor = "black";
series1.markerStyle = "Star";
series1.markerForegroundColor = "black";
series2.markerStyle = "X";
series2.markerSize = 12;
series3.markerStyle = "Triangle";
series3.markerBackgroundColor = "purple";
await context.sync();
});
name
Указывает имя ряда на диаграмме. Длина имени не должна превышать 255 символов.
name: string;
Значение свойства
string
Комментарии
overlap
Указывает на расположение строк и столбцов. Может находиться в диапазоне от -100 до 100. Применяется только к двумерным диаграммам и гистограммам.
overlap: number;
Значение свойства
number
Комментарии
parentLabelStrategy
Задает область стратегии родительской метки ряда для диаграммы дерева.
parentLabelStrategy: Excel.ChartParentLabelStrategy | "None" | "Banner" | "Overlapping";
Значение свойства
Excel.ChartParentLabelStrategy | "None" | "Banner" | "Overlapping"
Комментарии
plotOrder
Задает порядок построения ряда диаграммы в группе диаграмм.
plotOrder: number;
Значение свойства
number
Комментарии
points
Возвращает коллекцию всех точек ряда.
readonly points: Excel.ChartPointsCollection;
Значение свойства
Комментарии
secondPlotSize
Задает размер вторичного раздела круговой диаграммы или линейчатой круговой диаграммы в процентах от размера основного кругового круга. Может находиться в диапазоне от 5 до 200.
secondPlotSize: number;
Значение свойства
number
Комментарии
showConnectorLines
Указывает, отображаются ли линии соединителя в каскадных диаграммах.
showConnectorLines: boolean;
Значение свойства
boolean
Комментарии
showLeaderLines
Указывает, отображаются ли линии-лидеры для каждой метки данных в ряде.
showLeaderLines: boolean;
Значение свойства
boolean
Комментарии
showShadow
Указывает, имеет ли ряд тень.
showShadow: boolean;
Значение свойства
boolean
Комментарии
smooth
Указывает, является ли ряд гладким. Применимо только к линейным диаграммам и точечным диаграммам.
smooth: boolean;
Значение свойства
boolean
Комментарии
splitType
Указывает способ разделения двух разделов круговой диаграммы или линейчатой диаграммы.
splitType: Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit";
Значение свойства
Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit"
Комментарии
splitValue
Задает пороговое значение, разделяющее две части круговой диаграммы или линейчатой диаграммы.
splitValue: number;
Значение свойства
number
Комментарии
trendlines
Коллекция линий тренда в серии.
readonly trendlines: Excel.ChartTrendlineCollection;
Значение свойства
Комментарии
varyByCategories
Значение true, если Excel присваивает каждому маркеру данных другой цвет или узор. Диаграмма должна содержать только один ряд.
varyByCategories: boolean;
Значение свойства
boolean
Комментарии
xErrorBars
Представляет объект планки погрешностей для ряда диаграммы.
readonly xErrorBars: Excel.ChartErrorBars;
Значение свойства
Комментарии
yErrorBars
Представляет объект планки погрешностей для ряда диаграммы.
readonly yErrorBars: Excel.ChartErrorBars;
Значение свойства
Комментарии
Сведения о методе
delete()
Удаляет ряд диаграммы.
delete(): void;
Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const seriesCollection = sheet.charts.getItemAt(0).series;
seriesCollection.load("count");
await context.sync();
if (seriesCollection.count > 0) {
const series = seriesCollection.getItemAt(0);
// Delete the first series.
series.delete();
}
await context.sync();
});
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(options?: Excel.Interfaces.ChartSeriesLoadOptions): Excel.ChartSeries;
Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(propertyNames?: string | string[]): Excel.ChartSeries;
Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
Примеры
// Rename the 1st series of Chart1 to "New Series Name".
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.series.getItemAt(0).name = "New Series Name";
await context.sync();
console.log("Series1 Renamed");
});
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync()
.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartSeries;
Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
— это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand
строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.ChartSeriesUpdateData, options?: OfficeExtension.UpdateOptions): void;
Параметры
- properties
- Excel.Interfaces.ChartSeriesUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Excel.ChartSeries): void;
Параметры
- properties
- Excel.ChartSeries
Возвращаемое значение
void
setBubbleSizes(sourceData)
Задает размеры пузырьков для ряда диаграмм. Применяется только для пузырьковых диаграмм.
setBubbleSizes(sourceData: Range): void;
Параметры
- sourceData
- Excel.Range
Объект Range
, соответствующий исходным данным.
Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-bubble-chart.yaml
await Excel.run(async (context) => {
/*
The table is expected to look like this:
Product, Inventory, Price, Current Market Share
Calamansi, 2000, $2.45, 10%
...
We want each bubble to represent a single row.
*/
// Get the worksheet and table data.
const sheet = context.workbook.worksheets.getItem("Sample");
const table = sheet.tables.getItem("Sales");
const dataRange = table.getDataBodyRange();
// Get the table data without the row names.
const valueRange = dataRange.getOffsetRange(0, 1).getResizedRange(0, -1);
// Create the chart.
const bubbleChart = sheet.charts.add(Excel.ChartType.bubble, valueRange);
bubbleChart.name = "Product Chart";
// Remove the default series, since we want a unique series for each row.
bubbleChart.series.getItemAt(0).delete();
// Load the data necessary to make a chart series.
dataRange.load(["rowCount", "values"]);
await context.sync();
// For each row, create a chart series (a bubble).
for (let i = 0; i < dataRange.rowCount; i++) {
const newSeries = bubbleChart.series.add(dataRange.values[i][0], i);
newSeries.setXAxisValues(dataRange.getCell(i, 1));
newSeries.setValues(dataRange.getCell(i, 2));
newSeries.setBubbleSizes(dataRange.getCell(i, 3));
// Show the product name and market share percentage.
newSeries.dataLabels.showSeriesName = true;
newSeries.dataLabels.showBubbleSize = true;
newSeries.dataLabels.showValue = false;
}
await context.sync();
});
setValues(sourceData)
Задает значения для ряда диаграммы. Для точечной диаграммы она относится к значениям оси Y.
setValues(sourceData: Range): void;
Параметры
- sourceData
- Excel.Range
Объект Range
, соответствующий исходным данным.
Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
let seriesCollection = sheet.charts.getItemAt(0);
let rangeSelection = sheet.getRange("C2:C7");
let xRangeSelection = sheet.getRange("A1:A7");
// Add a series.
let newSeries = seriesCollection.series.add("Qtr2");
newSeries.setValues(rangeSelection);
newSeries.setXAxisValues(xRangeSelection);
await context.sync();
});
setXAxisValues(sourceData)
Задает значения оси X для ряда диаграммы.
setXAxisValues(sourceData: Range): void;
Параметры
- sourceData
- Excel.Range
Объект Range
, соответствующий исходным данным.
Возвращаемое значение
void
Комментарии
toJSON()
Переопределяет метод JavaScript toJSON()
, чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify()
. (JSON.stringify
в свою очередь вызывает toJSON
метод переданного ему объекта.) В то время как исходный Excel.ChartSeries
объект является объектом API, toJSON
метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ChartSeriesData
), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Excel.Interfaces.ChartSeriesData;
Возвращаемое значение
Office Add-ins