Compartilhar via

Excel.ChartAxis class

  • Referência
Pacote:
excel

Representa um único eixo em um gráfico.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Propriedades

axisGroup

Especifica o grupo para o eixo especificado. Veja Excel.ChartAxisGroup para obter detalhes.
baseTimeUnit

Especifica a unidade base para o eixo de categoria especificado.
categoryType

Especifica o tipo de eixo de categoria.
context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
customDisplayUnit

Especifica o valor de unidade de apresentação do eixo personalizado. Para definir esta propriedade, utilize o SetCustomDisplayUnit(double) método .
displayUnit

Representa a unidade de exibição de eixo. Veja Excel.ChartAxisDisplayUnit para obter detalhes.
format

Representa a formatação de um objeto Chart, que inclui formatação de linha e de fonte.
height

Especifica a altura, em pontos, do eixo do gráfico. Devolve null se o eixo não estiver visível.
left

Especifica a distância, em pontos, da margem esquerda do eixo à esquerda da área do gráfico. Devolve null se o eixo não estiver visível.
logBase

Especifica a base do logaritmo ao utilizar escalas logarítmicas.
majorGridlines

Devolve um objeto que representa as principais linhas de grelha do eixo especificado.
majorTickMark

Especifica o tipo de marca de escala principal para o eixo especificado. Veja Excel.ChartAxisTickMark para obter detalhes.
majorTimeUnitScale

Especifica o valor de escala de unidades principal para o eixo de categoria quando a categoryType propriedade está definida como dateAxis.
majorUnit

Representa o intervalo entre as duas principais marcas de escala. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia. O valor retornado sempre é um número.
maximum

Representa o valor máximo no eixo dos valores. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número.
minimum

Representa o valor mínimo no eixo dos valores. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número.
minorGridlines

Devolve um objeto que representa as linhas de grelha secundárias do eixo especificado.
minorTickMark

Especifica o tipo de marca de escala secundária para o eixo especificado. Veja Excel.ChartAxisTickMark para obter detalhes.
minorTimeUnitScale

Especifica o valor de escala de unidade secundária para o eixo de categoria quando a categoryType propriedade está definida como dateAxis.
minorUnit

Representa o intervalo entre as duas marcas de escala secundárias. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número.
reversePlotOrder

Especifica se o Excel desenha pontos de dados do último ao primeiro.
scaleType

Especifica o tipo de escala do eixo de valores. Veja Excel.ChartAxisScaleType para obter detalhes.
showDisplayUnitLabel

Especifica se a etiqueta da unidade de apresentação do eixo está visível.
tickLabelPosition

Especifica a posição dos rótulos de marcas de escala no eixo especificado. Veja Excel.ChartAxisTickLabelPosition para obter detalhes.
tickLabelSpacing

Especifica o número de categorias ou séries entre etiquetas de marca de escala. Pode ser um valor de 1 a 31999 ou uma cadeia de caracteres vazia para configuração automática. O valor retornado sempre é um número.
tickMarkSpacing

Especifica o número de categorias ou séries entre marcas de escala.
title

Representa o título do eixo.
top

Especifica a distância, em pontos, da margem superior do eixo para a parte superior da área do gráfico. Devolve null se o eixo não estiver visível.
type

Especifica o tipo de eixo. Veja Excel.ChartAxisType para obter detalhes.
visible

Especifica se o eixo está visível.
width

Especifica a largura, em pontos, do eixo do gráfico. Devolve null se o eixo não estiver visível.

Métodos

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.
setCategoryNames(sourceData)

Define todos os nomes de categoria para o eixo especificado.
setCustomDisplayUnit(value)

Definirá a unidade de exibição de eixo a um valor personalizado.
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.ChartAxis é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartAxisData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

axisGroup

Especifica o grupo para o eixo especificado. Veja Excel.ChartAxisGroup para obter detalhes.

readonly axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary";

Valor da propriedade

Excel.ChartAxisGroup | "Primary" | "Secondary"

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

baseTimeUnit

Especifica a unidade base para o eixo de categoria especificado.

baseTimeUnit: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

Valor da propriedade

Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

categoryType

Especifica o tipo de eixo de categoria.

categoryType: Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis";

Valor da propriedade

Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis"

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

customDisplayUnit

Especifica o valor de unidade de apresentação do eixo personalizado. Para definir esta propriedade, utilize o SetCustomDisplayUnit(double) método .

readonly customDisplayUnit: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

displayUnit

Representa a unidade de exibição de eixo. Veja Excel.ChartAxisDisplayUnit para obter detalhes.

displayUnit: Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom";

Valor da propriedade

Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom"

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-axis.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    let chart = sheet.charts.getItemAt(0);
    let categoryAxis = chart.axes.categoryAxis;
    let valueAxis = chart.axes.valueAxis;

    // Load to get display unit.
    valueAxis.load("displayUnit");

    await context.sync();

    console.log("The vertical axis display unit is: " + valueAxis.displayUnit);
});

format

Representa a formatação de um objeto Chart, que inclui formatação de linha e de fonte.

readonly format: Excel.ChartAxisFormat;

Valor da propriedade

Excel.ChartAxisFormat

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

height

Especifica a altura, em pontos, do eixo do gráfico. Devolve null se o eixo não estiver visível.

readonly height: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

left

Especifica a distância, em pontos, da margem esquerda do eixo à esquerda da área do gráfico. Devolve null se o eixo não estiver visível.

