ExcelScript.ChartSeries interface

Adiciona uma nova linha de tendência ao conjunto de linha de tendência.

addChartTrendline(type?: ChartTrendlineType): ChartTrendline;

Parâmetros

Retornos

Exclui a série de gráfico.

delete(): void;

Retornos

Exemplos

/**
 * This sample creates a bubble chart and manually adds each series.
 */
function main(workbook: ExcelScript.Workbook) {
  const sheet = workbook.getActiveWorksheet();
  
  // Add sample data.
  const data = [
    ["Product", "Price ($)", "Quality Score", "Market Share"],
    ["Keyboards", 85, 88, 25],
    ["Mice", 120, 80, 20]
  ];
  const dataRange = sheet.getRange("A1:D3");
  dataRange.setValues(data);
  
  // Create bubble chart - start with headers to create empty chart.
  const chart = sheet.addChart(
    ExcelScript.ChartType.bubble,
    sheet.getRange("B1:D1")
  );
  chart.setPosition("A5");
  chart.getTitle().setText("Product Analysis");
  
  // Remove any default series that were created.
  while (chart.getSeries().length > 0) {
    chart.getSeries()[0].delete();
  }
  
  // Add each product as its own series.
  for (let i = 2; i <= 3; i++) {
    const productName = sheet.getRange(`A${i}`).getValue() as string;
    const newSeries = chart.addChartSeries(productName);
    newSeries.setXAxisValues(sheet.getRange(`B${i}:B${i}`));
    newSeries.setValues(sheet.getRange(`C${i}:C${i}`));
    newSeries.setBubbleSizes(sheet.getRange(`D${i}:D${i}`));
  }
}

Especifica o grupo da série especificada.

getAxisGroup(): ChartAxisGroup;

Retornos

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

getBinOptions(): ChartBinOptions;

Retornos

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

getBoxwhiskerOptions(): ChartBoxwhiskerOptions;

Retornos

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.

getBubbleScale(): number;

Retornos

Obtém um objeto de linha de tendência por índice, que é o pedido de inserção na matriz de itens.

getChartTrendline(index: number): ChartTrendline;

Parâmetros

Retornos

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

getChartType(): ChartType;

Retornos

Representa uma coleção de todos os rótulos de dados da série.

getDataLabels(): ChartDataLabels;

Retornos

Exemplos

