Excel.ChartLegend class

Paquete:
excel

Representa la leyenda de un gráfico.

Extends
OfficeExtension.ClientObject

Comentarios

[Conjunto de API: ExcelApi 1.1]

Propiedades

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.
format

Representa el formato de una leyenda del gráfico, que incluye el formato de relleno y de fuente.
height

Especifica la altura, en puntos, de la leyenda en el gráfico. El valor es null si la leyenda no está visible.
left

Especifica el valor izquierdo, en puntos, de la leyenda del gráfico. El valor es null si la leyenda no está visible.
legendEntries

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 Excel.ChartLegendPosition para más información.
showShadow

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 en el gráfico. El valor es null si la leyenda no está visible.

Métodos

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(propertyNames)

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

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
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.
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.ChartLegend es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.ChartLegendData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

Detalles de las propiedades

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

Excel.RequestContext

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

Excel.ChartLegendFormat

Comentarios

[Conjunto de API: ExcelApi 1.1]

height

Especifica la altura, en puntos, de la leyenda en el gráfico. El valor es null si la leyenda no está visible.

height: number;

Valor de propiedad

number

Comentarios

[Conjunto de API: ExcelApi 1.7]

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

[Conjunto de API: ExcelApi 1.7]

legendEntries

Representa una colección de legendEntries en la leyenda.

readonly legendEntries: Excel.ChartLegendEntryCollection;

Valor de propiedad

Excel.ChartLegendEntryCollection

Comentarios

[Conjunto de API: ExcelApi 1.7]

overlay

Especifica si la leyenda del gráfico debe superponerse con el cuerpo principal del gráfico.

overlay: boolean;

Valor de propiedad

boolean

Comentarios

[Conjunto de API: ExcelApi 1.1]

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

[Conjunto de API: ExcelApi 1.1]

showShadow

Especifica si la leyenda tiene una sombra en el gráfico.

showShadow: boolean;

Valor de propiedad

boolean

Comentarios

[Conjunto de API: ExcelApi 1.7]

top

Especifica la parte superior de una leyenda de gráfico.

top: number;

Valor de propiedad

number

Comentarios

[Conjunto de API: ExcelApi 1.7]

visible

Especifica si la leyenda del gráfico está visible.

visible: boolean;

Valor de propiedad

boolean

Comentarios

[Conjunto de API: ExcelApi 1.1]

width

Especifica el ancho, en puntos, de la leyenda en el gráfico. El valor es null si la leyenda no está visible.

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.ChartLegendLoadOptions): Excel.ChartLegend;

Parámetros

options
Excel.Interfaces.ChartLegendLoadOptions

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

Devoluciones

Excel.ChartLegend

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

Excel.ChartLegend

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

Excel.ChartLegend

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.ChartLegendUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties
Excel.Interfaces.ChartLegendUpdateData

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.ChartLegend): void;

Parámetros

properties
Excel.ChartLegend

Devoluciones

void

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.ChartLegend es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.ChartLegendData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Excel.Interfaces.ChartLegendData;

Devoluciones

Excel.Interfaces.ChartLegendData