Excel.ChartAxis interface

Representa um único eixo em um gráfico.

Propriedades

alignment

Especifica o alinhamento para o rótulo de escala do eixo especificado. Consulte Excel. ChartTextHorizontalAlignment para obter detalhes.

axisGroup

Especifica o grupo do eixo especificado. Consulte Excel. ChartAxisGroup para obter detalhes.

baseTimeUnit

Especifica a unidade base do eixo de categoria especificado.

categoryType

Especifica o tipo de eixo das categorias.

customDisplayUnit

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

displayUnit

Representa a unidade de exibição de eixo. Consulte 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. Nulo se o eixo não estiver visível.

isBetweenCategories

Especifica se o eixo dos valores cruza o eixo das categorias entre categorias.

left

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

linkNumberFormat

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

logBase

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

majorGridlines

Retorna um objeto Gridlines que representa as principais linhas de grade do eixo especificado.

majorTickMark

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

majorTimeUnitScale

Especifica o valor de escala de unidades principal para o eixo de categoria quando a Propriedade CategoryType estiver definida como escala de valores.

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

Retorna um objeto Gridlines que representa as linhas de grade secundárias do eixo especificado.

minorTickMark

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

minorTimeUnitScale

Especifica o valor de escala de unidades secundária para o eixo de categoria quando a Propriedade CategoryType estiver definida como escala de valores.

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.

multiLevel

Especifica se um eixo é de vários níveis.

numberFormat

Especifica o código de formatação para o rótulo de escala de eixo.

offset

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

position

Especifica a posição do eixo especificado onde o outro eixo cruza. Consulte Excel. ChartAxisPosition para obter detalhes.

positionAt

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

reversePlotOrder

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

scaleType

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

showDisplayUnitLabel

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

textOrientation

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

tickLabelPosition

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

tickLabelSpacing

Especifica o número de categorias ou séries entre os rótulos 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 borda superior do eixo até a parte superior da área do gráfico. Nulo se o eixo não estiver visível.

type

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

visible

Especifica se o eixo está visível.

width

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

Métodos

load(propertyNames)

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

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.

setPositionAt(value)

Define a posição do eixo especificado onde o outro eixo cruza.

Detalhes da propriedade

alignment

Especifica o alinhamento para o rótulo de escala do eixo especificado. Consulte Excel. ChartTextHorizontalAlignment para obter detalhes.

alignment: ChartTickLabelAlignment | "Center" | "Left" | "Right";

Valor da propriedade

ChartTickLabelAlignment | "Center" | "Left" | "Right"

axisGroup

Especifica o grupo do eixo especificado. Consulte Excel. ChartAxisGroup para obter detalhes.

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

Valor da propriedade

ChartAxisGroup | "Primary" | "Secondary"

baseTimeUnit

Especifica a unidade base do eixo de categoria especificado.

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

Valor da propriedade

ChartAxisTimeUnit | "Days" | "Months" | "Years"

categoryType

Especifica o tipo de eixo das categorias.

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

Valor da propriedade

| ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis"

customDisplayUnit

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

readonly customDisplayUnit: number;

Valor da propriedade

number

displayUnit

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

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

Valor da propriedade

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

Exemplos

async function main(context: Excel.RequestContext) {
    let 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: ChartAxisFormat;

Valor da propriedade

height

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

readonly height: number;

Valor da propriedade

number

isBetweenCategories

Especifica se o eixo dos valores cruza o eixo das categorias entre categorias.

isBetweenCategories: boolean;

Valor da propriedade

boolean

left

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

readonly left: number;

Valor da propriedade

number

linkNumberFormat

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

linkNumberFormat: boolean;

Valor da propriedade

boolean

logBase

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

logBase: number;

Valor da propriedade

number

majorGridlines

Retorna um objeto Gridlines que representa as principais linhas de grade do eixo especificado.

readonly majorGridlines: ChartGridlines;

Valor da propriedade

majorTickMark

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

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

Valor da propriedade

| ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"

majorTimeUnitScale

Especifica o valor de escala de unidades principal para o eixo de categoria quando a Propriedade CategoryType estiver definida como escala de valores.

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

Valor da propriedade

ChartAxisTimeUnit | "Days" | "Months" | "Years"

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

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

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

minorGridlines

Retorna um objeto Gridlines que representa as linhas de grade secundárias do eixo especificado.

readonly minorGridlines: ChartGridlines;

Valor da propriedade

minorTickMark

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

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

Valor da propriedade

| ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"

minorTimeUnitScale

Especifica o valor de escala de unidades secundária para o eixo de categoria quando a Propriedade CategoryType estiver definida como escala de valores.

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

Valor da propriedade

ChartAxisTimeUnit | "Days" | "Months" | "Years"

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

multiLevel

Especifica se um eixo é de vários níveis.

multiLevel: boolean;

Valor da propriedade

boolean

numberFormat

Especifica o código de formatação para o rótulo de escala de eixo.

numberFormat: string;

Valor da propriedade

string

offset

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

offset: number;

Valor da propriedade

number

position

Especifica a posição do eixo especificado onde o outro eixo cruza. Consulte Excel. ChartAxisPosition para obter detalhes.

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

Valor da propriedade

| ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom"

positionAt

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

readonly positionAt: number;

Valor da propriedade

number

reversePlotOrder

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

reversePlotOrder: boolean;

Valor da propriedade

boolean

scaleType

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

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

Valor da propriedade

ChartAxisScaleType | "Linear" | "Logarithmic"

showDisplayUnitLabel

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

showDisplayUnitLabel: boolean;

Valor da propriedade

boolean

Exemplos

async function main(context: Excel.RequestContext) {
    let 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 no qual o texto é orientado para o rótulo de escala 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

tickLabelPosition

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

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

Valor da propriedade

| ChartAxisTickLabelPosition | "NextToAxis" | "High" | "Low" | "None"

tickLabelSpacing

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

tickMarkSpacing

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

tickMarkSpacing: number;

Valor da propriedade

number

title

Representa o título do eixo.

readonly title: ChartAxisTitle;

Valor da propriedade

top

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

readonly top: number;

Valor da propriedade

number

type

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

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

Valor da propriedade

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

visible

Especifica se o eixo está visível.

visible: boolean;

Valor da propriedade

boolean

width

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

readonly width: number;

Valor da propriedade

number

Detalhes do método

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

setCategoryNames(sourceData)

Define todos os nomes de categoria para o eixo especificado.

setCategoryNames(sourceData: Range): void;

Parâmetros

sourceData
Range

O objeto Range correspondente aos dados de origem.

Retornos

void

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

setPositionAt(value)

Define a posição do eixo especificado onde o outro eixo cruza.

setPositionAt(value: number): void;

Parâmetros

value
number

Valor personalizado das cruzadas às

Retornos

void