Compartilhar via

Excel.Chart class

  • Referência
Pacote:
excel

Representa um objeto chart em uma pasta de trabalho. Para saber mais sobre o modelo de objeto de gráfico, veja Trabalhar com gráficos com a API JavaScript do Excel.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Propriedades

axes

Representa os eixos de um gráfico.
categoryLabelLevel

Especifica uma constante de enumeração de nível de etiqueta de categoria de gráfico, referindo-se ao nível das etiquetas da categoria de origem.
chartType

Especifica o tipo do gráfico. 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 os rótulos de dados no gráfico.
displayBlanksAs

Especifica a forma como as células em branco são desenhadas num gráfico.
format

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

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

Id exclusiva do gráfico.
left

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

Representa a legenda do gráfico.
name

Especifica o nome de um objeto de gráfico.
pivotOptions

Encapsula as opções para um gráfico dinâmico.
plotArea

Representa a área de desenho do gráfico.
plotBy

Especifica a forma como as colunas ou linhas são usadas como série de dados no gráfico.
plotVisibleOnly

Verdadeiro se apenas as células visíveis forem plotadas. Falso se ambas as células visíveis e ocultas forem plotadas..
series

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

Especifica uma constante de enumeração ao nível do nome da série de gráficos, referindo-se ao nível dos nomes das séries de origem.
showAllFieldButtons

Especifica se pretende apresentar todos os botões de campo num gráfico dinâmico.
showDataLabelsOverMaximum

Especifica se pretende mostrar as etiquetas de dados quando o valor é maior do que o valor máximo no eixo de valores. Se o eixo de valores se tornar menor do que o tamanho dos pontos de dados, pode utilizar esta propriedade para definir se pretende mostrar as etiquetas de dados. Essa propriedade se aplica somente a gráficos 2D.
style

Especifica o estilo de gráfico para o gráfico.
title

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

Especifica a distância, em pontos, desde a margem superior do objeto até à parte superior da linha 1 (numa folha de cálculo) ou à parte superior da área do gráfico (num gráfico).
width

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

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

Métodos

activate()

Ativa o gráfico na interface do usuário do Excel.
delete()

Exclui o objeto de gráfico.
getDataTable()

Obtém a tabela de dados no gráfico. Se o gráfico não permitir uma tabela de dados, gerará uma exceção.
getDataTableOrNullObject()

Obtém a tabela de dados no gráfico. Se o gráfico não permitir uma tabela de dados, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getImage(width, height, fittingMode)

Compõe o gráfico como uma imagem codificada em Base64 ao dimensionar o gráfico para se ajustar às dimensões especificadas. A proporção é preservada como parte do redimensionamento.
getImage(width, height, fittingModeString)

Compõe o gráfico como uma imagem codificada em Base64 ao dimensionar o gráfico para se ajustar às dimensões especificadas. A proporção é preservada como parte do redimensionamento.
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.
setData(sourceData, seriesBy)

Redefine os dados de origem do gráfico.
setData(sourceData, seriesByString)

Redefine os dados de origem do gráfico.
setPosition(startCell, endCell)

Posiciona o gráfico em relação às células na planilha.
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.Chart é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Eventos

onActivated

Ocorre quando o gráfico é ativado.
onDeactivated

Ocorre quando o gráfico é desativado.

Detalhes da propriedade

axes

Representa os eixos de um gráfico.

readonly axes: Excel.ChartAxes;

Valor da propriedade

Excel.ChartAxes

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

categoryLabelLevel

Especifica uma constante de enumeração de nível de etiqueta de categoria de gráfico, referindo-se ao nível das etiquetas da categoria de origem.

categoryLabelLevel: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

chartType

Especifica o tipo do gráfico. 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

Excel.RequestContext

dataLabels

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

readonly dataLabels: Excel.ChartDataLabels;

Valor da propriedade

Excel.ChartDataLabels

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

displayBlanksAs

Especifica a forma como as células em branco são desenhadas num gráfico.

displayBlanksAs: Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted";

Valor da propriedade

Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted"

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

format

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

readonly format: Excel.ChartAreaFormat;

Valor da propriedade

Excel.ChartAreaFormat

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

height

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

height: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

id

Id exclusiva do gráfico.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

left

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

left: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

legend

