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

Especifica uma constante de enumeração de nível de rótulo de categoria de gráfico, fazendo referência ao nível dos rótulos de categoria de origem.

categoryLabelLevel: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.8

Especifica o tipo do gráfico. Consulte 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" | "ColumnClusteredEx" | "ColumnStackedEx" | "ColumnStacked100Ex" | "LineEx" | "LineStackedEx" | "LineStacked100Ex" | "PieEx" | "DoughnutEx" | "BarClusteredEx" | "BarStackedEx" | "BarStacked100Ex" | "AreaEx" | "AreaStackedEx" | "AreaStacked100Ex" | "XYScatterEx" | "BubbleEx";

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

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

Especifica a maneira como as células em branco são plotadas em um gráfico.

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

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.8

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

Id exclusiva do gráfico.

readonly id: string;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

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

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

readonly pivotOptions: Excel.ChartPivotOptions;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Representa a área de plotagem do gráfico.

readonly plotArea: Excel.ChartPlotArea;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.8

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

Comentários

Conjunto de APIs: ExcelApi 1.8

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

Comentários

Conjunto de APIs: ExcelApi 1.8

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

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

seriesNameLevel: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.8

Especifica se todos os botões de campo devem ser exibidos em um Gráfico Dinâmico.

showAllFieldButtons: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

Especifica se os rótulos de dados devem ser exibidos quando o valor for maior que o valor máximo no eixo do valor. Se o eixo dos valores se tornar menor que o tamanho dos pontos de dados, você poderá usar esta propriedade para definir se deseja exibir os rótulos de dados. Essa propriedade se aplica somente a gráficos 2D.

showDataLabelsOverMaximum: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.8

Especifica o estilo do gráfico.

style: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.8

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

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

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

activate(): void;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

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

Obtém a fonte de dados do gráfico inteiro. Se o intervalo de dados estiver vazio, esse método retornará o EmptyChartSeries erro.

getDataRange(): OfficeExtension.ClientResult<string>;

Retornos

Comentários

Conjunto de APIs: ExcelApi BETA (SOMENTE VISUALIZAÇÃO)

Obtém a fonte de dados do gráfico inteiro. Se o intervalo de dados estiver vazio, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getDataRangeOrNullObject(): OfficeExtension.ClientResult<string>;

Retornos

Comentários

Conjunto de APIs: ExcelApi BETA (SOMENTE VISUALIZAÇÃO)

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

getDataTable(): Excel.ChartDataTable;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.14

Obtém a tabela de dados no gráfico. Se o gráfico não permitir uma tabela de dados, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getDataTableOrNullObject(): Excel.ChartDataTable;

Retornos

Comentários

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

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

Ocorre quando o gráfico é ativado.

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

Tipo de evento

Comentários

Conjunto de APIs: 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}.`);
    });
}

Ocorre quando o gráfico é desativado.

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

Tipo de evento

Comentários

Conjunto de APIs: 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.");
    });
}