Excel. Chart Axis class

axisGroup

Especifica el grupo para el eje especificado. Vea Excel.ChartAxisGroup para más información.

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

Valor de propiedad

Excel.ChartAxisGroup | "Primary" | "Secondary"

Comentarios

baseTimeUnit

Especifica la unidad base para el eje de categorías especificado.

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

Valor de propiedad

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

Comentarios

categoryType

Especifica el tipo de eje de categoría.

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

Valor de propiedad

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

Comentarios

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

customDisplayUnit

Especifica el valor de unidad de visualización del eje personalizado. Para establecer esta propiedad, use el SetCustomDisplayUnit(double) método .

readonly customDisplayUnit: number;

Valor de propiedad

number

Comentarios

displayUnit

Representa la unidad de visualización del eje. Vea Excel.ChartAxisDisplayUnit para más información.

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

Valor de propiedad

Comentarios

Ejemplos

// 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 el formato de un objeto de gráfico, que incluye el formato de línea y de fuente.

readonly format: Excel.ChartAxisFormat;

Valor de propiedad

Excel.ChartAxisFormat

Comentarios

height

Especifica el alto, en puntos, del eje del gráfico. Devuelve null si el eje no está visible.

readonly height: number;

Valor de propiedad

number

Comentarios

isBetweenCategories

Especifica si el eje de valores cruza el eje de categorías entre categorías.

isBetweenCategories: boolean;

Valor de propiedad

boolean

Comentarios

left

Especifica la distancia, en puntos, desde el borde izquierdo del eje a la izquierda del área del gráfico. Devuelve null si el eje no está visible.

readonly left: number;

Valor de propiedad

number

Comentarios

linkNumberFormat

Especifica si el formato de número está vinculado a las celdas. Si truees , el formato numérico cambiará en las etiquetas cuando cambie en las celdas.

linkNumberFormat: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

logBase

Especifica la base del logaritmo cuando se usan escalas logarítmicas.

logBase: number;

Valor de propiedad

number

Comentarios

majorGridlines

Devuelve un objeto que representa las líneas de cuadrícula principales del eje especificado.

readonly majorGridlines: Excel.ChartGridlines;

Valor de propiedad

Excel.ChartGridlines

Comentarios

majorTickMark

Especifica el tipo de marca de graduación principal para el eje especificado. Vea Excel.ChartAxisTickMark para más información.

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

Valor de propiedad

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

Comentarios

majorTimeUnitScale

Especifica el valor de escala de unidad principal para el eje de categorías cuando la categoryType propiedad se establece en dateAxis.

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

Valor de propiedad

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

Comentarios

majorUnit

Representa el intervalo entre dos marcas de graduación principales. Puede establecerse en un valor numérico o en una cadena vacía. El valor devuelto siempre es un número.

majorUnit: any;

Valor de propiedad

any

Comentarios

maximum

Representa el valor máximo del eje de valores. Puede establecerse en un valor numérico o en una cadena vacía (para valores de eje automáticos). El valor devuelto siempre es un número.

maximum: any;

Valor de propiedad

any

Comentarios

minimum

Representa el valor mínimo del eje de valores. Puede establecerse en un valor numérico o en una cadena vacía (para valores de eje automáticos). El valor devuelto siempre es un número.

minimum: any;

Valor de propiedad

any

Comentarios

minorGridlines

Devuelve un objeto que representa las líneas de cuadrícula secundarias del eje especificado.

readonly minorGridlines: Excel.ChartGridlines;

Valor de propiedad

Excel.ChartGridlines

Comentarios

minorTickMark

Especifica el tipo de marca de graduación secundaria para el eje especificado. Vea Excel.ChartAxisTickMark para más información.

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

Valor de propiedad

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

Comentarios

minorTimeUnitScale

Especifica el valor de escala de unidad secundaria para el eje de categorías cuando la categoryType propiedad se establece en dateAxis.

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

Valor de propiedad

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

Comentarios

minorUnit

Representa el intervalo entre dos marcas de graduación secundarias. Puede establecerse en un valor numérico o en una cadena vacía (para valores de eje automáticos). El valor devuelto siempre es un número.

minorUnit: any;

Valor de propiedad

any

Comentarios

multiLevel

Especifica si un eje es de varios niveles.

multiLevel: boolean;

Valor de propiedad

boolean

Comentarios

numberFormat

