Excel.ChartSeries class
Representa uma série de um gráfico.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Propriedades
axis |
Especifica o grupo da série especificada. |
bin |
Encapsula as opções de bin para gráficos de histograma e gráficos de pareto. |
boxwhisker |
Encapsula as opções para os gráficos de caixa estreita. |
bubble |
Este pode ser um valor inteiro de 0 (zero) a 300, representando a porcentagem do tamanho padrão. Esta propriedade só se aplica a gráficos de bolhas. |
chart |
Representa o tipo de gráfico de uma série. Confira |
context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
data |
Representa uma coleção de todos os rótulos de dados da série. |
doughnut |
Representa o tamanho do furo de rosca de uma série de gráficos. Válido apenas em roscas e roscas explodidas. Lança um |
explosion | Especifica o valor de explosão para uma fatia de gráfico de pizza ou gráfico de donuts. Retorna 0 (zero) se não houver explosão (a ponta da fatia está no centro da pizza). |
filtered | Especifica se a série é filtrada. Não aplicável para gráficos de superfície. |
first |
Especifica o ângulo da primeira fatia de gráfico de pizza ou gráfico de roscas, em graus (no sentido horário da vertical). Aplica-se apenas a pizza, torta 3-D e gráficos de rosca.. Pode ser um valor de 0 a 360. |
format | Representa a formatação de uma série do gráfico, que inclui a formatação de linha e de preenchimento. |
gap |
Representa a largura do espaçamento de uma série de gráfico. Válido apenas em gráficos de barras e colunas, bem como classes específicas de gráficos de linha e pizza. Gera uma exceção de argumento inválida em gráficos inválidos. |
gradient |
Especifica a cor para o valor máximo de uma série de gráficos de mapa de região. |
gradient |
Especifica o tipo para o valor máximo de uma série de gráficos de mapa de região. |
gradient |
Especifica o valor máximo de uma série de gráficos de mapa de região. |
gradient |
Especifica a cor do valor do ponto médio de uma série de gráficos de mapa de região. |
gradient |
Especifica o tipo para o valor do ponto médio de uma série de gráficos de mapa da região. |
gradient |
Especifica o valor do ponto médio de uma série de gráficos de mapa da região. |
gradient |
Especifica a cor do valor mínimo de uma série de gráficos de mapa de região. |
gradient |
Especifica o tipo para o valor mínimo de uma série de gráficos de mapa de região. |
gradient |
Especifica o valor mínimo de uma série de gráficos de mapa de região. |
gradient |
Especifica o estilo de gradiente da série de um gráfico de mapa de região. |
has |
Especifica se a série tem rótulos de dados. |
invert |
Especifica a cor de preenchimento para pontos de dados negativos em uma série. |
invert |
True se o Excel inverte o padrão no item quando ele corresponde a um número negativo. |
map |
Encapsula as opções para um gráfico de mapa de região. |
marker |
Especifica a cor de fundo do marcador de uma série de gráficos. |
marker |
Especifica a cor do marcador em primeiro plano de uma série de gráficos. |
marker |
Especifica o tamanho do marcador de uma série de gráficos. O intervalo de tamanho com suporte é de 2 a 72. Esse método retornará um erro InvalidArgument se ele for definido com um tamanho fora do intervalo com suporte. |
marker |
Especifica o estilo de marcador de uma série de gráficos. Confira |
name | Especifica o nome de uma série em um gráfico. O comprimento do nome não deve ser maior que 255 caracteres. |
overlap | Especifica como barras e colunas são posicionadas. Pode ser um valor entre -100 e 100. Se aplicam apenas às barras 2D e gráficos de colunas 2D. |
parent |
Especifica a área de estratégia de rótulo pai da série para um gráfico de mapa de árvore. |
plot |
Especifica a ordem de plotagem de uma série de gráficos no grupo de gráficos. |
points | Retorna uma coleção de todos os pontos da série. |
second |
Especifica o tamanho da seção secundária de um gráfico pie-of-pie ou um gráfico bar-of-pie, como uma porcentagem do tamanho da torta primária. Pode ser um valor de 5 de 200. |
show |
Especifica se as linhas do conector são mostradas em gráficos de cascata. |
show |
Especifica se as linhas de líder são exibidas para cada rótulo de dados na série. |
show |
Especifica se a série tem uma sombra. |
smooth | Especifica se a série é suave. Aplicável somente a gráficos de linha e dispersão. |
split |
Especifica a forma como as duas seções de um gráfico pie-of-pie ou um gráfico de barras de torta são divididas. |
split |
Especifica o valor limite que separa duas seções de um gráfico pie-of-pie ou um gráfico bar-of-pie. |
trendlines | A coleção de linhas de tendência na série. |
vary |
True se o Excel atribuir uma cor ou padrão diferente a cada marcador de dados. O gráfico deve conter apenas uma série. |
x |
Representa o objeto da barra de erros de uma série de gráficos. |
y |
Representa o objeto da barra de erros de uma série de gráficos. |
Métodos
delete() | Exclui a série de gráfico. |
get |
Obtém a representação de cadeia de caracteres da fonte de dados da série de gráficos. A representação de cadeia de caracteres pode ser informações como um endereço de célula. |
get |
Obtém a representação de cadeia de caracteres da fonte de dados da série de gráficos. A representação de cadeia de caracteres pode ser informações como um endereço de célula. |
get |
Obtém o tipo de fonte de dados da série de gráficos. |
get |
Obtém o tipo de fonte de dados da série de gráficos. |
get |
Obtém os valores de uma única dimensão da série de gráficos. Estes podem ser valores de categoria ou valores de dados, dependendo da dimensão especificada e de como os dados são mapeados para a série de gráficos. |
get |
Obtém os valores de uma única dimensão da série de gráficos. Estes podem ser valores de categoria ou valores de dados, dependendo da dimensão especificada e de como os dados são mapeados para a série de gráficos. |
load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo. |
set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente. |
set |
Define os tamanhos de bolha para uma série de gráficos. Funciona apenas para gráficos de bolhas. |
set |
Define os valores de uma série de gráficos. Para gráficos de dispersão, ele se refere a valores de eixo y. |
set |
Define os valores do eixo x para uma série de gráficos. |
toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
axisGroup
Especifica o grupo da série especificada.
axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary";
Valor da propriedade
Excel.ChartAxisGroup | "Primary" | "Secondary"
Comentários
binOptions
Encapsula as opções de bin para gráficos de histograma e gráficos de pareto.
readonly binOptions: Excel.ChartBinOptions;
Valor da propriedade
Comentários
boxwhiskerOptions
Encapsula as opções para os gráficos de caixa estreita.
readonly boxwhiskerOptions: Excel.ChartBoxwhiskerOptions;
Valor da propriedade
Comentários
bubbleScale
Este pode ser um valor inteiro de 0 (zero) a 300, representando a porcentagem do tamanho padrão. Esta propriedade só se aplica a gráficos de bolhas.
bubbleScale: number;
Valor da propriedade
number
Comentários
chartType
Representa o tipo de gráfico de uma série. Confira Excel.ChartType
detalhes.
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";
Valor da propriedade
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"
Comentários
context
O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;
Valor da propriedade
dataLabels
Representa uma coleção de todos os rótulos de dados da série.
readonly dataLabels: Excel.ChartDataLabels;
Valor da propriedade
Comentários
doughnutHoleSize
Representa o tamanho do furo de rosca de uma série de gráficos. Válido apenas em roscas e roscas explodidas. Lança um InvalidArgument
erro em gráficos inválidos.
doughnutHoleSize: number;
Valor da propriedade
number
Comentários
explosion
Especifica o valor de explosão para uma fatia de gráfico de pizza ou gráfico de donuts. Retorna 0 (zero) se não houver explosão (a ponta da fatia está no centro da pizza).
explosion: number;
Valor da propriedade
number
Comentários
filtered
Especifica se a série é filtrada. Não aplicável para gráficos de superfície.
filtered: boolean;
Valor da propriedade
boolean
Comentários
firstSliceAngle
Especifica o ângulo da primeira fatia de gráfico de pizza ou gráfico de roscas, em graus (no sentido horário da vertical). Aplica-se apenas a pizza, torta 3-D e gráficos de rosca.. Pode ser um valor de 0 a 360.
firstSliceAngle: number;
Valor da propriedade
number
Comentários
format
Representa a formatação de uma série do gráfico, que inclui a formatação de linha e de preenchimento.
readonly format: Excel.ChartSeriesFormat;
Valor da propriedade
Comentários
gapWidth
Representa a largura do espaçamento de uma série de gráfico. Válido apenas em gráficos de barras e colunas, bem como classes específicas de gráficos de linha e pizza. Gera uma exceção de argumento inválida em gráficos inválidos.
gapWidth: number;
Valor da propriedade
number
Comentários
gradientMaximumColor
Especifica a cor para o valor máximo de uma série de gráficos de mapa de região.
gradientMaximumColor: string;
Valor da propriedade
string
Comentários
gradientMaximumType
Especifica o tipo para o valor máximo de uma série de gráficos de mapa de região.
gradientMaximumType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";
Valor da propriedade
Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"
Comentários
gradientMaximumValue
Especifica o valor máximo de uma série de gráficos de mapa de região.
gradientMaximumValue: number;
Valor da propriedade
number
Comentários
gradientMidpointColor
Especifica a cor do valor do ponto médio de uma série de gráficos de mapa de região.
gradientMidpointColor: string;
Valor da propriedade
string
Comentários
gradientMidpointType
Especifica o tipo para o valor do ponto médio de uma série de gráficos de mapa da região.
gradientMidpointType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";
Valor da propriedade
Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"
Comentários
gradientMidpointValue
Especifica o valor do ponto médio de uma série de gráficos de mapa da região.
gradientMidpointValue: number;
Valor da propriedade
number
Comentários
gradientMinimumColor
Especifica a cor do valor mínimo de uma série de gráficos de mapa de região.
gradientMinimumColor: string;
Valor da propriedade
string
Comentários
gradientMinimumType
Especifica o tipo para o valor mínimo de uma série de gráficos de mapa de região.
gradientMinimumType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";
Valor da propriedade
Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"
Comentários
gradientMinimumValue
Especifica o valor mínimo de uma série de gráficos de mapa de região.
gradientMinimumValue: number;
Valor da propriedade
number
Comentários
gradientStyle
Especifica o estilo de gradiente da série de um gráfico de mapa de região.
gradientStyle: Excel.ChartGradientStyle | "TwoPhaseColor" | "ThreePhaseColor";
Valor da propriedade
Excel.ChartGradientStyle | "TwoPhaseColor" | "ThreePhaseColor"
Comentários
hasDataLabels
Especifica se a série tem rótulos de dados.
hasDataLabels: boolean;
Valor da propriedade
boolean
Comentários
invertColor
Especifica a cor de preenchimento para pontos de dados negativos em uma série.
invertColor: string;
Valor da propriedade
string
Comentários
invertIfNegative
True se o Excel inverte o padrão no item quando ele corresponde a um número negativo.
invertIfNegative: boolean;
Valor da propriedade
boolean
Comentários
mapOptions
Encapsula as opções para um gráfico de mapa de região.
readonly mapOptions: Excel.ChartMapOptions;
Valor da propriedade
Comentários
markerBackgroundColor
Especifica a cor de fundo do marcador de uma série de gráficos.
markerBackgroundColor: string;
Valor da propriedade
string
Comentários
[ Conjunto de API: ExcelApi 1.7 ]
Exemplos
// 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
Especifica a cor do marcador em primeiro plano de uma série de gráficos.
markerForegroundColor: string;
Valor da propriedade
string
Comentários
[ Conjunto de API: ExcelApi 1.7 ]
Exemplos
// 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
Especifica o tamanho do marcador de uma série de gráficos. O intervalo de tamanho com suporte é de 2 a 72. Esse método retornará um erro InvalidArgument se ele for definido com um tamanho fora do intervalo com suporte.
markerSize: number;
Valor da propriedade
number
Comentários
[ Conjunto de API: ExcelApi 1.7 ]
Exemplos
// 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
Especifica o estilo de marcador de uma série de gráficos. Confira Excel.ChartMarkerStyle
detalhes.
markerStyle: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture";
Valor da propriedade
Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"
Comentários
[ Conjunto de API: ExcelApi 1.7 ]
Exemplos
// 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
Especifica o nome de uma série em um gráfico. O comprimento do nome não deve ser maior que 255 caracteres.
name: string;
Valor da propriedade
string
Comentários
overlap
Especifica como barras e colunas são posicionadas. Pode ser um valor entre -100 e 100. Se aplicam apenas às barras 2D e gráficos de colunas 2D.
overlap: number;
Valor da propriedade
number
Comentários
parentLabelStrategy
Especifica a área de estratégia de rótulo pai da série para um gráfico de mapa de árvore.
parentLabelStrategy: Excel.ChartParentLabelStrategy | "None" | "Banner" | "Overlapping";
Valor da propriedade
Excel.ChartParentLabelStrategy | "None" | "Banner" | "Overlapping"
Comentários
plotOrder
Especifica a ordem de plotagem de uma série de gráficos no grupo de gráficos.
plotOrder: number;
Valor da propriedade
number
Comentários
points
Retorna uma coleção de todos os pontos da série.
readonly points: Excel.ChartPointsCollection;
Valor da propriedade
Comentários
secondPlotSize
Especifica o tamanho da seção secundária de um gráfico pie-of-pie ou um gráfico bar-of-pie, como uma porcentagem do tamanho da torta primária. Pode ser um valor de 5 de 200.
secondPlotSize: number;
Valor da propriedade
number
Comentários
showConnectorLines
Especifica se as linhas do conector são mostradas em gráficos de cascata.
showConnectorLines: boolean;
Valor da propriedade
boolean
Comentários
showLeaderLines
Especifica se as linhas de líder são exibidas para cada rótulo de dados na série.
showLeaderLines: boolean;
Valor da propriedade
boolean
Comentários
showShadow
Especifica se a série tem uma sombra.
showShadow: boolean;
Valor da propriedade
boolean
Comentários
smooth
Especifica se a série é suave. Aplicável somente a gráficos de linha e dispersão.
smooth: boolean;
Valor da propriedade
boolean
Comentários
splitType
Especifica a forma como as duas seções de um gráfico pie-of-pie ou um gráfico de barras de torta são divididas.
splitType: Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit";
Valor da propriedade
Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit"
Comentários
splitValue
Especifica o valor limite que separa duas seções de um gráfico pie-of-pie ou um gráfico bar-of-pie.
splitValue: number;
Valor da propriedade
number
Comentários
trendlines
A coleção de linhas de tendência na série.
readonly trendlines: Excel.ChartTrendlineCollection;
Valor da propriedade
Comentários
varyByCategories
True se o Excel atribuir uma cor ou padrão diferente a cada marcador de dados. O gráfico deve conter apenas uma série.
varyByCategories: boolean;
Valor da propriedade
boolean
Comentários
xErrorBars
Representa o objeto da barra de erros de uma série de gráficos.
readonly xErrorBars: Excel.ChartErrorBars;
Valor da propriedade
Comentários
yErrorBars
Representa o objeto da barra de erros de uma série de gráficos.
readonly yErrorBars: Excel.ChartErrorBars;
Valor da propriedade
Comentários
Detalhes do método
delete()
Exclui a série de gráfico.
delete(): void;
Retornos
void
Comentários
[ Conjunto de API: ExcelApi 1.7 ]
Exemplos
// 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();
});
getDimensionDataSourceString(dimension)
Obtém a representação de cadeia de caracteres da fonte de dados da série de gráficos. A representação de cadeia de caracteres pode ser informações como um endereço de célula.
getDimensionDataSourceString(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<string>;
Parâmetros
- dimension
- Excel.ChartSeriesDimension
A dimensão do eixo de onde os dados são.
Retornos
OfficeExtension.ClientResult<string>
Comentários
[ Conjunto de API: ExcelApi 1.15 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-source.yaml
// This function retrieves the data source information of a chart series in the Sample worksheet.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
// Get the first chart series from the first chart on the worksheet.
const seriesCollection = sheet.charts.getItemAt(0).series;
const series = seriesCollection.getItemAt(0);
// Get the series data source string and type values.
const dataSourceString = series.getDimensionDataSourceString("Values");
const dataSourceType = series.getDimensionDataSourceType("Values");
series.load("name");
await context.sync();
// Log the data source information to the console.
console.log(series.name + " data source string: " + dataSourceString.value);
console.log(series.name + " data source type: " + dataSourceType.value);
});
getDimensionDataSourceString(dimensionString)
Obtém a representação de cadeia de caracteres da fonte de dados da série de gráficos. A representação de cadeia de caracteres pode ser informações como um endereço de célula.
getDimensionDataSourceString(dimensionString: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<string>;
Parâmetros
- dimensionString
-
"Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"
A dimensão do eixo de onde os dados são.
Retornos
OfficeExtension.ClientResult<string>
Comentários
getDimensionDataSourceType(dimension)
Obtém o tipo de fonte de dados da série de gráficos.
getDimensionDataSourceType(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<Excel.ChartDataSourceType>;
Parâmetros
- dimension
- Excel.ChartSeriesDimension
A dimensão do eixo de onde os dados são.
Retornos
Comentários
[ Conjunto de API: ExcelApi 1.15 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-source.yaml
// This function retrieves the data source information of a chart series in the Sample worksheet.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
// Get the first chart series from the first chart on the worksheet.
const seriesCollection = sheet.charts.getItemAt(0).series;
const series = seriesCollection.getItemAt(0);
// Get the series data source string and type values.
const dataSourceString = series.getDimensionDataSourceString("Values");
const dataSourceType = series.getDimensionDataSourceType("Values");
series.load("name");
await context.sync();
// Log the data source information to the console.
console.log(series.name + " data source string: " + dataSourceString.value);
console.log(series.name + " data source type: " + dataSourceType.value);
});
getDimensionDataSourceType(dimensionString)
Obtém o tipo de fonte de dados da série de gráficos.
getDimensionDataSourceType(dimensionString: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<Excel.ChartDataSourceType>;
Parâmetros
- dimensionString
-
"Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"
A dimensão do eixo de onde os dados são.
Retornos
Comentários
getDimensionValues(dimension)
Obtém os valores de uma única dimensão da série de gráficos. Estes podem ser valores de categoria ou valores de dados, dependendo da dimensão especificada e de como os dados são mapeados para a série de gráficos.
getDimensionValues(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<string[]>;
Parâmetros
- dimension
- Excel.ChartSeriesDimension
A dimensão do eixo de onde os dados são.
Retornos
OfficeExtension.ClientResult<string[]>
Comentários
[ Conjunto de API: ExcelApi 1.12 ]
Exemplos
// 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) => {
const sheet = context.workbook.worksheets.getItem("Sample");
// The sample chart is of type `Excel.ChartType.bubble`.
const bubbleChart = sheet.charts.getItem("Product Chart");
// Get the first series in the chart.
const firstSeries = bubbleChart.series.getItemAt(0);
// Get the values for the dimensions we're interested in.
const bubbleSize = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.bubbleSizes);
const xValues = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.xvalues);
const yValues = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.yvalues);
const category = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.categories);
await context.sync();
// Log the information.
console.log(`Series ${category.value} - X:${xValues.value},Y:${yValues.value},Bubble:${bubbleSize.value}`);
});
getDimensionValues(dimensionString)
Obtém os valores de uma única dimensão da série de gráficos. Estes podem ser valores de categoria ou valores de dados, dependendo da dimensão especificada e de como os dados são mapeados para a série de gráficos.
getDimensionValues(dimensionString: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<string[]>;
Parâmetros
- dimensionString
-
"Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"
A dimensão do eixo de onde os dados são.
Retornos
OfficeExtension.ClientResult<string[]>
Comentários
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync()
antes de ler as propriedades.
load(options?: Excel.Interfaces.ChartSeriesLoadOptions): Excel.ChartSeries;
Parâmetros
Fornece opções para quais propriedades do objeto carregar.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync()
antes de ler as propriedades.
load(propertyNames?: string | string[]): Excel.ChartSeries;
Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
Retornos
Exemplos
// 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)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync()
antes de ler as propriedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartSeries;
Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand
é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties: Interfaces.ChartSeriesUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parâmetros
- properties
- Excel.Interfaces.ChartSeriesUpdateData
Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
set(properties: Excel.ChartSeries): void;
Parâmetros
- properties
- Excel.ChartSeries
Retornos
void
setBubbleSizes(sourceData)
Define os tamanhos de bolha para uma série de gráficos. Funciona apenas para gráficos de bolhas.
setBubbleSizes(sourceData: Range): void;
Parâmetros
- sourceData
- Excel.Range
O Range
objeto correspondente aos dados de origem.
Retornos
void
Comentários
[ Conjunto de API: ExcelApi 1.7 ]
Exemplos
// 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)
Define os valores de uma série de gráficos. Para gráficos de dispersão, ele se refere a valores de eixo y.
setValues(sourceData: Range): void;
Parâmetros
- sourceData
- Excel.Range
O Range
objeto correspondente aos dados de origem.
Retornos
void
Comentários
[ Conjunto de API: ExcelApi 1.7 ]
Exemplos
// 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)
Define os valores do eixo x para uma série de gráficos.
setXAxisValues(sourceData: Range): void;
Parâmetros
- sourceData
- Excel.Range
O Range
objeto correspondente aos dados de origem.
Retornos
void
Comentários
toJSON()
Substitui o método JavaScript toJSON()
para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify()
. (JSON.stringify
por sua vez, chama o toJSON
método do objeto que é passado para ele.) Enquanto o objeto Excel.ChartSeries original é um objeto API, o toJSON
método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartSeriesData
) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.ChartSeriesData;
Retornos
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de