Excel.ChartAxisTitle class
Representa el título del eje de un gráfico.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
Propiedades
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| format | Especifica el formato del título del eje del gráfico. |
| text | Especifica el título del eje. |
| text |
Especifica el ángulo al que está orientado el texto para el título del eje del gráfico. El valor debe ser un entero de -90 a 90 o el entero 180 para texto orientado verticalmente. |
| visible | Especifica si el título del eje está visible. |
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 de API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente. |
| set |
Un valor de cadena que representa la fórmula del título del eje del gráfico mediante la notación de estilo A1. |
| toJSON() | Invalida el método JavaScript |
Detalles de las propiedades
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
format
Especifica el formato del título del eje del gráfico.
readonly format: Excel.ChartAxisTitleFormat;Valor de propiedad
Comentarios
text
Especifica el título del eje.
text: string;Valor de propiedad
string
Comentarios
textOrientation
Especifica el ángulo al que está orientado el texto para el título del eje del gráfico. El valor debe ser un entero de -90 a 90 o el entero 180 para texto orientado verticalmente.
textOrientation: number;Valor de propiedad
number
Comentarios
[ Conjunto de API: ExcelApi 1.12 ]
Ejemplos
await Excel.run(async (context) => {
// Get a chart named "Sales Chart" from the "Sample" worksheet.
const sheet = context.workbook.worksheets.getItem("Sample");
let chart = sheet.charts.getItem("Sales Chart");
// Set the value axis title to "Profits".
chart.axes.valueAxis.title.text = "Profits";
/* Set the value axis text orientation to 0.
For charts with a y-axis, this makes the label on the y-axis horizontal,
instead of the default look of rotated-vertically.
*/
chart.axes.valueAxis.title.textOrientation = 0;
await context.sync();
});
visible
Especifica si el título del eje está visible.
visible: boolean;Valor de propiedad
boolean
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.ChartAxisTitleLoadOptions): Excel.ChartAxisTitle;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.ChartAxisTitle;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
Ejemplos
// Add "Values" as the title for the value Axis.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.axes.valueAxis.title.text = "Values";
await context.sync();
console.log("Axis Title Added ");
});
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.ChartAxisTitle;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 de API del mismo tipo.
set(properties: Interfaces.ChartAxisTitleUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.ChartAxisTitleUpdateData
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.ChartAxisTitle): void;Parámetros
- properties
- Excel.ChartAxisTitle
Devoluciones
void
setFormula(formula)
Un valor de cadena que representa la fórmula del título del eje del gráfico mediante la notación de estilo A1.
setFormula(formula: string): void;Parámetros
- formula
-
string
Cadena que representa la fórmula que se va a establecer.
Devoluciones
void
Comentarios
toJSON()
Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.ChartAxisTitle es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ChartAxisTitleData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.ChartAxisTitleData;