/**
 * This sample accesses and configures data labels for a series.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Configure data labels via series.
  const series = chart.getSeries()[0];
  const dataLabels = series.getDataLabels();
  dataLabels.setShowPercentage(true);
  dataLabels.setShowValue(false);
}

Obtém a representação da cadeia de caracteres da fonte de dados da série do gráfico. A representação de cadeia de caracteres pode ser uma informação, como um endereço de célula.

getDimensionDataSourceString(dimension: ChartSeriesDimension): string;

Parâmetros

Retornos

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

getDimensionDataSourceType(
            dimension: ChartSeriesDimension
        ): ChartDataSourceType;

Parâmetros

Retornos

Obtém os valores de uma única dimensão da série do gráfico. 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: ChartSeriesDimension): string[];

Parâmetros

Retornos

Representa o tamanho do furo de rosca de uma série de gráficos. Válido apenas em gráficos de rosca e rosca explodida. Gera um InvalidArgument erro em gráficos inválidos.

getDoughnutHoleSize(): number;

Retornos

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

getExplosion(): number;

Retornos

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

getFiltered(): boolean;

Retornos

Especifica o ângulo da primeira fatia do gráfico de pizza ou gráfico de rosca, em graus (no sentido horário 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.

getFirstSliceAngle(): number;

Retornos

Representa a formatação de uma série do gráfico, que inclui a formatação de linha e de preenchimento.

getFormat(): ChartSeriesFormat;

Retornos

Exemplos

/**
 * This sample gets the series format to customize appearance.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Customize the series color.
  const series = chart.getSeries()[0];
  const format = series.getFormat();
  format.getFill().setSolidColor("#B0C4DE");
}

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 linhas e de pizza. Lança uma exceção de argumento inválido em gráficos inválidos.

getGapWidth(): number;

Retornos

Especifica a cor do valor máximo de uma série de gráficos de mapa de regiões.

getGradientMaximumColor(): string;

Retornos

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

getGradientMaximumType(): ChartGradientStyleType;

Retornos

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

getGradientMaximumValue(): number;

Retornos

Especifica a cor do valor do ponto médio de uma série de gráficos de mapa de regiões.

getGradientMidpointColor(): string;

Retornos

Especifica o tipo do valor do ponto médio de uma série de gráficos de mapa de regiões.

getGradientMidpointType(): ChartGradientStyleType;

Retornos

Especifica o valor do ponto médio de uma série de gráficos de mapa de regiões.

getGradientMidpointValue(): number;

Retornos

Especifica a cor do valor mínimo de uma série de gráficos de mapa de regiões.

getGradientMinimumColor(): string;

Retornos

Especifica o tipo do valor mínimo de uma série de gráficos de mapa de regiões.

getGradientMinimumType(): ChartGradientStyleType;

Retornos

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

getGradientMinimumValue(): number;

Retornos

Especifica o estilo de gradiente de série de um gráfico de mapa de regiões.

getGradientStyle(): ChartGradientStyle;

Retornos

Especifica se a série tem rótulos de dados.

getHasDataLabels(): boolean;

Retornos

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

getInvertColor(): string;

Retornos

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

getInvertIfNegative(): boolean;

Retornos

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

getMapOptions(): ChartMapOptions;

Retornos

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

getMarkerBackgroundColor(): string;

Retornos

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

getMarkerForegroundColor(): string;

Retornos

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 estiver definido com um tamanho fora do intervalo com suporte.

getMarkerSize(): number;

Retornos

Especifica o estilo do marcador de uma série de gráficos. Consulte ExcelScript.ChartMarkerStyle para obter detalhes.

getMarkerStyle(): ChartMarkerStyle;

Retornos

Especifica o nome de uma série em um gráfico. O comprimento do nome não deve ser maior que 255 caracteres.

getName(): string;

Retornos

Exemplos

/**
 * This sample logs the names of each of the chart series in a chart named "ColumnClusteredChart".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get an existing chart named "ColumnClusteredChart".
  let chart = selectedSheet.getChart("ColumnClusteredChart");

  // Log the name of each chart series in the chart.
  let seriesList = chart.getSeries();
  seriesList.forEach((series) => {
    console.log(series.getName());
  });
}

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.

getOverlap(): number;

Retornos

Especifica a área de estratégia do rótulo pai da série para um gráfico de mapa de árvore.

getParentLabelStrategy(): ChartParentLabelStrategy;

Retornos

Especifica a ordem de plotagem de uma série de gráficos dentro do grupo de gráficos.

getPlotOrder(): number;

Retornos

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

getPoints(): ChartPoint[];

Retornos

Especifica o tamanho da seção secundária de um gráfico de pizza ou de barra de pizza como uma porcentagem do tamanho da pizza principal. Pode ser um valor de 5 de 200.

getSecondPlotSize(): number;

Retornos

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

getShowConnectorLines(): boolean;

Retornos

Especifica se as linhas de preenchimento são exibidas para cada rótulo de dados na série.

getShowLeaderLines(): boolean;

Retornos

Especifica se a série tem uma sombra.

getShowShadow(): boolean;

Retornos

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

getSmooth(): boolean;

Retornos

Especifica a forma como as duas seções de um gráfico de pizza ou de barra são divididas.

getSplitType(): ChartSplitType;

Retornos

Especifica o valor limite que separa duas seções de um gráfico de pizza ou de barra de pizza.

getSplitValue(): number;

Retornos

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

getTrendlines(): ChartTrendline[];

Retornos

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.

getVaryByCategories(): boolean;

Retornos

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

getXErrorBars(): ChartErrorBars;

Retornos

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

getYErrorBars(): ChartErrorBars;

Retornos

Exemplos

/**
 * This script adds error bars for the standard error of each chart series point.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range for the chart.
  const worksheet = workbook.getWorksheet("Sample");
  const dataRange = worksheet.getRange("A1:B15");

  // Create a line chart.
  const chart = worksheet.addChart(ExcelScript.ChartType.line, dataRange);

  // For each series, add error bars for the standard error on each point
  const allSeries = chart.getSeries();
  allSeries.forEach((series) => {
    series.getYErrorBars().setType(ExcelScript.ChartErrorBarsType.stError);
    series.getYErrorBars().setVisible(true);
  });
}

Especifica o grupo da série especificada.

setAxisGroup(axisGroup: ChartAxisGroup): void;

Parâmetros

Retornos

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.

setBubbleScale(bubbleScale: number): void;

Parâmetros

Retornos

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

Retornos

Exemplos

/**
 * This sample sets bubble sizes for a bubble chart series.
 */
