Excel.ChartAxes class

Representa os eixos de um gráfico.

Extends

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Propriedades

categoryAxis

Representa o eixo de categoria em um gráfico.

context

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

seriesAxis

Representa o eixo da série de um gráfico 3D.

valueAxis

Representa o eixo dos valores em um eixo.

Métodos

getItem(type, group)

Retorna o eixo específico identificado por tipo e grupo.

getItem(typeString, groupString)

Retorna o eixo específico identificado por tipo e grupo.

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.

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.ChartAxes original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartAxesData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

categoryAxis

Representa o eixo de categoria em um gráfico.

readonly categoryAxis: Excel.ChartAxis;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

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

seriesAxis

Representa o eixo da série de um gráfico 3D.

readonly seriesAxis: Excel.ChartAxis;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

valueAxis

Representa o eixo dos valores em um eixo.

readonly valueAxis: Excel.ChartAxis;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

// Set the maximum, minimum, majorUnit, minorUnit of valueAxis.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.axes.valueAxis.maximum = 5;
    chart.axes.valueAxis.minimum = 0;
    chart.axes.valueAxis.majorUnit = 1;
    chart.axes.valueAxis.minorUnit = 0.2;
    await context.sync();

    console.log("Axis Settings Changed");
});

Detalhes do método

getItem(type, group)

Retorna o eixo específico identificado por tipo e grupo.

getItem(type: Excel.ChartAxisType, group?: Excel.ChartAxisGroup): Excel.ChartAxis;

Parâmetros

type
Excel.ChartAxisType

Especifica o tipo de eixo. Confira Excel.ChartAxisType detalhes.

group
Excel.ChartAxisGroup

Opcional. Especifica o grupo de eixos. Confira Excel.ChartAxisGroup detalhes.

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

getItem(typeString, groupString)

Retorna o eixo específico identificado por tipo e grupo.

getItem(typeString: "Invalid" | "Category" | "Value" | "Series", groupString?: "Primary" | "Secondary"): Excel.ChartAxis;

Parâmetros

typeString

"Invalid" | "Category" | "Value" | "Series"

Especifica o tipo de eixo. Confira Excel.ChartAxisType detalhes.

groupString

"Primary" | "Secondary"

Opcional. Especifica o grupo de eixos. Confira Excel.ChartAxisGroup detalhes.

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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.ChartAxesLoadOptions): Excel.ChartAxes;

Parâmetros

options
Excel.Interfaces.ChartAxesLoadOptions

Fornece opções para quais propriedades do objeto carregar.

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

Parâmetros

propertyNames

string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam 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.ChartAxes;

Parâmetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas 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.ChartAxesUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Excel.Interfaces.ChartAxesUpdateData

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 properties tentar definir quaisquer 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.ChartAxes): void;

Parâmetros

properties
Excel.ChartAxes

Retornos

void

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.ChartAxes original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartAxesData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.ChartAxesData;

Retornos