Excel.Chart class

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

Extends

Comentários

[Conjunto de apis: ExcelApi 1.1]

Propriedades

axes

Representa os eixos de um gráfico.

categoryLabelLevel

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.

chartType

Especifica o tipo do gráfico. Consulte Excel.ChartType para obter detalhes.

context

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

dataLabels

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

displayBlanksAs

Especifica a maneira como as células em branco são plotadas em um 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 plotagem 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 de nível de nome de série de gráfico, referindo-se ao nível dos nomes de série de origem.

showAllFieldButtons

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

showDataLabelsOverMaximum

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.

style

Especifica o estilo do 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, 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).

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, ele lançará uma exceção.

getDataTableOrNullObject()

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.

getImage(width, height, fittingMode)

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, height, fittingMode)

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.

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. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties)

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

setData(sourceData, seriesBy)

Redefine os dados de origem do gráfico.

setData(sourceData, seriesBy)

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

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

Comentários

[Conjunto de apis: ExcelApi 1.1]

categoryLabelLevel

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

number

Comentários

[Conjunto de apis: ExcelApi 1.8]

chartType

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";

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 apis: ExcelApi 1.7]

context

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

dataLabels

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

readonly dataLabels: Excel.ChartDataLabels;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.1]

displayBlanksAs

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

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

Comentários

[Conjunto de apis: ExcelApi 1.8]

format

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]

height

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

height: number;

Valor da propriedade

number

Comentários

[Conjunto de apis: ExcelApi 1.1]

id

Id exclusiva do gráfico.

readonly id: string;

Valor da propriedade

string

Comentários

[Conjunto de apis: 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 apis: ExcelApi 1.1]

legend

Representa a legenda do gráfico.

readonly legend: Excel.ChartLegend;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.1]

name

Especifica o nome de um objeto de gráfico.

name: string;

Valor da propriedade

string

Comentários

[Conjunto de apis: ExcelApi 1.1]

pivotOptions

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]

plotArea

Representa a área de plotagem do gráfico.

readonly plotArea: Excel.ChartPlotArea;

Valor da propriedade

Comentários

[Conjunto de apis: 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 apis: 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 apis: 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

Comentários

[Conjunto de apis: ExcelApi 1.1]

seriesNameLevel

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

number

Comentários

[Conjunto de apis: ExcelApi 1.8]

showAllFieldButtons

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

showAllFieldButtons: boolean;

Valor da propriedade

boolean

Comentários

[Conjunto de apis: ExcelApi 1.7]

showDataLabelsOverMaximum

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

boolean

Comentários

[Conjunto de apis: ExcelApi 1.8]

style

Especifica o estilo do gráfico.

style: number;

Valor da propriedade

number

Comentários

[Conjunto de apis: 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

Comentários

[Conjunto de apis: ExcelApi 1.1]

top

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

number

Comentários

[Conjunto de apis: ExcelApi 1.1]

width

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

width: number;

Valor da propriedade

number

Comentários

[Conjunto de apis: ExcelApi 1.1]

worksheet

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

readonly worksheet: Excel.Worksheet;

Valor da propriedade

Comentários

[Conjunto de apis: 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 apis: ExcelApi 1.9]

delete()

Exclui o objeto de gráfico.

delete(): void;

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.1]

getDataTable()

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]

getDataTableOrNullObject()

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]

getImage(width, height, fittingMode)

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

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 usado para dimensionar o gráfico para as dimensões especificadas (se a altura e a largura estiverem definidas).

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.2]

getImage(width, height, fittingMode)

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

width

number

Opcional. A largura desejada da imagem resultante.

height

number

Opcional. A altura desejada da imagem resultante.

fittingMode

"Fit" | "FitAndCenter" | "Fill"

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

Retornos

Comentários

[Conjunto de apis: 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 quais propriedades do objeto devem ser carregadas.

Retornos

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 de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.

Retornos

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 de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.

Retornos

set(properties, options)

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

properties
Excel.Interfaces.ChartUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente 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 propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um 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 (padrão), Linhas e Colunas. Consulte Excel.ChartSeriesBy para obter detalhes.

Retornos

void

Comentários

[Conjunto de apis: ExcelApi 1.1]

setData(sourceData, seriesBy)

Redefine os dados de origem do gráfico.

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

Parâmetros

sourceData
Excel.Range

O objeto de intervalo correspondente aos dados de origem.

seriesBy

"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 (padrão), Linhas e Colunas. Consulte Excel.ChartSeriesBy para obter detalhes.

Retornos

void

Comentários

[Conjunto de apis: 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 apis: ExcelApi 1.1]

toJSON()

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

Detalhes do evento

onActivated

Ocorre quando o gráfico é ativado.

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

Tipo de Evento

Comentários

[Conjunto de apis: ExcelApi 1.8]

onDeactivated

Ocorre quando o gráfico é desativado.

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

Tipo de Evento

Comentários

[Conjunto de apis: ExcelApi 1.8]