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.
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.
format	Encapsula as propriedades de formato da área do gráfico.
height	Especifica a altura, em pontos, do objeto de 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.
series	Representa uma única série ou uma coleção de séries no 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

delete()	Exclui o objeto de gráfico.
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.stringify`por 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.

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 ]

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 ]

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 ]

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

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 ]

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

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

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"

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

Compartilhar via

Excel.Chart class

Comentários

Propriedades

Métodos

Detalhes da propriedade

axes

Valor da propriedade

Comentários

context

Valor da propriedade

dataLabels

Valor da propriedade

Comentários

format

Valor da propriedade

Comentários

height

Valor da propriedade

Comentários

left

Valor da propriedade

Comentários

legend

Valor da propriedade

Comentários

Exemplos

name

Valor da propriedade

Comentários

Exemplos

series

Valor da propriedade

Comentários

title

Valor da propriedade

Comentários

top

Valor da propriedade

Comentários

width

Valor da propriedade

Comentários

worksheet

Valor da propriedade

Comentários

Detalhes do método

delete()

Retornos

Comentários

Exemplos

getImage(width, height, fittingMode)

Parâmetros

Retornos

Comentários

Exemplos

getImage(width, height, fittingModeString)

Parâmetros

Retornos

Comentários

load(options)

Parâmetros

Retornos

load(propertyNames)

Parâmetros

Retornos

Exemplos

load(propertyNamesAndPaths)

Parâmetros

Retornos

set(properties, options)

Parâmetros

Retornos

set(properties)

Parâmetros

Retornos

setData(sourceData, seriesBy)

Parâmetros

Retornos

Comentários