function main(workbook: ExcelScript.Workbook) {
  const sheet = workbook.getActiveWorksheet();
  
  // Add sample data.
  const data = [
    ["Product", "Price ($)", "Quality Score", "Market Share"],
    ["Product A", 85, 88, 25]
  ];
  const dataRange = sheet.getRange("A1:D2");
  dataRange.setValues(data);
  
  // Create bubble chart.
  const chart = sheet.addChart(
    ExcelScript.ChartType.bubble,
    sheet.getRange("B1:D1")
  );
  chart.setPosition("A4");
  
  // Remove default series.
  while (chart.getSeries().length > 0) {
    chart.getSeries()[0].delete();
  }
  
  // Add series with bubble sizes.
  const newSeries = chart.addChartSeries("Product A");
  newSeries.setXAxisValues(sheet.getRange("B2:B2"));
  newSeries.setValues(sheet.getRange("C2:C2"));
  newSeries.setBubbleSizes(sheet.getRange("D2:D2"));
}

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

setChartType(chartType: ChartType): void;

Parâmetros

Retornos

Representa o tamanho do furo de rosca de uma série de gráficos. Válido apenas em gráficos de rosca e rosca explodida. Gera um InvalidArgument erro em gráficos inválidos.

setDoughnutHoleSize(doughnutHoleSize: number): void;

Parâmetros

Retornos

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

setExplosion(explosion: number): void;

Parâmetros

Retornos

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

setFiltered(filtered: boolean): void;

Parâmetros

Retornos