Representa a legenda do gráfico.

readonly legend: Excel.ChartLegend;

Valor da propriedade

Excel.ChartLegend

Comentários

[ Conjunto de API: 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 ");
});

name

Especifica o nome de um objeto de gráfico.

name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: 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(); 
});

pivotOptions

Encapsula as opções para um gráfico dinâmico.

readonly pivotOptions: Excel.ChartPivotOptions;

Valor da propriedade

Excel.ChartPivotOptions

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

plotArea

Representa a área de desenho do gráfico.

readonly plotArea: Excel.ChartPlotArea;

Valor da propriedade

Excel.ChartPlotArea

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

plotBy

Especifica a forma como as colunas ou linhas são usadas como série de dados no gráfico.

plotBy: Excel.ChartPlotBy | "Rows" | "Columns";

Valor da propriedade

Excel.ChartPlotBy | "Rows" | "Columns"

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

plotVisibleOnly

Verdadeiro se apenas as células visíveis forem plotadas. Falso se ambas as células visíveis e ocultas forem plotadas..

plotVisibleOnly: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

series

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

readonly series: Excel.ChartSeriesCollection;

Valor da propriedade

Excel.ChartSeriesCollection

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

seriesNameLevel

Especifica uma constante de enumeração ao nível do nome da série de gráficos, referindo-se ao nível dos nomes das séries de origem.

seriesNameLevel: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

showAllFieldButtons

Especifica se pretende apresentar todos os botões de campo num gráfico dinâmico.

showAllFieldButtons: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

showDataLabelsOverMaximum

Especifica se pretende mostrar as etiquetas de dados quando o valor é maior do que o valor máximo no eixo de valores. Se o eixo de valores se tornar menor do que o tamanho dos pontos de dados, pode utilizar esta propriedade para definir se pretende mostrar as etiquetas de dados. Essa propriedade se aplica somente a gráficos 2D.

showDataLabelsOverMaximum: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

style

Especifica o estilo de gráfico para o gráfico.

style: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

title

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

Excel.ChartTitle

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

top

Especifica a distância, em pontos, desde a margem superior do objeto até à parte superior da linha 1 (numa folha de cálculo) ou à parte superior da área do gráfico (num gráfico).

top: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

width

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

width: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

worksheet

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

readonly worksheet: Excel.Worksheet;

Valor da propriedade

Excel.Worksheet

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

Detalhes do método

activate()

Ativa o gráfico na interface do usuário do Excel.

activate(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

delete()

Exclui o objeto de gráfico.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

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

getDataTable()

Obtém a tabela de dados no gráfico. Se o gráfico não permitir uma tabela de dados, gerará uma exceção.

getDataTable(): Excel.ChartDataTable;

Retornos

Excel.ChartDataTable

Comentários

[ Conjunto de API: ExcelApi 1.14 ]

getDataTableOrNullObject()

Obtém a tabela de dados no gráfico. Se o gráfico não permitir uma tabela de dados, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getDataTableOrNullObject(): Excel.ChartDataTable;

Retornos

Excel.ChartDataTable

Comentários

[ Conjunto de API: ExcelApi 1.14 ]

Exemplos

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

// This function adds a data table to a chart that already exists on the worksheet. 
await Excel.run(async (context) => {
  // Retrieve the chart named "SalesChart" from the "Sample" worksheet.
  const chart = context.workbook.worksheets.getItem("Sample").charts.getItem("SalesChart");

  // Get the data table object for the chart and set it to visible.
  const chartDataTable = chart.getDataTableOrNullObject();
  chartDataTable.load("visible");
  chartDataTable.visible = true;
  await context.sync();
});

getImage(width, height, fittingMode)

Compõe o gráfico como uma imagem codificada em Base64 ao dimensionar o gráfico para se ajustar às dimensões especificadas. A proporção é preservada como parte do redimensionamento.

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

Parâmetros

width

number

Opcional. A largura desejada da imagem resultante.

height

number

Opcional. A altura desejada da imagem resultante.

fittingMode
Excel.ImageFittingMode

Opcional. O método utilizado para dimensionar o gráfico para as dimensões especificadas (se a altura e a largura estiverem definidas).

Retornos

OfficeExtension.ClientResult<string>

Comentários

[ Conjunto de API: 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(); 
});

