Compartilhar via


ExcelScript.ChartSeries interface

Representa uma série de um gráfico.

Comentários

Exemplos

/**
 * This sample produces a line chart with two series.
 * The chart assumes data in A1:E5 that looks like this:
 * Product Qtr1 Qtr2 Qtr3 Qtr4
 * Frames 5000 7000 6544 4377
 * Saddles 400 323 276 651
 */
function main(workbook: ExcelScript.Workbook) {
  // Establish the ranges to use.
  const sheet = workbook.getActiveWorksheet();
  const headerRange = sheet.getRange("A1:E1");
  const firstSeriesRange = sheet.getRange("A2:E2");
  const secondSeriesRange = sheet.getRange("A3:E3");

  // Create the chart.
  const lineChart = sheet.addChart(ExcelScript.ChartType.line, headerRange);

  // Add the first chart series.
  const firstSeries = lineChart.addChartSeries();
  firstSeries.setXAxisValues(headerRange);
  firstSeries.setValues(firstSeriesRange);

  // Add the second chart series.
  const secondSeries = lineChart.addChartSeries();
  secondSeries.setXAxisValues(headerRange);
  secondSeries.setValues(secondSeriesRange);
}

Métodos

addChartTrendline(type)

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

delete()

Exclui a série de gráfico.

getAxisGroup()

Especifica o grupo para a série especificada.

getBinOptions()

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

getBoxwhiskerOptions()

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

getBubbleScale()

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.

getChartTrendline(index)

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

getChartType()

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

getDataLabels()

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

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.

getDimensionDataSourceType(dimension)

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.

getDoughnutHoleSize()

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.

getExplosion()

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).

getFiltered()

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

getFirstSliceAngle()

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.

getFormat()

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

getGapWidth()

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.

getGradientMaximumColor()

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

getGradientMaximumType()

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

getGradientMaximumValue()

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

getGradientMidpointColor()

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

getGradientMidpointType()

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

getGradientMidpointValue()

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

getGradientMinimumColor()

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

getGradientMinimumType()

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

getGradientMinimumValue()

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

getGradientStyle()

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

getHasDataLabels()

Especifica se a série tem etiquetas de dados.

getInvertColor()

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

getInvertIfNegative()

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

getMapOptions()

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

getMarkerBackgroundColor()

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

getMarkerForegroundColor()

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

getMarkerSize()

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.

getMarkerStyle()

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

getName()

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

getOverlap()

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.

getParentLabelStrategy()

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

getPlotOrder()

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

getPoints()

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

getSecondPlotSize()

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.

getShowConnectorLines()

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

getShowLeaderLines()

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

getShowShadow()

Especifica se a série tem uma sombra.

getSmooth()

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

getSplitType()

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.

getSplitValue()

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.

getTrendlines()

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

getVaryByCategories()

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.

getXErrorBars()

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

getYErrorBars()

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

setAxisGroup(axisGroup)

Especifica o grupo para a série especificada.

