Excel.Chart class

Representa os eixos de um gráfico.

readonly axes: Excel.ChartAxes;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Representa os rótulos de dados no gráfico.

readonly dataLabels: Excel.ChartDataLabels;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Encapsula as propriedades de formato da área do gráfico.

readonly format: Excel.ChartAreaFormat;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Especifica a altura, em pontos, do objeto de gráfico.

height: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

A distância, em pontos, da esquerda do gráfico à origem da planilha.

left: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Representa a legenda do gráfico.

readonly legend: Excel.ChartLegend;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

// Set to show legend of Chart1 and make it on top of the chart.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.legend.visible = true;
    chart.legend.position = "Top"; 
    chart.legend.overlay = false; 
    await context.sync()
    
    console.log("Legend Shown ");
});

Especifica o nome de um objeto de gráfico.

name: string;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

// Rename the chart to new name, resize the chart to 200 points in both height and weight.
// Move Chart1 to 100 points to the top and left.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.name = "New Name";
    chart.top = 100;
    chart.left = 100;
    chart.height = 200;
    chart.width = 200;
    await context.sync(); 
});

Representa uma única série ou uma coleção de séries no gráfico.

readonly series: Excel.ChartSeriesCollection;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

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 chart: Excel.Chart = sheet.charts.getItemAt(0);
  let rangeSelection = sheet.getRange("C2:C7");
  let xRangeSelection = sheet.getRange("A1:A7");

  // Add a series.
  const newSeries: Excel.ChartSeries = chart.series.add("Qtr2");
  newSeries.setValues(rangeSelection);
  newSeries.setXAxisValues(xRangeSelection);

  await context.sync();
});

Representa o título do gráfico especificado, incluindo o respectivo texto, a visibilidade, a posição e a formatação.

readonly title: Excel.ChartTitle;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-title-format.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const title = sheet.charts.getItemAt(0).title;
    title.textOrientation = -45;

    await context.sync();
});

Especifica a distância, em pontos, da borda superior do objeto até a parte superior da linha 1 (em uma planilha) ou a parte superior da área do gráfico (em um gráfico).

top: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Especifica a largura, em pontos, do objeto de gráfico.

width: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

A planilha que contém o gráfico atual.

readonly worksheet: Excel.Worksheet;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.2

Exclui o objeto de gráfico.

delete(): void;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.delete();
    await context.sync(); 
});

Renderiza o gráfico como uma imagem codificada em Base64 dimensionando-o para ajustá-lo às dimensões especificadas. A taxa de proporção é preservada como parte do redimensionamento.

getImage(width?: number, height?: number, fittingMode?: Excel.ImageFittingMode): OfficeExtension.ClientResult<string>;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.2

Exemplos

await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    const image = chart.getImage();
    await context.sync(); 
});

Renderiza o gráfico como uma imagem codificada em Base64 dimensionando-o para ajustá-lo às dimensões especificadas. A taxa de proporção é preservada como parte do redimensionamento.

getImage(width?: number, height?: number, fittingMode?: "Fit" | "FitAndCenter" | "Fill"): OfficeExtension.ClientResult<string>;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.2

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.ChartLoadOptions): Excel.Chart;

Parâmetros

Retornos

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.Chart;

Parâmetros

Retornos

Exemplos

// Get a chart named "Chart1".
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.load('name');
    await context.sync();

    console.log(chart.name);
});

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.Chart;

Parâmetros

Retornos

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.ChartUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

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

set(properties: Excel.Chart): void;

Parâmetros

Retornos

Redefine os dados de origem do gráfico.

setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

// Set the sourceData to be the range at "A1:B4" and seriesBy to be "Columns".
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sheet1");
    const chart = sheet.charts.getItem("Chart1");
    const sourceData = sheet.getRange("A1:B4");
    chart.setData(sourceData, "Columns");
    await context.sync();
});

Redefine os dados de origem do gráfico.

setData(sourceData: Range, seriesBy?: "Auto" | "Columns" | "Rows"): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.1

Posiciona o gráfico em relação às células na planilha.

setPosition(startCell: Range | string, endCell?: Range | string): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

await Excel.run(async (context) => { 
    const sheetName = "Charts";
    const rangeSelection = "A1:B4";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeSelection);
    const sourceData = sheetName + "!" + "A1:B4";
    const chart = context.workbook.worksheets.getItem(sheetName).charts.add("pie", range, "auto");
    chart.width = 500;
    chart.height = 300;
    chart.setPosition("C2", null);
    await context.sync(); 
});

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.Chart é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.ChartData;

Retornos