Especifica o ângulo da primeira fatia do gráfico de pizza ou gráfico de rosca, em graus (no sentido horário 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.

setFirstSliceAngle(firstSliceAngle: number): void;

Parâmetros

Retornos

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 linhas e de pizza. Lança uma exceção de argumento inválido em gráficos inválidos.

setGapWidth(gapWidth: number): void;

Parâmetros

Retornos

Especifica a cor do valor máximo de uma série de gráficos de mapa de regiões.

setGradientMaximumColor(gradientMaximumColor: string): void;

Parâmetros

Retornos

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

setGradientMaximumType(
            gradientMaximumType: ChartGradientStyleType
        ): void;

Parâmetros

Retornos

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

setGradientMaximumValue(gradientMaximumValue: number): void;

Parâmetros

Retornos

Especifica a cor do valor do ponto médio de uma série de gráficos de mapa de regiões.

setGradientMidpointColor(gradientMidpointColor: string): void;

Parâmetros

Retornos

Especifica o tipo do valor do ponto médio de uma série de gráficos de mapa de regiões.

setGradientMidpointType(
            gradientMidpointType: ChartGradientStyleType
        ): void;

Parâmetros

Retornos

Especifica o valor do ponto médio de uma série de gráficos de mapa de regiões.

setGradientMidpointValue(gradientMidpointValue: number): void;

Parâmetros

Retornos

Especifica a cor do valor mínimo de uma série de gráficos de mapa de regiões.

setGradientMinimumColor(gradientMinimumColor: string): void;

Parâmetros

Retornos

Especifica o tipo do valor mínimo de uma série de gráficos de mapa de regiões.

setGradientMinimumType(
            gradientMinimumType: ChartGradientStyleType
        ): void;

Parâmetros

Retornos

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

setGradientMinimumValue(gradientMinimumValue: number): void;

Parâmetros

Retornos

Especifica o estilo de gradiente de série de um gráfico de mapa de regiões.

setGradientStyle(gradientStyle: ChartGradientStyle): void;

Parâmetros

Retornos

Especifica se a série tem rótulos de dados.

setHasDataLabels(hasDataLabels: boolean): void;

Parâmetros

Retornos

Exemplos

/**
 * This sample enables data labels on a chart series.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Enable data labels on the series.
  const series = chart.getSeries()[0];
  series.setHasDataLabels(true);
}

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

setInvertColor(invertColor: string): void;

Parâmetros

Retornos

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

setInvertIfNegative(invertIfNegative: boolean): void;

Parâmetros

Retornos

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

setMarkerBackgroundColor(markerBackgroundColor: string): void;

Parâmetros

Retornos

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

setMarkerForegroundColor(markerForegroundColor: string): void;

Parâmetros

Retornos

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 estiver definido com um tamanho fora do intervalo com suporte.

setMarkerSize(markerSize: number): void;

Parâmetros

Retornos

Exemplos

/**
 * This sample sets the marker size for a line chart series.
 * This assumes the active worksheet has a line chart with markers.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set the marker size for all series.
  const series = chart.getSeries();
  series.forEach((s) => {
    s.setMarkerSize(8);
  });
}

Especifica o estilo do marcador de uma série de gráficos. Consulte ExcelScript.ChartMarkerStyle para obter detalhes.

setMarkerStyle(markerStyle: ChartMarkerStyle): void;

Parâmetros

Retornos

Exemplos

/**
 * This sample sets the marker style for a line chart series.
 * This assumes the active worksheet has a line chart with markers.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set the marker style to circle.
  const series = chart.getSeries()[0];
  series.setMarkerStyle(ExcelScript.ChartMarkerStyle.circle);
}

Especifica o nome de uma série em um gráfico. O comprimento do nome não deve ser maior que 255 caracteres.

setName(name: string): void;

Parâmetros

Retornos

Exemplos

/**
 * This sample sets the name of chart series.
 * This assumes the active worksheet has a chart with at least 4 series.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set names for all series.
  const seriesCollection = chart.getSeries();
  seriesCollection[0].setName("Solar");
  seriesCollection[1].setName("Wind");
  seriesCollection[2].setName("Hydro");
  seriesCollection[3].setName("Geothermal");
}

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.

setOverlap(overlap: number): void;

Parâmetros

Retornos

Exemplos

/**
 * This sample sets the overlap of the columns in a chart named "ColumnClusteredChart".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get an existing chart named "ColumnClusteredChart".
  let chart = selectedSheet.getChart("ColumnClusteredChart");

  // Set the overlap of every column of each series within a category.
  let seriesList = chart.getSeries();
  seriesList.forEach((series) => {
    // An overlap of 25 means the columns have 25% of their length overlapping with the adjacent columns in the same category.
    series.setOverlap(25);
  });
}

Especifica a área de estratégia do rótulo pai da série para um gráfico de mapa de árvore.

setParentLabelStrategy(
            parentLabelStrategy: ChartParentLabelStrategy
        ): void;

Parâmetros

Retornos

Especifica a ordem de plotagem de uma série de gráficos dentro do grupo de gráficos.

setPlotOrder(plotOrder: number): void;

Parâmetros

Retornos

Especifica o tamanho da seção secundária de um gráfico de pizza ou de barra de pizza como uma porcentagem do tamanho da pizza principal. Pode ser um valor de 5 de 200.

setSecondPlotSize(secondPlotSize: number): void;

Parâmetros

Retornos

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

setShowConnectorLines(showConnectorLines: boolean): void;

Parâmetros

Retornos

Especifica se as linhas de preenchimento são exibidas para cada rótulo de dados na série.

setShowLeaderLines(showLeaderLines: boolean): void;

Parâmetros

Retornos

Especifica se a série tem uma sombra.

setShowShadow(showShadow: boolean): void;

Parâmetros

Retornos

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

setSmooth(smooth: boolean): void;

Parâmetros

Retornos

Especifica a forma como as duas seções de um gráfico de pizza ou de barra são divididas.

setSplitType(splitType: ChartSplitType): void;

Parâmetros

Retornos

Especifica o valor limite que separa duas seções de um gráfico de pizza ou de barra de pizza.

setSplitValue(splitValue: number): void;

Parâmetros

Retornos

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

Retornos

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.

setVaryByCategories(varyByCategories: boolean): void;

Parâmetros

Retornos

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

setXAxisValues(sourceData: Range): void;

Parâmetros

Retornos