Compartilhar via


Excel.ChartSeries class

Representa uma série de um gráfico.

Extends

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Propriedades

axisGroup

Especifica o grupo para a série especificada.

binOptions

Encapsula as opções de bin para gráficos de histograma e gráficos de pareto.

boxwhiskerOptions

Encapsula as opções para os gráficos de caixa estreita.

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.

chartType

Representa o tipo de gráfico de uma série. Veja Excel.ChartType para obter detalhes.

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

dataLabels

Representa uma coleção de todas as etiquetas de dados da série.

doughnutHoleSize

Representa o tamanho do furo de rosca de uma série de gráficos. Apenas são válidos em gráficos em anel e em anel destacados. Gera um InvalidArgument erro em gráficos inválidos.

explosion

Especifica o valor de explosão para um gráfico circular ou um setor de gráfico em anel. Retorna 0 (zero) se não houver explosão (a ponta da fatia está no centro da pizza).

filtered

Especifica se a série está filtrada. Não aplicável para gráficos de superfície.

firstSliceAngle

Especifica o ângulo do primeiro gráfico circular ou gráfico em anel, em graus (no sentido dos ponteiros do relógio a partir 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.

gapWidth

Representa a largura do espaçamento de uma série de gráfico. Apenas são válidos em gráficos de barras e colunas, bem como em classes específicas de gráficos circulares e de linhas. Gera uma exceção de argumento inválida em gráficos inválidos.

gradientMaximumColor

Especifica a cor para o valor máximo de uma série de gráficos de mapa de região.

gradientMaximumType

Especifica o tipo para o valor máximo de uma série de gráficos de mapa de região.

gradientMaximumValue

Especifica o valor máximo de uma série de gráficos de mapa de região.

gradientMidpointColor

Especifica a cor para o valor de ponto intermédio de uma série de gráficos de mapa de região.

gradientMidpointType

Especifica o tipo para o valor de ponto médio de uma série de gráficos de mapa de região.

gradientMidpointValue

Especifica o valor de ponto intermédio de uma série de gráficos de mapa de região.

gradientMinimumColor

Especifica a cor para o valor mínimo de uma série de gráficos de mapa de região.

gradientMinimumType

Especifica o tipo para o valor mínimo de uma série de gráficos de mapa de região.

gradientMinimumValue

Especifica o valor mínimo de uma série de gráficos de mapa de região.

gradientStyle

Especifica o estilo de gradação de série de um gráfico de mapa de região.

hasDataLabels

Especifica se a série tem etiquetas de dados.

invertColor

Especifica a cor de preenchimento para pontos de dados negativos numa série.

invertIfNegative

Verdadeiro se o Excel inverter o padrão no item quando corresponde a um número negativo.

mapOptions

Encapsula as opções para um gráfico de mapa de região.

markerBackgroundColor

Especifica a cor de fundo do marcador de uma série de gráficos.

markerForegroundColor

Especifica a cor de primeiro plano do marcador de uma série de gráficos.

markerSize

Especifica o tamanho do marcador de uma série de gráficos. O intervalo de tamanho suportado é de 2 a 72. Este método devolve um erro InvalidArgument se estiver definido com um tamanho fora do intervalo suportado.

markerStyle

Especifica o estilo de marcador de uma série de gráficos. Veja Excel.ChartMarkerStyle para obter detalhes.

name

Especifica o nome de uma série num gráfico. O comprimento do nome não deve ser superior a 255 carateres.

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.

parentLabelStrategy

Especifica a área de estratégia de etiqueta principal da série para um gráfico treemap.

plotOrder

Especifica a ordem de desenho de uma série de gráficos no grupo de gráficos.

points

Devolve uma coleção de todos os pontos da série.

secondPlotSize

Especifica o tamanho da secção secundária de um gráfico circular de circular ou de um gráfico de barras de circulares, como uma percentagem do tamanho do circular primário. Pode ser um valor de 5 de 200.

showConnectorLines

Especifica se as linhas de conexão são apresentadas em gráficos de cascata.

showLeaderLines

Especifica se as linhas de preenchimento são apresentadas para cada etiqueta de dados na série.

showShadow

Especifica se a série tem uma sombra.

smooth

Especifica se a série é suave. Apenas aplicável a gráficos de linhas e de dispersão.

splitType

Especifica a forma como as duas secções de um gráfico circular de circular ou de um gráfico de barras de circular são divididas.

splitValue

Especifica o valor de limiar que separa duas secções de um gráfico circular de circular ou de um gráfico de barras de circulares.

trendlines

A coleção de linhas de tendência da série.

varyByCategories

Verdadeiro se o Excel atribuir uma cor ou padrão diferente a cada marcador de dados. O gráfico deve conter apenas uma série.

xErrorBars

Representa o objeto da barra de erros de uma série de gráficos.

yErrorBars

Representa o objeto da barra de erros de uma série de gráficos.

Métodos

delete()

Exclui a série de gráfico.

getDimensionDataSourceString(dimension)

Obtém a representação de cadeia da origem de dados da série de gráficos. A representação da cadeia pode ser informações como um endereço de célula.

getDimensionDataSourceString(dimensionString)

Obtém a representação de cadeia da origem de dados da série de gráficos. A representação da cadeia pode ser informações como um endereço de célula.

getDimensionDataSourceType(dimension)

Obtém o tipo de origem de dados da série de gráficos.

getDimensionDataSourceType(dimensionString)

Obtém o tipo de origem de dados da série de gráficos.

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, consoante a dimensão especificada e a forma como os dados são mapeados para a série de gráficos.

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, consoante a dimensão especificada e a forma 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 context.sync() antes de ler as propriedades.

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(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

setBubbleSizes(sourceData)

Define os tamanhos das bolhas para uma série de gráficos. Funciona apenas para gráficos de bolhas.

setValues(sourceData)

Define os valores de uma série de gráficos. Para gráficos de dispersão, refere-se aos valores do eixo y.

setXAxisValues(sourceData)

Define os valores do eixo x para uma série de gráficos.

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Original Excel.ChartSeries é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartSeriesData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

axisGroup

Especifica o grupo para a série especificada.

axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary";

Valor da propriedade

Excel.ChartAxisGroup | "Primary" | "Secondary"

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

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

[ Conjunto de API: ExcelApi 1.9 ]

boxwhiskerOptions

Encapsula as opções para os gráficos de caixa estreita.

readonly boxwhiskerOptions: Excel.ChartBoxwhiskerOptions;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

[ Conjunto de API: ExcelApi 1.9 ]

chartType

Representa o tipo de gráfico de uma série. Veja Excel.ChartType para obter 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

[ Conjunto de API: ExcelApi 1.7 ]

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

dataLabels

Representa uma coleção de todas as etiquetas de dados da série.

readonly dataLabels: Excel.ChartDataLabels;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

doughnutHoleSize

Representa o tamanho do furo de rosca de uma série de gráficos. Apenas são válidos em gráficos em anel e em anel destacados. Gera um InvalidArgument erro em gráficos inválidos.

doughnutHoleSize: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

explosion

Especifica o valor de explosão para um gráfico circular ou um setor de gráfico em anel. 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

[ Conjunto de API: ExcelApi 1.8 ]

filtered

Especifica se a série está filtrada. Não aplicável para gráficos de superfície.

filtered: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

firstSliceAngle

Especifica o ângulo do primeiro gráfico circular ou gráfico em anel, em graus (no sentido dos ponteiros do relógio a partir 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

[ Conjunto de API: ExcelApi 1.8 ]

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

[ Conjunto de API: ExcelApi 1.1 ]

gapWidth

Representa a largura do espaçamento de uma série de gráfico. Apenas são válidos em gráficos de barras e colunas, bem como em classes específicas de gráficos circulares e de linhas. Gera uma exceção de argumento inválida em gráficos inválidos.

gapWidth: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

[ Conjunto de API: ExcelApi 1.9 ]

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

[ Conjunto de API: ExcelApi 1.9 ]

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

[ Conjunto de API: ExcelApi 1.9 ]

gradientMidpointColor

Especifica a cor para o valor de ponto intermédio de uma série de gráficos de mapa de região.

gradientMidpointColor: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

gradientMidpointType

Especifica o tipo para o valor de ponto médio de uma série de gráficos de mapa de região.

gradientMidpointType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";

Valor da propriedade

Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

gradientMidpointValue

Especifica o valor de ponto intermédio de uma série de gráficos de mapa de região.

gradientMidpointValue: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

gradientMinimumColor

Especifica a cor para o valor mínimo de uma série de gráficos de mapa de região.

gradientMinimumColor: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

[ Conjunto de API: ExcelApi 1.9 ]

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

[ Conjunto de API: ExcelApi 1.9 ]

gradientStyle

Especifica o estilo de gradação de 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

[ Conjunto de API: ExcelApi 1.9 ]

hasDataLabels

Especifica se a série tem etiquetas de dados.

hasDataLabels: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

invertColor

Especifica a cor de preenchimento para pontos de dados negativos numa série.

invertColor: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

invertIfNegative

Verdadeiro se o Excel inverter o padrão no item quando corresponde a um número negativo.

invertIfNegative: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

mapOptions

Encapsula as opções para um gráfico de mapa de região.

readonly mapOptions: Excel.ChartMapOptions;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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 de primeiro plano do marcador 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 suportado é de 2 a 72. Este método devolve um erro InvalidArgument se estiver definido com um tamanho fora do intervalo suportado.

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. Veja Excel.ChartMarkerStyle para obter 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 num gráfico. O comprimento do nome não deve ser superior a 255 carateres.

name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

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

[ Conjunto de API: ExcelApi 1.8 ]

parentLabelStrategy

Especifica a área de estratégia de etiqueta principal da série para um gráfico treemap.

parentLabelStrategy: Excel.ChartParentLabelStrategy | "None" | "Banner" | "Overlapping";

Valor da propriedade

Excel.ChartParentLabelStrategy | "None" | "Banner" | "Overlapping"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

plotOrder

Especifica a ordem de desenho de uma série de gráficos no grupo de gráficos.

plotOrder: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

points

Devolve uma coleção de todos os pontos da série.

readonly points: Excel.ChartPointsCollection;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

secondPlotSize

Especifica o tamanho da secção secundária de um gráfico circular de circular ou de um gráfico de barras de circulares, como uma percentagem do tamanho do circular primário. Pode ser um valor de 5 de 200.

secondPlotSize: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

showConnectorLines

Especifica se as linhas de conexão são apresentadas em gráficos de cascata.

showConnectorLines: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

showLeaderLines

Especifica se as linhas de preenchimento são apresentadas para cada etiqueta de dados na série.

showLeaderLines: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

showShadow

Especifica se a série tem uma sombra.

showShadow: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

smooth

Especifica se a série é suave. Apenas aplicável a gráficos de linhas e de dispersão.

smooth: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

splitType

Especifica a forma como as duas secções de um gráfico circular de circular ou de um gráfico de barras de circular são divididas.

splitType: Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit";

Valor da propriedade

Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit"

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

splitValue

Especifica o valor de limiar que separa duas secções de um gráfico circular de circular ou de um gráfico de barras de circulares.

splitValue: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

trendlines

A coleção de linhas de tendência da série.

readonly trendlines: Excel.ChartTrendlineCollection;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

varyByCategories

Verdadeiro 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

[ Conjunto de API: ExcelApi 1.8 ]

xErrorBars

Representa o objeto da barra de erros de uma série de gráficos.

readonly xErrorBars: Excel.ChartErrorBars;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

yErrorBars

Representa o objeto da barra de erros de uma série de gráficos.

readonly yErrorBars: Excel.ChartErrorBars;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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 da origem de dados da série de gráficos. A representação da cadeia 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 provenientes.

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);
});

getDimensionDataSourceString(dimensionString)

Obtém a representação de cadeia da origem de dados da série de gráficos. A representação da cadeia 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 provenientes.

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.15 ]

getDimensionDataSourceType(dimension)

Obtém o tipo de origem 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 provenientes.

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 origem 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 provenientes.

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.15 ]

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, consoante a dimensão especificada e a forma 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 provenientes.

Retornos

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, consoante a dimensão especificada e a forma 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 provenientes.

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

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

options
Excel.Interfaces.ChartSeriesLoadOptions

Fornece opções para as propriedades do objeto a 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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

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 delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas 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 que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Excel.ChartSeries): void;

Parâmetros

properties
Excel.ChartSeries

Retornos

void

setBubbleSizes(sourceData)

Define os tamanhos das bolhas 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, refere-se aos valores do 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

[ Conjunto de API: ExcelApi 1.7 ]

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Original Excel.ChartSeries é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartSeriesData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.ChartSeriesData;

Retornos