Excel.ChartDataLabels class
Representa una colección de todas las etiquetas de datos en un punto del 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 de las etiquetas de datos del gráfico, que incluye el formato de relleno y fuente. |
| position | Valor que representa la posición de la etiqueta de datos. Vea |
| separator | Cadena que representa el separador empleado para las etiquetas de datos de un gráfico. |
| show |
Especifica si el tamaño de la burbuja de etiqueta de datos es visible. |
| show |
Especifica si el nombre de la categoría de etiqueta de datos está visible. |
| show |
Especifica si la clave de leyenda de etiqueta de datos está visible. |
| show |
Especifica si el porcentaje de etiqueta de datos está visible. |
| show |
Especifica si el nombre de la serie de etiquetas de datos está visible. |
| show |
Especifica si el valor de la etiqueta de datos 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. |
| 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 de las etiquetas de datos del gráfico, que incluye el formato de relleno y fuente.
readonly format: Excel.ChartDataLabelFormat;Valor de propiedad
Comentarios
position
Valor que representa la posición de la etiqueta de datos. Vea Excel.ChartDataLabelPosition para más información.
position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout";Valor de propiedad
Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"
Comentarios
separator
Cadena que representa el separador empleado para las etiquetas de datos de un gráfico.
separator: string;Valor de propiedad
string
Comentarios
showBubbleSize
Especifica si el tamaño de la burbuja de etiqueta de datos es visible.
showBubbleSize: boolean;Valor de propiedad
boolean
Comentarios
showCategoryName
Especifica si el nombre de la categoría de etiqueta de datos está visible.
showCategoryName: boolean;Valor de propiedad
boolean
Comentarios
showLegendKey
Especifica si la clave de leyenda de etiqueta de datos está visible.
showLegendKey: boolean;Valor de propiedad
boolean
Comentarios
showPercentage
Especifica si el porcentaje de etiqueta de datos está visible.
showPercentage: boolean;Valor de propiedad
boolean
Comentarios
showSeriesName
Especifica si el nombre de la serie de etiquetas de datos está visible.
showSeriesName: boolean;Valor de propiedad
boolean
Comentarios
showValue
Especifica si el valor de la etiqueta de datos está visible.
showValue: 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.ChartDataLabelsLoadOptions): Excel.ChartDataLabels;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.ChartDataLabels;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
// Show the series name in data labels and set the position of the data labels to "top".
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.dataLabels.showValue = true;
chart.dataLabels.position = Excel.ChartDataLabelPosition.top;
chart.dataLabels.showSeriesName = true;
await context.sync();
console.log("Data labels shown");
});
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.ChartDataLabels;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.ChartDataLabelsUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.ChartDataLabelsUpdateData
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.ChartDataLabels): void;Parámetros
- properties
- Excel.ChartDataLabels
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 Excel.ChartDataLabels original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ChartDataLabelsData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.ChartDataLabelsData;