Excel.ChartLegendEntry class
Representa la entrada de leyenda en legendEntryCollection.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Propiedades
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| height | Especifica el alto de la entrada de leyenda en la leyenda del gráfico. |
| index | Especifica el índice de la entrada de leyenda en la leyenda del gráfico. |
| left | Especifica el valor izquierdo de una entrada de leyenda de gráfico. |
| top | Especifica la parte superior de una entrada de leyenda de gráfico. |
| visible | Representa la visibilidad de una entrada de leyenda de gráfico. |
| width | Representa el ancho de la entrada de leyenda en el gráfico Leyenda. |
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
height
Especifica el alto de la entrada de leyenda en la leyenda del gráfico.
readonly height: number;Valor de propiedad
number
Comentarios
index
Especifica el índice de la entrada de leyenda en la leyenda del gráfico.
readonly index: number;Valor de propiedad
number
Comentarios
left
Especifica el valor izquierdo de una entrada de leyenda de gráfico.
readonly left: number;Valor de propiedad
number
Comentarios
top
Especifica la parte superior de una entrada de leyenda de gráfico.
readonly top: number;Valor de propiedad
number
Comentarios
visible
Representa la visibilidad de una entrada de leyenda de gráfico.
visible: boolean;Valor de propiedad
boolean
Comentarios
width
Representa el ancho de la entrada de leyenda en el gráfico Leyenda.
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.ChartLegendEntryLoadOptions): Excel.ChartLegendEntry;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.ChartLegendEntry;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.ChartLegendEntry;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.ChartLegendEntryUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.ChartLegendEntryUpdateData
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.ChartLegendEntry): void;Parámetros
- properties
- Excel.ChartLegendEntry
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.ChartLegendEntry es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ChartLegendEntryData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.ChartLegendEntryData;