Excel.ChartAxis class
Representa un solo eje de un gráfico.
- Extends
Comentarios
[Conjunto de API: ExcelApi 1.1]
Propiedades
| alignment | Especifica la alineación de la etiqueta de marca de eje especificada. Consulte |
| axis |
Especifica el grupo del eje especificado. Vea |
| base |
Especifica la unidad base para el eje de categoría especificado. |
| category |
Especifica el tipo de eje de categoría. |
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| custom |
Especifica el valor de unidad de visualización del eje personalizado. Para establecer esta propiedad, use el |
| display |
Representa la unidad de visualización del eje. Vea |
| format | Representa el formato de un objeto de gráfico, que incluye el formato de línea y de fuente. |
| height | Especifica la altura, en puntos, del eje del gráfico. Devuelve |
| is |
Especifica si el eje de valores cruza el eje de categoría entre categorías. |
| left | Especifica la distancia, en puntos, desde el borde izquierdo del eje hasta la izquierda del área del gráfico. Devuelve |
| link |
Especifica si el formato de número está vinculado a las celdas. Si |
| log |
Especifica la base del logaritmo cuando se usan escalas logarítmicas. |
| major |
Devuelve un objeto que representa las líneas de cuadrícula principales del eje especificado. |
| major |
Especifica el tipo de marca de graduación principal para el eje especificado. Vea |
| major |
Especifica el valor de escala de unidad principal para el eje de categoría cuando la |
| major |
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. |
| 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. |
| 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. |
| minor |
Devuelve un objeto que representa las líneas de cuadrícula secundarias del eje especificado. |
| minor |
Especifica el tipo de marca de graduación menor para el eje especificado. Vea |
| minor |
Especifica el valor de escala de unidades secundarias para el eje de categoría cuando la |
| minor |
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. |
| multi |
Especifica si un eje es multinivel. |
| number |
Especifica el código de formato de la etiqueta de marca de verificación del eje. |
| offset | Especifica la distancia entre los niveles de etiquetas y la distancia entre el primer nivel y la línea de eje. El valor debe ser un número entero entre 0 y 1000. |
| position | Especifica la posición del eje especificada en la que se cruza el otro eje. Vea |
| position |
Especifica la posición del eje en el que se cruza el otro eje. Debe utilizar el |
| reverse |
Especifica si Excel traza puntos de datos del último al primero. |
| scale |
Especifica el tipo de escala del eje de valores. Vea |
| show |
Especifica si la etiqueta de unidad de visualización del eje está visible. |
| text |
Especifica el ángulo en el que se orienta el texto para la etiqueta de marca de verificación del eje del gráfico. El valor debe ser un entero entre -90 y 90 o el entero 180 para el texto orientado verticalmente. |
| tick |
Especifica la posición de los rótulos de marcas de graduación en el eje especificado. Vea |
| tick |
Especifica el número de categorías o series entre las etiquetas de las marcas 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. |
| tick |
Especifica el número de categorías o series entre las marcas de graduación. |
| title | Representa el título del eje. |
| top | Especifica la distancia, en puntos, desde el borde superior del eje hasta la parte superior del área del gráfico. Devuelve |
| type | Especifica el tipo de eje. Vea |
| visible | Especifica si el eje está visible. |
| width | Especifica el ancho, en puntos, del eje del gráfico. Devuelve |
Métodos
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| 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 API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente. |
| set |
Establece todos los nombres de categoría del eje especificado. |
| set |
Establece la unidad de visualización de ejes en un valor personalizado. |
| set |
Establece la posición del eje especificada en la que se cruza el otro eje. |
| toJSON() | Reemplaza el método JavaScript |
Detalles de las propiedades
alignment
Especifica la alineación de la etiqueta de marca de eje especificada. Consulte Excel.ChartTextHorizontalAlignment para obtener más detalles.
alignment: Excel.ChartTickLabelAlignment | "Center" | "Left" | "Right";
Valor de propiedad
Excel.ChartTickLabelAlignment | "Center" | "Left" | "Right"
Comentarios
[Conjunto de API: ExcelApi 1.8]
axisGroup
Especifica el grupo del eje especificado. Vea Excel.ChartAxisGroup para más información.
readonly axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary";
Valor de propiedad
Excel.ChartAxisGroup | "Primary" | "Secondary"
Comentarios
[Conjunto de API: ExcelApi 1.7]
baseTimeUnit
Especifica la unidad base para el eje de categoría especificado.
baseTimeUnit: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";
Valor de propiedad
Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"
Comentarios
[Conjunto de API: ExcelApi 1.7]
categoryType
Especifica el tipo de eje de categoría.
categoryType: Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis";
Valor de propiedad
Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis"
Comentarios
[Conjunto de API: ExcelApi 1.7]
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;
Valor de propiedad
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
[Conjunto de API: ExcelApi 1.7]
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
Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom"
Comentarios
[Conjunto de API: ExcelApi 1.7]
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
Comentarios
[Conjunto de API: ExcelApi 1.1]
height
Especifica la altura, en puntos, del eje del gráfico. Devuelve null si el eje no está visible.
readonly height: number;
Valor de propiedad
number
Comentarios
[Conjunto de API: ExcelApi 1.7]
isBetweenCategories
Especifica si el eje de valores cruza el eje de categoría entre categorías.
isBetweenCategories: boolean;
Valor de propiedad
boolean
Comentarios
[Conjunto de API: ExcelApi 1.8]
left
Especifica la distancia, en puntos, desde el borde izquierdo del eje hasta la izquierda del área del gráfico. Devuelve null si el eje no está visible.
readonly left: number;
Valor de propiedad
number
Comentarios
[Conjunto de API: ExcelApi 1.7]
linkNumberFormat
Especifica si el formato de número está vinculado a las celdas. Si true, el formato de número 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
[Conjunto de API: ExcelApi 1.7]
majorGridlines
Devuelve un objeto que representa las líneas de cuadrícula principales del eje especificado.
readonly majorGridlines: Excel.ChartGridlines;
Valor de propiedad
Comentarios
[Conjunto de API: ExcelApi 1.1]
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
[Conjunto de API: ExcelApi 1.7]
majorTimeUnitScale
Especifica el valor de escala de unidad principal para el eje de categoría cuando la categoryType propiedad se establece en dateAxis.
majorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";
Valor de propiedad
Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"
Comentarios
[Conjunto de API: ExcelApi 1.7]
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
[Conjunto de API: ExcelApi 1.1]
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
[Conjunto de API: ExcelApi 1.1]
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
[Conjunto de API: ExcelApi 1.1]
minorGridlines
Devuelve un objeto que representa las líneas de cuadrícula secundarias del eje especificado.
readonly minorGridlines: Excel.ChartGridlines;
Valor de propiedad
Comentarios
[Conjunto de API: ExcelApi 1.1]
minorTickMark
Especifica el tipo de marca de graduación menor 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
[Conjunto de API: ExcelApi 1.7]
minorTimeUnitScale
Especifica el valor de escala de unidades secundarias para el eje de categoría cuando la categoryType propiedad se establece en dateAxis.
minorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";
Valor de propiedad
Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"
Comentarios
[Conjunto de API: ExcelApi 1.7]
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
[Conjunto de API: ExcelApi 1.1]
multiLevel
Especifica si un eje es multinivel.
multiLevel: boolean;
Valor de propiedad
boolean
Comentarios
[Conjunto de API: ExcelApi 1.8]
numberFormat
Especifica el código de formato de la etiqueta de marca de verificación del eje.
numberFormat: string;
Valor de propiedad
string
Comentarios
[Conjunto de API: ExcelApi 1.8]
offset
Especifica la distancia entre los niveles de etiquetas y la distancia entre el primer nivel y la línea de eje. El valor debe ser un número entero entre 0 y 1000.
offset: number;
Valor de propiedad
number
Comentarios
[Conjunto de API: ExcelApi 1.8]
position
Especifica la posición del eje especificada en la que 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
[Conjunto de API: ExcelApi 1.8]
positionAt
Especifica la posición del eje en el que se cruza el otro eje. Debe utilizar el SetPositionAt(double) método para establecer esta propiedad.
readonly positionAt: number;
Valor de propiedad
number
Comentarios
[Conjunto de API: ExcelApi 1.8]
reversePlotOrder
Especifica si Excel traza puntos de datos del último al primero.
reversePlotOrder: boolean;
Valor de propiedad
boolean
Comentarios
[Conjunto de API: ExcelApi 1.7]
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
[Conjunto de API: ExcelApi 1.7]
showDisplayUnitLabel
Especifica si la etiqueta de unidad de visualización del eje está visible.
showDisplayUnitLabel: boolean;
Valor de propiedad
boolean
Comentarios
[Conjunto de API: ExcelApi 1.7]
textOrientation
Especifica el ángulo en el que se orienta el texto para la etiqueta de marca de verificación del eje del gráfico. El valor debe ser un entero entre -90 y 90 o el entero 180 para el texto orientado verticalmente.
textOrientation: any;
Valor de propiedad
any
Comentarios
[Conjunto de API: ExcelApi 1.8]
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
[Conjunto de API: ExcelApi 1.7]
tickLabelSpacing
Especifica el número de categorías o series entre las etiquetas de las marcas 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
[Conjunto de API: ExcelApi 1.7]
tickMarkSpacing
Especifica el número de categorías o series entre las marcas de graduación.
tickMarkSpacing: number;
Valor de propiedad
number
Comentarios
[Conjunto de API: ExcelApi 1.7]
title
Representa el título del eje.
readonly title: Excel.ChartAxisTitle;
Valor de propiedad
Comentarios
[Conjunto de API: ExcelApi 1.1]
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
[Conjunto de API: ExcelApi 1.7]
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
[Conjunto de API: ExcelApi 1.7]
visible
Especifica si el eje está visible.
visible: boolean;
Valor de propiedad
boolean
Comentarios
[Conjunto de API: ExcelApi 1.7]
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
[Conjunto de API: ExcelApi 1.7]
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
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
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
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
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 API del mismo tipo.
set(properties: Interfaces.ChartAxisUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parámetros
- properties
- Excel.Interfaces.ChartAxisUpdateData
Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el 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, basadas en 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
[Conjunto de API: ExcelApi 1.7]
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
[Conjunto de API: ExcelApi 1.7]
setPositionAt(value)
Establece la posición del eje especificada en la que se cruza el otro eje.
setPositionAt(value: number): void;
Parámetros
- value
-
number
Valor personalizado del punto de cruce.
Devoluciones
void
Comentarios
[Conjunto de API: ExcelApi 1.8]
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.ChartAxis es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.ChartAxisData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): Excel.Interfaces.ChartAxisData;