Excel.ChartAxis class

Especifica o alinhamento para a etiqueta de escala do eixo especificado. Veja Excel.ChartTextHorizontalAlignment para obter detalhes.

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

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

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Especifica a unidade base para o eixo de categoria especificado.

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Especifica o tipo de eixo de categoria.

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

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

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

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

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

readonly format: Excel.ChartAxisFormat;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

isBetweenCategories: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Especifica se o formato de número está ligado às células. Se true, o formato de número será alterado nas etiquetas quando for alterado nas células.

linkNumberFormat: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

logBase: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

readonly majorGridlines: Excel.ChartGridlines;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

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

readonly minorGridlines: Excel.ChartGridlines;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Especifica se um eixo tem múltiplos níveis.

multiLevel: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Especifica o código de formato para a etiqueta de escala do eixo.

numberFormat: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Especifica a distância entre os níveis de etiquetas 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

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

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

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Especifica a posição do eixo em que o outro eixo se cruza. Deve utilizar o SetPositionAt(double) método para definir esta propriedade.

readonly positionAt: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

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

reversePlotOrder: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

showDisplayUnitLabel: boolean;

Valor da propriedade

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

Especifica o ângulo para o qual o texto está orientado para a etiqueta de escala do eixo do gráfico. O valor deve ser um número inteiro de -90 a 90 ou o número inteiro 180 para texto orientado verticalmente.

textOrientation: any;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

tickMarkSpacing: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Representa o título do eixo.

readonly title: Excel.ChartAxisTitle;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Especifica se o eixo está visível.

visible: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

Retornos

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

Retornos

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

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

Retornos

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

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Excel.ChartAxis): void;

Parâmetros

Retornos

Define todos os nomes de categoria para o eixo especificado.

setCategoryNames(sourceData: Range): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

setCustomDisplayUnit(value: number): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

setPositionAt(value: number): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

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 Excel.ChartAxis original é 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