Excel.ChartLegend class
Representa la leyenda 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 | Representa el formato de una leyenda del gráfico, que incluye el formato de relleno y de fuente. |
| height | Especifica el alto, en puntos, de la leyenda del gráfico. El valor es |
| left | Especifica el valor izquierdo, en puntos, de la leyenda del gráfico. El valor es |
| legend |
Representa una colección de legendEntries en la leyenda. |
| overlay | Especifica si la leyenda del gráfico debe superponerse con el cuerpo principal del gráfico. |
| position | Especifica la posición de la leyenda en el gráfico. Vea |
| show |
Especifica si la leyenda tiene una sombra en el gráfico. |
| top | Especifica la parte superior de una leyenda de gráfico. |
| visible | Especifica si la leyenda del gráfico está visible. |
| width | Especifica el ancho, en puntos, de la leyenda del gráfico. El valor es |
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. |
| 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
Representa el formato de una leyenda del gráfico, que incluye el formato de relleno y de fuente.
readonly format: Excel.ChartLegendFormat;Valor de propiedad
Comentarios
height
Especifica el alto, en puntos, de la leyenda del gráfico. El valor es null si la leyenda no está visible.
height: number;Valor de propiedad
number
Comentarios
left
Especifica el valor izquierdo, en puntos, de la leyenda del gráfico. El valor es null si la leyenda no está visible.
left: number;Valor de propiedad
number
Comentarios
legendEntries
Representa una colección de legendEntries en la leyenda.
readonly legendEntries: Excel.ChartLegendEntryCollection;Valor de propiedad
Comentarios
overlay
Especifica si la leyenda del gráfico debe superponerse con el cuerpo principal del gráfico.
overlay: boolean;Valor de propiedad
boolean
Comentarios
position
Especifica la posición de la leyenda en el gráfico. Vea Excel.ChartLegendPosition para más información.
position: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom";Valor de propiedad
Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom"
Comentarios
showShadow
Especifica si la leyenda tiene una sombra en el gráfico.
showShadow: boolean;Valor de propiedad
boolean
Comentarios
top
Especifica la parte superior de una leyenda de gráfico.
top: number;Valor de propiedad
number
Comentarios
visible
Especifica si la leyenda del gráfico está visible.
visible: boolean;Valor de propiedad
boolean
Comentarios
width
Especifica el ancho, en puntos, de la leyenda del gráfico. El valor es null si la leyenda no está visible.
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.ChartLegendLoadOptions): Excel.ChartLegend;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.ChartLegend;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
// Get the position of Chart Legend from Chart1.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
const legend = chart.legend;
legend.load('position');
await context.sync();
console.log(legend.position);
});
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.ChartLegend;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.ChartLegendUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.ChartLegendUpdateData
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.ChartLegend): void;Parámetros
- properties
- Excel.ChartLegend
Devoluciones
void
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.ChartLegend es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ChartLegendData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.ChartLegendData;