getImage(width, height, fittingModeString)

Compõe o gráfico como uma imagem codificada em Base64 ao dimensionar o gráfico para se ajustar às dimensões especificadas. A proporção é preservada como parte do redimensionamento.

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

Parâmetros

width

number

Opcional. A largura desejada da imagem resultante.

height

number

Opcional. A altura desejada da imagem resultante.

fittingModeString

"Fit" | "FitAndCenter" | "Fill"

Opcional. O método utilizado para dimensionar o gráfico para as dimensões especificadas (se a altura e a largura estiverem definidas).

Retornos

OfficeExtension.ClientResult<string>

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

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

Parâmetros

options
Excel.Interfaces.ChartLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.Chart

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

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.Chart

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

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

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

Excel.Chart

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.ChartUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Excel.Interfaces.ChartUpdateData

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

Parâmetros

properties
Excel.Chart

Retornos

void

setData(sourceData, seriesBy)

Redefine os dados de origem do gráfico.

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

Parâmetros

sourceData
Excel.Range

O objeto de intervalo correspondente aos dados de origem.

seriesBy
Excel.ChartSeriesBy

Especifica a forma como as colunas ou linhas são usadas como série de dados no gráfico. Pode ser um dos seguintes: Automático (predefinição), Linhas e Colunas. Veja Excel.ChartSeriesBy para obter detalhes.

Retornos

void

Comentários

[ Conjunto de API: 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();
});

setData(sourceData, seriesByString)

Redefine os dados de origem do gráfico.

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

Parâmetros

sourceData
Excel.Range

O objeto de intervalo correspondente aos dados de origem.

seriesByString

"Auto" | "Columns" | "Rows"

Especifica a forma como as colunas ou linhas são usadas como série de dados no gráfico. Pode ser um dos seguintes: Automático (predefinição), Linhas e Colunas. Veja Excel.ChartSeriesBy para obter detalhes.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

setPosition(startCell, endCell)

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

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

Parâmetros

startCell

Excel.Range | string

A célula inicial. Esse é o local para o qual o gráfico será movido. A célula inicial é a célula superior esquerda ou direita, dependendo das configurações de exibição do usuário, da esquerda para a direita.

endCell

Excel.Range | string

Opcional. A célula final. Quando é especificada, a altura e a largura do gráfico são definidas para cobrirem totalmente essa célula ou intervalo.

Retornos

void

Comentários

[ Conjunto de API: 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(); 
});

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.Chart é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.ChartData;

Retornos

Excel.Interfaces.ChartData

Detalhes do evento

onActivated

Ocorre quando o gráfico é ativado.

readonly onActivated: OfficeExtension.EventHandlers<Excel.ChartActivatedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.ChartActivatedEventArgs>

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-chart-activated.yaml

await Excel.run(async (context) => {

    const pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");

    // Register the onActivated and onDeactivated event handlers.
    pieChart.onActivated.add(chartActivated);
    pieChart.onDeactivated.add(chartDeactivated);

    await context.sync();

    console.log("Added handlers for Chart onActivated and onDeactivated events.");
});

...

async function chartActivated(event) {
    await Excel.run(async (context) => {
        // Retrieve the worksheet.
        const sheet = context.workbook.worksheets.getActiveWorksheet();

        // Retrieve the activated chart by ID and load the name of the chart. 
        const activatedChart = sheet.charts.getItem(event.chartId);
        activatedChart.load(["name"]);
        await context.sync();

        // Print out the activated chart's data.
        console.log(`A chart was activated. ID: ${event.chartId}. Chart name: ${activatedChart.name}.`);
    });
}

onDeactivated

Ocorre quando o gráfico é desativado.

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.ChartDeactivatedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.ChartDeactivatedEventArgs>

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-chart-activated.yaml

await Excel.run(async (context) => {

    const pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");

    // Register the onActivated and onDeactivated event handlers.
    pieChart.onActivated.add(chartActivated);
    pieChart.onDeactivated.add(chartDeactivated);

    await context.sync();

    console.log("Added handlers for Chart onActivated and onDeactivated events.");
});

...

async function chartDeactivated(event) {
    await Excel.run(async (context) => {
        // Callback function for when the chart is deactivated.
        console.log("The pie chart is NOT active.");
    });
}