setBubbleScale(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.

setBubbleSizes(sourceData)

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

setChartType(chartType)

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

setDoughnutHoleSize(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.

setExplosion(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).

setFiltered(filtered)

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

setFirstSliceAngle(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.

setGapWidth(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.

setGradientMaximumColor(gradientMaximumColor)

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

setGradientMaximumType(gradientMaximumType)

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

setGradientMaximumValue(gradientMaximumValue)

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

setGradientMidpointColor(gradientMidpointColor)

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

setGradientMidpointType(gradientMidpointType)

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

setGradientMidpointValue(gradientMidpointValue)

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

setGradientMinimumColor(gradientMinimumColor)

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

setGradientMinimumType(gradientMinimumType)

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

setGradientMinimumValue(gradientMinimumValue)

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

setGradientStyle(gradientStyle)

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

setHasDataLabels(hasDataLabels)

Especifica se a série tem etiquetas de dados.

setInvertColor(invertColor)

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

setInvertIfNegative(invertIfNegative)

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

setMarkerBackgroundColor(markerBackgroundColor)

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

setMarkerForegroundColor(markerForegroundColor)

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

setMarkerSize(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.

setMarkerStyle(markerStyle)

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

setName(name)

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

setOverlap(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.

setParentLabelStrategy(parentLabelStrategy)

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

setPlotOrder(plotOrder)

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

setSecondPlotSize(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.

setShowConnectorLines(showConnectorLines)

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

setShowLeaderLines(showLeaderLines)

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

setShowShadow(showShadow)

Especifica se a série tem uma sombra.

setSmooth(smooth)

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

setSplitType(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.

setSplitValue(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.

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.

setVaryByCategories(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.

setXAxisValues(sourceData)

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

Detalhes do método

addChartTrendline(type)

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

addChartTrendline(type?: ChartTrendlineType): ChartTrendline;

Parâmetros

type
ExcelScript.ChartTrendlineType

Especifica o tipo de linha de tendência. O valor predefinido é "Linear". Veja ExcelScript.ChartTrendline para obter detalhes.

Retornos

delete()

Exclui a série de gráfico.

delete(): void;

Retornos

void

getAxisGroup()

Especifica o grupo para a série especificada.

getAxisGroup(): ChartAxisGroup;

Retornos

getBinOptions()

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

getBinOptions(): ChartBinOptions;

Retornos

getBoxwhiskerOptions()

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

getBoxwhiskerOptions(): ChartBoxwhiskerOptions;

Retornos

getBubbleScale()

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

number

getChartTrendline(index)

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

getChartTrendline(index: number): ChartTrendline;

Parâmetros

index

number

Representa a ordem de inserção na matriz de itens.

Retornos

getChartType()

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

getChartType(): ChartType;

Retornos

getDataLabels()

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

getDataLabels(): ChartDataLabels;

Retornos

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: ChartSeriesDimension): string;

Parâmetros

dimension
ExcelScript.ChartSeriesDimension

A dimensão do eixo de onde os dados são provenientes.

Retornos

string

getDimensionDataSourceType(dimension)

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

getDimensionDataSourceType(
            dimension: ChartSeriesDimension
        ): ChartDataSourceType;

Parâmetros

dimension
ExcelScript.ChartSeriesDimension

A dimensão do eixo de onde os dados são provenientes.

Retornos

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: ChartSeriesDimension): string[];

Parâmetros

dimension
ExcelScript.ChartSeriesDimension

A dimensão do eixo de onde os dados são provenientes.

Retornos

string[]

getDoughnutHoleSize()

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.

getDoughnutHoleSize(): number;

Retornos

number

getExplosion()

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).

getExplosion(): number;

Retornos

number

getFiltered()

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

getFiltered(): boolean;

Retornos

boolean

getFirstSliceAngle()

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.

getFirstSliceAngle(): number;

Retornos

number

getFormat()

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

getFormat(): ChartSeriesFormat;

Retornos

getGapWidth()

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.

getGapWidth(): number;

Retornos

number

getGradientMaximumColor()

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

getGradientMaximumColor(): string;

Retornos

string

getGradientMaximumType()

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

getGradientMaximumType(): ChartGradientStyleType;

Retornos

getGradientMaximumValue()

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

getGradientMaximumValue(): number;

Retornos

number

getGradientMidpointColor()

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

getGradientMidpointColor(): string;

Retornos

string

getGradientMidpointType()

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

getGradientMidpointType(): ChartGradientStyleType;

Retornos

getGradientMidpointValue()

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

getGradientMidpointValue(): number;

Retornos

number

getGradientMinimumColor()

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

getGradientMinimumColor(): string;

Retornos

string

getGradientMinimumType()

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

getGradientMinimumType(): ChartGradientStyleType;

Retornos

getGradientMinimumValue()

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

getGradientMinimumValue(): number;

Retornos

number

getGradientStyle()

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

getGradientStyle(): ChartGradientStyle;

Retornos

getHasDataLabels()

Especifica se a série tem etiquetas de dados.

getHasDataLabels(): boolean;

Retornos

boolean

getInvertColor()

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

getInvertColor(): string;

Retornos

string

getInvertIfNegative()

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

getInvertIfNegative(): boolean;

Retornos

boolean

getMapOptions()

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

getMapOptions(): ChartMapOptions;

Retornos

getMarkerBackgroundColor()

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

getMarkerBackgroundColor(): string;

Retornos

string

getMarkerForegroundColor()

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

getMarkerForegroundColor(): string;

Retornos

string

getMarkerSize()

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.

getMarkerSize(): number;

Retornos

number

getMarkerStyle()

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

getMarkerStyle(): ChartMarkerStyle;

Retornos

getName()

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

getName(): string;

Retornos

string

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

getOverlap()

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

number

getParentLabelStrategy()

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

getParentLabelStrategy(): ChartParentLabelStrategy;

Retornos

getPlotOrder()

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

getPlotOrder(): number;

Retornos

number

getPoints()

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

getPoints(): ChartPoint[];

Retornos

getSecondPlotSize()

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.

getSecondPlotSize(): number;

Retornos

number

getShowConnectorLines()

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

getShowConnectorLines(): boolean;

Retornos

boolean

getShowLeaderLines()

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

getShowLeaderLines(): boolean;

Retornos

boolean

getShowShadow()

Especifica se a série tem uma sombra.

getShowShadow(): boolean;

Retornos

boolean

getSmooth()

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

getSmooth(): boolean;

Retornos

boolean

getSplitType()

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.

getSplitType(): ChartSplitType;

Retornos

getSplitValue()

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.

getSplitValue(): number;

Retornos

number

getTrendlines()

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

getTrendlines(): ChartTrendline[];

Retornos

getVaryByCategories()

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

boolean

getXErrorBars()

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

getXErrorBars(): ChartErrorBars;

Retornos

getYErrorBars()

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

setAxisGroup(axisGroup)

Especifica o grupo para a série especificada.

setAxisGroup(axisGroup: ChartAxisGroup): void;

Parâmetros

Retornos

void

setBubbleScale(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.

setBubbleScale(bubbleScale: number): void;

Parâmetros

bubbleScale

number

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
ExcelScript.Range

O Range objeto correspondente aos dados de origem.

Retornos

void

setChartType(chartType)

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

setChartType(chartType: ChartType): void;

Parâmetros

Retornos

void

setDoughnutHoleSize(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.

setDoughnutHoleSize(doughnutHoleSize: number): void;

Parâmetros

doughnutHoleSize

number

Retornos

void

setExplosion(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).

setExplosion(explosion: number): void;

Parâmetros

explosion

number

Retornos

void

setFiltered(filtered)

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

setFiltered(filtered: boolean): void;

Parâmetros

filtered

boolean

Retornos

void

setFirstSliceAngle(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.

setFirstSliceAngle(firstSliceAngle: number): void;

Parâmetros

firstSliceAngle

number

Retornos

void

setGapWidth(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.

setGapWidth(gapWidth: number): void;

Parâmetros

gapWidth

number

Retornos

void

setGradientMaximumColor(gradientMaximumColor)

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

setGradientMaximumColor(gradientMaximumColor: string): void;

Parâmetros

gradientMaximumColor

string

Retornos

void

setGradientMaximumType(gradientMaximumType)

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

setGradientMaximumType(
            gradientMaximumType: ChartGradientStyleType
        ): void;

Parâmetros

Retornos

void

setGradientMaximumValue(gradientMaximumValue)

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

setGradientMaximumValue(gradientMaximumValue: number): void;

Parâmetros

gradientMaximumValue

number

Retornos

void

setGradientMidpointColor(gradientMidpointColor)

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

setGradientMidpointColor(gradientMidpointColor: string): void;

Parâmetros

gradientMidpointColor

string

Retornos

void

setGradientMidpointType(gradientMidpointType)

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

setGradientMidpointType(
            gradientMidpointType: ChartGradientStyleType
        ): void;

Parâmetros

gradientMidpointType
ExcelScript.ChartGradientStyleType

Retornos

void

setGradientMidpointValue(gradientMidpointValue)

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

setGradientMidpointValue(gradientMidpointValue: number): void;

Parâmetros

gradientMidpointValue

number

Retornos

void

setGradientMinimumColor(gradientMinimumColor)

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

setGradientMinimumColor(gradientMinimumColor: string): void;

Parâmetros

gradientMinimumColor

string

Retornos

void

setGradientMinimumType(gradientMinimumType)

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

setGradientMinimumType(
            gradientMinimumType: ChartGradientStyleType
        ): void;

Parâmetros

Retornos

void

setGradientMinimumValue(gradientMinimumValue)

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

setGradientMinimumValue(gradientMinimumValue: number): void;

Parâmetros

gradientMinimumValue

number

Retornos

void

setGradientStyle(gradientStyle)

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

setGradientStyle(gradientStyle: ChartGradientStyle): void;

Parâmetros

Retornos

void

setHasDataLabels(hasDataLabels)

Especifica se a série tem etiquetas de dados.

setHasDataLabels(hasDataLabels: boolean): void;

Parâmetros

hasDataLabels

boolean

Retornos

void

setInvertColor(invertColor)

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

setInvertColor(invertColor: string): void;

Parâmetros

invertColor

string

Retornos

void

setInvertIfNegative(invertIfNegative)

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

setInvertIfNegative(invertIfNegative: boolean): void;

Parâmetros

invertIfNegative

boolean

Retornos

void

setMarkerBackgroundColor(markerBackgroundColor)

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

setMarkerBackgroundColor(markerBackgroundColor: string): void;

Parâmetros

markerBackgroundColor

string

Retornos

void

setMarkerForegroundColor(markerForegroundColor)

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

setMarkerForegroundColor(markerForegroundColor: string): void;

Parâmetros

markerForegroundColor

string

Retornos

void

setMarkerSize(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.

setMarkerSize(markerSize: number): void;

Parâmetros

markerSize

number

Retornos

void

setMarkerStyle(markerStyle)

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

setMarkerStyle(markerStyle: ChartMarkerStyle): void;

Parâmetros

Retornos

void

setName(name)

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

setName(name: string): void;

Parâmetros

name

string

Retornos

void

setOverlap(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.

setOverlap(overlap: number): void;

Parâmetros

overlap

number

Retornos

void

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

setParentLabelStrategy(parentLabelStrategy)

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

setParentLabelStrategy(
            parentLabelStrategy: ChartParentLabelStrategy
        ): void;

Parâmetros

Retornos

void

setPlotOrder(plotOrder)

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

setPlotOrder(plotOrder: number): void;

Parâmetros

plotOrder

number

Retornos

void

setSecondPlotSize(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.

setSecondPlotSize(secondPlotSize: number): void;

Parâmetros

secondPlotSize

number

Retornos

void

setShowConnectorLines(showConnectorLines)

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

setShowConnectorLines(showConnectorLines: boolean): void;

Parâmetros

showConnectorLines

boolean

Retornos

void

setShowLeaderLines(showLeaderLines)

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

setShowLeaderLines(showLeaderLines: boolean): void;

Parâmetros

showLeaderLines

boolean

Retornos

void

setShowShadow(showShadow)

Especifica se a série tem uma sombra.

setShowShadow(showShadow: boolean): void;

Parâmetros

showShadow

boolean

Retornos

void

setSmooth(smooth)

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

setSmooth(smooth: boolean): void;

Parâmetros

smooth

boolean

Retornos

void

setSplitType(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.

setSplitType(splitType: ChartSplitType): void;

Parâmetros

Retornos

void

setSplitValue(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.

setSplitValue(splitValue: number): void;

Parâmetros

splitValue

number

Retornos

void

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
ExcelScript.Range

O Range objeto correspondente aos dados de origem.

Retornos

void

setVaryByCategories(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.

setVaryByCategories(varyByCategories: boolean): void;

Parâmetros

varyByCategories

boolean

Retornos

void

setXAxisValues(sourceData)

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

setXAxisValues(sourceData: Range): void;

Parâmetros

sourceData
ExcelScript.Range

O Range objeto correspondente aos dados de origem.

Retornos

void