Excel.Chart interface

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

Propriedades

axes

Representa os eixos de um gráfico.

categoryLabelLevel

Especifica uma constante de enumeração ChartCategoryLabelLevel referindo-se ao nível de onde os rótulos de categoria estão sendo originados.

chartType

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

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 plotArea para o 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 ChartSeriesNameLevel referindo-se ao nível de onde os nomes das séries estão sendo originados.

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 mostrados quando o valor for maior do que o valor máximo no eixo dos valores. Se o eixo dos valores tornar-se menor do que o tamanho dos pontos de dados, você poderá usar essa propriedade para definir se os rótulos de dados serão exibidos. Essa propriedade se aplica somente a gráficos 2D.

style

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

title

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

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.

getImage(width, height, fittingMode)

Processa o gráfico como uma imagem codificada em base64, dimensionando o gráfico para se ajustar às dimensões especificadas. A taxa de proporção é preservada como parte do redimensionamento.

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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.

Detalhes da propriedade

axes

Representa os eixos de um gráfico.

readonly axes: ChartAxes;

Valor da propriedade

categoryLabelLevel

Especifica uma constante de enumeração ChartCategoryLabelLevel referindo-se ao nível de onde os rótulos de categoria estão sendo originados.

categoryLabelLevel: number;

Valor da propriedade

number

chartType

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

chartType:
            | 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

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

dataLabels

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

readonly dataLabels: ChartDataLabels;

Valor da propriedade

displayBlanksAs

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

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

Valor da propriedade

| ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted"

format

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

readonly format: ChartAreaFormat;

Valor da propriedade

height

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

height: number;

Valor da propriedade

number

id

Id exclusiva do gráfico.

readonly id: string;

Valor da propriedade

string

left

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

left: number;

Valor da propriedade

number

legend

Representa a legenda do gráfico.

readonly legend: ChartLegend;

Valor da propriedade

name

Especifica o nome de um objeto de gráfico.

name: string;

Valor da propriedade

string

pivotOptions

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

readonly pivotOptions: ChartPivotOptions;

Valor da propriedade

plotArea

Representa a plotArea para o gráfico.

readonly plotArea: ChartPlotArea;

Valor da propriedade

plotBy

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

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

Valor da propriedade

ChartPlotBy | "Rows" | "Columns"

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

series

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

readonly series: ChartSeriesCollection;

Valor da propriedade

seriesNameLevel

Especifica uma constante de enumeração ChartSeriesNameLevel referindo-se ao nível de onde os nomes das séries estão sendo originados.

seriesNameLevel: number;

Valor da propriedade

number

showAllFieldButtons

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

showAllFieldButtons: boolean;

Valor da propriedade

boolean

showDataLabelsOverMaximum

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

showDataLabelsOverMaximum: boolean;

Valor da propriedade

boolean

style

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

style: number;

Valor da propriedade

number

title

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

readonly title: ChartTitle;

Valor da propriedade

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

width

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

width: number;

Valor da propriedade

number

worksheet

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

readonly worksheet: Worksheet;

Valor da propriedade

Detalhes do método

activate()

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

activate(): void;

Retornos

void

delete()

Exclui o objeto de gráfico.

delete(): void;

Retornos

void

getImage(width, height, fittingMode)

Processa o gráfico como uma imagem codificada em base64, dimensionando o gráfico para se ajustar às dimensões especificadas. A taxa de proporção é preservada como parte do redimensionamento.

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

Parâmetros

width
number

(Opcional) A largura desejada da imagem resultante.

height
number

(Opcional) A altura desejada da imagem resultante.

fittingMode
ImageFittingMode | "Fit" | "FitAndCenter" | "Fill"

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

Retornos

ClientResult<string>

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[]): void;

Parâmetros

propertyNames
string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

void

setData(sourceData, seriesBy)

Redefine os dados de origem do gráfico.

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

Parâmetros

sourceData
Range

O objeto Range correspondente aos dados de origem.

seriesBy
ChartSeriesBy | "Auto" | "Columns" | "Rows"

Especifica a forma como as colunas ou linhas são usadas como série de dados no gráfico. Pode ser uma das seguintes opções: auto (padrão), linhas e colunas. Consulte Excel. ChartSeriesBy para obter detalhes.

Retornos

void

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
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
Range | string

(Opcional) Na 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