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

autoText

Especifica si las etiquetas de datos generan automáticamente el texto adecuado en función del contexto.

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.

horizontalAlignment

Especifica la alineación horizontal de la etiqueta de datos del gráfico. Vea Excel.ChartTextHorizontalAlignment para más información. Esta propiedad solo es válida cuando la TextOrientation etiqueta de datos es 0.

linkNumberFormat

Especifica si el formato de número está vinculado a las celdas. Si truees , el formato numérico cambiará en las etiquetas cuando cambie en las celdas.

numberFormat

Especifica el código de formato para las etiquetas de datos.

position

Valor que representa la posición de la etiqueta de datos. Vea Excel.ChartDataLabelPosition para más información.

separator

Cadena que representa el separador empleado para las etiquetas de datos de un gráfico.

showBubbleSize

Especifica si el tamaño de la burbuja de etiqueta de datos es visible.

showCategoryName

Especifica si el nombre de la categoría de etiqueta de datos está visible.

showLegendKey

Especifica si la clave de leyenda de etiqueta de datos está visible.

showPercentage

Especifica si el porcentaje de etiqueta de datos está visible.

showSeriesName

Especifica si el nombre de la serie de etiquetas de datos está visible.

showValue

Especifica si el valor de la etiqueta de datos está visible.

textOrientation

Representa el ángulo al que está orientado el texto para las etiquetas de datos. El valor debe ser un entero de -90 a 90 o el entero 180 para texto orientado verticalmente.

verticalAlignment

Representa la alineación vertical de la etiqueta de datos del gráfico. Vea Excel.ChartTextVerticalAlignment para más información. Esta propiedad solo es válida cuando TextOrientation la etiqueta de datos es -90, 90 o 180.

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

Detalles de las propiedades

autoText

Especifica si las etiquetas de datos generan automáticamente el texto adecuado en función del contexto.

autoText: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

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

[ Conjunto de API: ExcelApi 1.1 ]

horizontalAlignment

Especifica la alineación horizontal de la etiqueta de datos del gráfico. Vea Excel.ChartTextHorizontalAlignment para más información. Esta propiedad solo es válida cuando la TextOrientation etiqueta de datos es 0.

horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";

Valor de propiedad

Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

linkNumberFormat

Especifica si el formato de número está vinculado a las celdas. Si truees , el formato numérico cambiará en las etiquetas cuando cambie en las celdas.

linkNumberFormat: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

numberFormat

Especifica el código de formato para las etiquetas de datos.

numberFormat: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

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

[ Conjunto de API: ExcelApi 1.1 ]

separator

Cadena que representa el separador empleado para las etiquetas de datos de un gráfico.

separator: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

showBubbleSize

Especifica si el tamaño de la burbuja de etiqueta de datos es visible.

showBubbleSize: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

showCategoryName

Especifica si el nombre de la categoría de etiqueta de datos está visible.

showCategoryName: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

showLegendKey

Especifica si la clave de leyenda de etiqueta de datos está visible.

showLegendKey: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

showPercentage

Especifica si el porcentaje de etiqueta de datos está visible.

showPercentage: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

showSeriesName

Especifica si el nombre de la serie de etiquetas de datos está visible.

showSeriesName: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

showValue

Especifica si el valor de la etiqueta de datos está visible.

showValue: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

textOrientation

Representa el ángulo al que está orientado el texto para las etiquetas de datos. 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.8 ]

verticalAlignment

Representa la alineación vertical de la etiqueta de datos del gráfico. Vea Excel.ChartTextVerticalAlignment para más información. Esta propiedad solo es válida cuando TextOrientation la etiqueta de datos es -90, 90 o 180.

verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";

Valor de propiedad

Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

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

options
Excel.Interfaces.ChartDataLabelsLoadOptions

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

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.ChartDataLabels 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;

Devoluciones