readonly left: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

logBase

Especifica a base do logaritmo ao utilizar escalas logarítmicas.

logBase: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

majorGridlines

Devolve um objeto que representa as principais linhas de grelha do eixo especificado.

readonly majorGridlines: Excel.ChartGridlines;

Valor da propriedade

Excel.ChartGridlines

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

majorTickMark

Especifica o tipo de marca de escala principal para o eixo especificado. Veja Excel.ChartAxisTickMark para obter detalhes.

majorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside";

Valor da propriedade

Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

majorTimeUnitScale

Especifica o valor de escala de unidades principal para o eixo de categoria quando a categoryType propriedade está definida como dateAxis.

majorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

Valor da propriedade

Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

majorUnit

Representa o intervalo entre as duas principais marcas de escala. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia. O valor retornado sempre é um número.

majorUnit: any;

Valor da propriedade

any

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

maximum

Representa o valor máximo no eixo dos valores. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número.

maximum: any;

Valor da propriedade

any

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

minimum

Representa o valor mínimo no eixo dos valores. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número.

minimum: any;

Valor da propriedade

any

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

minorGridlines

Devolve um objeto que representa as linhas de grelha secundárias do eixo especificado.

readonly minorGridlines: Excel.ChartGridlines;

Valor da propriedade

Excel.ChartGridlines

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

minorTickMark

Especifica o tipo de marca de escala secundária para o eixo especificado. Veja Excel.ChartAxisTickMark para obter detalhes.

minorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside";

Valor da propriedade

Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

minorTimeUnitScale

Especifica o valor de escala de unidade secundária para o eixo de categoria quando a categoryType propriedade está definida como dateAxis.

minorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

Valor da propriedade

Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

minorUnit

Representa o intervalo entre as duas marcas de escala secundárias. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número.

minorUnit: any;

Valor da propriedade

any

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

reversePlotOrder

Especifica se o Excel desenha pontos de dados do último ao primeiro.

reversePlotOrder: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

scaleType

Especifica o tipo de escala do eixo de valores. Veja Excel.ChartAxisScaleType para obter detalhes.

scaleType: Excel.ChartAxisScaleType | "Linear" | "Logarithmic";

Valor da propriedade

Excel.ChartAxisScaleType | "Linear" | "Logarithmic"

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

showDisplayUnitLabel

Especifica se a etiqueta da unidade de apresentação do eixo está visível.

showDisplayUnitLabel: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-axis.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    let chart = sheet.charts.getItemAt(0);
    let axis = chart.axes.valueAxis;

    // Remove display unit.
    axis.showDisplayUnitLabel = false;

    await context.sync();
});

tickLabelPosition

Especifica a posição dos rótulos de marcas de escala no eixo especificado. Veja Excel.ChartAxisTickLabelPosition para obter detalhes.

tickLabelPosition: Excel.ChartAxisTickLabelPosition | "NextToAxis" | "High" | "Low" | "None";

Valor da propriedade

Excel.ChartAxisTickLabelPosition | "NextToAxis" | "High" | "Low" | "None"

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

tickLabelSpacing

Especifica o número de categorias ou séries entre etiquetas de marca de escala. Pode ser um valor de 1 a 31999 ou uma cadeia de caracteres vazia para configuração automática. O valor retornado sempre é um número.

tickLabelSpacing: any;

Valor da propriedade

any

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

tickMarkSpacing

Especifica o número de categorias ou séries entre marcas de escala.

tickMarkSpacing: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

title

Representa o título do eixo.

readonly title: Excel.ChartAxisTitle;

Valor da propriedade

Excel.ChartAxisTitle

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

top

Especifica a distância, em pontos, da margem superior do eixo para a parte superior da área do gráfico. Devolve null se o eixo não estiver visível.

readonly top: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

type

Especifica o tipo de eixo. Veja Excel.ChartAxisType para obter detalhes.

readonly type: Excel.ChartAxisType | "Invalid" | "Category" | "Value" | "Series";

Valor da propriedade

Excel.ChartAxisType | "Invalid" | "Category" | "Value" | "Series"

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

visible

Especifica se o eixo está visível.

visible: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

width

Especifica a largura, em pontos, do eixo do gráfico. Devolve null se o eixo não estiver visível.

readonly width: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Detalhes do método

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.ChartAxisLoadOptions): Excel.ChartAxis;

Parâmetros

options
Excel.Interfaces.ChartAxisLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.ChartAxis

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

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.ChartAxis

Exemplos

// Get the maximum of Chart Axis from Chart1.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    const axis = chart.axes.valueAxis;
    axis.load('maximum');
    await context.sync();

    console.log(axis.maximum);
});

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

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

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.ChartAxisUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Excel.Interfaces.ChartAxisUpdateData

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.ChartAxis): void;

Parâmetros

properties
Excel.ChartAxis

Retornos

void

setCategoryNames(sourceData)

Define todos os nomes de categoria para o eixo especificado.

setCategoryNames(sourceData: Range): void;

Parâmetros

sourceData
Excel.Range

O Range objeto correspondente aos dados de origem.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

setCustomDisplayUnit(value)

Definirá a unidade de exibição de eixo a um valor personalizado.

setCustomDisplayUnit(value: number): void;

Parâmetros

value

number

Valor personalizado da unidade de apresentação.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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.ChartAxis é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartAxisData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.ChartAxisData;

Retornos

Excel.Interfaces.ChartAxisData