Excel. Chart Axis class

axisGroup

Especifica o grupo para o eixo especificado. Confira Excel.ChartAxisGroup detalhes.

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

Valor da propriedade

Excel.ChartAxisGroup | "Primary" | "Secondary"

Comentários

baseTimeUnit

Especifica a unidade base do eixo de categoria especificado.

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

Valor da propriedade

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

Comentários

categoryType

Especifica o tipo de eixo de categoria.

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

Valor da propriedade

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

Comentários

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

Excel.RequestContext

customDisplayUnit

Especifica o valor da unidade de exibição de eixo personalizado. Para definir essa propriedade, use o SetCustomDisplayUnit(double) método.

readonly customDisplayUnit: number;

Valor da propriedade

number

Comentários

displayUnit

Representa a unidade de exibição de eixo. Confira Excel.ChartAxisDisplayUnit detalhes.

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

Valor da propriedade

Comentários

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

height

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

readonly height: number;

Valor da propriedade

number

Comentários

isBetweenCategories

Especifica se o eixo de valor cruza o eixo de categoria entre categorias.

isBetweenCategories: boolean;

Valor da propriedade

boolean

Comentários

left

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

readonly left: number;

Valor da propriedade

number

Comentários

linkNumberFormat

Especifica se o formato de número está vinculado às células. Se true, o formato de número será alterado nos rótulos quando ele for alterado nas células.

linkNumberFormat: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

logBase

Especifica a base do logaritmo ao usar dimensionamentos logarítmicos.

logBase: number;

Valor da propriedade

number

Comentários

majorGridlines

Retorna um objeto que representa as principais linhas de grade para o eixo especificado.

readonly majorGridlines: Excel.ChartGridlines;

Valor da propriedade

Excel.ChartGridlines

Comentários

majorTickMark

Especifica o tipo de marca de tique principal para o eixo especificado. Confira Excel.ChartAxisTickMark detalhes.

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

Valor da propriedade

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

Comentários

majorTimeUnitScale

Especifica o valor de escala de unidade principal para o eixo de categoria quando a categoryType propriedade é definida como dateAxis.

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

Valor da propriedade

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

Comentários

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

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

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

minorGridlines

Retorna um objeto que representa as linhas de grade secundárias para o eixo especificado.

readonly minorGridlines: Excel.ChartGridlines;

Valor da propriedade

Excel.ChartGridlines

Comentários

minorTickMark

Especifica o tipo de marca de tique menor para o eixo especificado. Confira Excel.ChartAxisTickMark detalhes.

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

Valor da propriedade

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

Comentários

minorTimeUnitScale

Especifica o valor de escala de unidade menor para o eixo de categoria quando a categoryType propriedade é definida como dateAxis.

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

Valor da propriedade

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

Comentários

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

multiLevel

Especifica se um eixo é multinível.

multiLevel: boolean;

Valor da propriedade

boolean

Comentários

numberFormat

Especifica o código de formato para o rótulo de tique de eixo.

numberFormat: string;

Valor da propriedade

string

Comentários

offset

Especifica a distância entre os níveis de rótulos e a distância entre o primeiro nível e a linha de eixo. O valor deve ser um inteiro de 0 a 1000.

offset: number;

Valor da propriedade

number

Comentários

position

Especifica a posição de eixo especificada em que o outro eixo se cruza. Confira Excel.ChartAxisPosition detalhes.

position: Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom";

Valor da propriedade

Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom"

Comentários

positionAt

Especifica a posição do eixo em que o outro eixo se cruza. Você deve usar o SetPositionAt(double) método para definir essa propriedade.

readonly positionAt: number;

Valor da propriedade

number

Comentários

reversePlotOrder

Especifica se o Excel plota pontos de dados de último para primeiro.

reversePlotOrder: boolean;

Valor da propriedade

boolean

Comentários

scaleType

Especifica o tipo de escala do eixo de valor. Confira Excel.ChartAxisScaleType detalhes.

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

Valor da propriedade

Excel.ChartAxisScaleType | "Linear" | "Logarithmic"

Comentários

showDisplayUnitLabel

Especifica se o rótulo da unidade de exibição do eixo está visível.

showDisplayUnitLabel: boolean;

Valor da propriedade

boolean

Comentários

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

textOrientation

Especifica o ângulo para o qual o texto é orientado para o rótulo de tique do eixo do gráfico. O valor deve ser um inteiro de -90 a 90 ou o inteiro 180 para texto orientado verticalmente.

textOrientation: any;

Valor da propriedade

any

Comentários

tickLabelPosition

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

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

Valor da propriedade

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

Comentários

tickLabelSpacing

Especifica o número de categorias ou séries entre rótulos de marca de tique-taque. 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

tickMarkSpacing

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

tickMarkSpacing: number;

Valor da propriedade

number

Comentários

title

Representa o título do eixo.

readonly title: Excel.ChartAxisTitle;

Valor da propriedade

Excel.ChartAxisTitle

Comentários

top

Especifica a distância, em pontos, da borda superior do eixo até a parte superior da área do gráfico. Retorna null se o eixo não estiver visível.

readonly top: number;

Valor da propriedade

number

Comentários

type

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

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

Valor da propriedade

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

Comentários

visible

Especifica se o eixo está visível.

visible: boolean;

Valor da propriedade

boolean

Comentários

width

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

readonly width: number;

Valor da propriedade

number

Comentários

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 quais propriedades do objeto 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

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

Excel.ChartAxis

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

Parâmetros

properties: Excel.Interfaces.ChartAxisUpdateData

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

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 exibição.

Retornos

void

Comentários

setPositionAt(value)

Define a posição de eixo especificada em que o outro eixo se cruza.

setPositionAt(value: number): void;

Parâmetros

value: number

Valor personalizado do ponto de cruzamento.

Retornos

void

Comentários