Especifica el código de formato para la etiqueta de tic del eje.

numberFormat: string;

Valor de propiedad

string

Comentarios

offset

Especifica la distancia entre los niveles de etiquetas y la distancia entre el primer nivel y la línea del eje. El valor debe ser un número entero entre 0 y 1000.

offset: number;

Valor de propiedad

number

Comentarios

position

Especifica la posición del eje especificada donde se cruza el otro eje. Vea Excel.ChartAxisPosition para más información.

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

Valor de propiedad

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

Comentarios

positionAt

Especifica la posición del eje donde cruza el otro eje. Debe usar el SetPositionAt(double) método para establecer esta propiedad.

readonly positionAt: number;

Valor de propiedad

number

Comentarios

reversePlotOrder

Especifica si Excel traza los puntos de datos del último al primero.

reversePlotOrder: boolean;

Valor de propiedad

boolean

Comentarios

scaleType

Especifica el tipo de escala del eje de valores. Vea Excel.ChartAxisScaleType para más información.

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

Valor de propiedad

Excel.ChartAxisScaleType | "Linear" | "Logarithmic"

Comentarios

showDisplayUnitLabel

Especifica si la etiqueta de la unidad de visualización del eje está visible.

showDisplayUnitLabel: boolean;

Valor de propiedad

boolean

Comentarios

Ejemplos

// 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 el ángulo al que está orientado el texto para la etiqueta de tic del eje del gráfico. El valor debe ser un entero de -90 a 90 o el entero 180 para texto orientado verticalmente.

textOrientation: any;

Valor de propiedad

any

Comentarios

tickLabelPosition

Especifica la posición de los rótulos de marcas de graduación en el eje especificado. Vea Excel.ChartAxisTickLabelPosition para más información.

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

Valor de propiedad

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

Comentarios

tickLabelSpacing

Especifica el número de categorías o series entre etiquetas de marca de graduación. Puede ser un valor de 1 a 31 999 o una cadena vacía para configuración automática. El valor devuelto siempre es un número.

tickLabelSpacing: any;

Valor de propiedad

any

Comentarios

tickMarkSpacing

Especifica el número de categorías o series entre marcas de graduación.

tickMarkSpacing: number;

Valor de propiedad

number

Comentarios

title

Representa el título del eje.

readonly title: Excel.ChartAxisTitle;

Valor de propiedad

Excel.ChartAxisTitle

Comentarios

top

Especifica la distancia, en puntos, desde el borde superior del eje hasta la parte superior del área del gráfico. Devuelve null si el eje no está visible.

readonly top: number;

Valor de propiedad

number

Comentarios

type

Especifica el tipo de eje. Vea Excel.ChartAxisType para más información.

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

Valor de propiedad

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

Comentarios

visible

Especifica si el eje está visible.

visible: boolean;

Valor de propiedad

boolean

Comentarios

width

Especifica el ancho, en puntos, del eje del gráfico. Devuelve null si el eje no está visible.

readonly width: number;

Valor de propiedad

number

Comentarios

Detalles del método

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.ChartAxisLoadOptions): Excel.ChartAxis;

Parámetros

options: Excel.Interfaces.ChartAxisLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.ChartAxis

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): Excel.ChartAxis;

Parámetros

propertyNames: string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.ChartAxis

Ejemplos

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

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ChartAxis;

Parámetros

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

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.ChartAxis

set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

set(properties: Interfaces.ChartAxisUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties: Excel.Interfaces.ChartAxisUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options: OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Excel.ChartAxis): void;

Parámetros

properties: Excel.ChartAxis

Devoluciones

void

setCategoryNames(sourceData)

Establece todos los nombres de categoría del eje especificado.

setCategoryNames(sourceData: Range): void;

Parámetros

sourceData: Excel.Range

Objeto Range correspondiente a los datos de origen.

Devoluciones

void

Comentarios

setCustomDisplayUnit(value)

Establece la unidad de visualización de ejes en un valor personalizado.

setCustomDisplayUnit(value: number): void;

Parámetros

value: number

Valor personalizado de la unidad de visualización.

Devoluciones

void

Comentarios

setPositionAt(value)

Establece la posición del eje especificada donde se cruza el otro eje.

setPositionAt(value: number): void;

Parámetros

value: number

Valor personalizado del punto de cruce.

Devoluciones

void

Comentarios