Compartir a través de

Excel.Chart class

  • Referencia
Paquete:
excel

Representa un objeto de gráfico de una hoja de cálculo. Para obtener más información sobre el modelo de objetos de gráfico, consulte Trabajar con gráficos mediante la API de JavaScript de Excel.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Propiedades

axes

Representa los ejes del gráfico.
categoryLabelLevel

Especifica una constante de enumeración de nivel de etiqueta de categoría de gráfico, que hace referencia al nivel de las etiquetas de categoría de origen.
chartType

Especifica el tipo del gráfico. Vea Excel.ChartType para más información.
context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
dataLabels

Representa la clase DataLabels del gráfico.
displayBlanksAs

Especifica la forma en que las celdas en blanco se trazan en un gráfico.
format

Encapsula las propiedades de formato del área del gráfico.
height

Especifica el alto, en puntos, del objeto de gráfico.
id

Identificador único del gráfico.
left

Distancia, en puntos, desde el lado izquierdo del gráfico hasta el origen de la hoja de cálculo.
legend

Representa la leyenda del gráfico.
name

Especifica el nombre de un objeto de gráfico.
pivotOptions

Contiene las opciones del gráfico dinámico.
plotArea

Representa el área de trazado del gráfico.
plotBy

Especifica la manera en que las columnas o las filas se usan como series de datos en el gráfico.
plotVisibleOnly

True si solo se trazan las celdas visibles. False si se trazan tanto las celdas visibles como las ocultas.
series

Representa una sola serie o una colección de series del gráfico.
seriesNameLevel

Especifica una constante de enumeración de nivel de nombre de serie de gráfico, que hace referencia al nivel de los nombres de las series de origen.
showAllFieldButtons

Especifica si se van a mostrar todos los botones de campo en un gráfico dinámico.
showDataLabelsOverMaximum

Especifica si se muestran las etiquetas de datos cuando el valor es mayor que el valor máximo en el eje de valores. Si el eje de valores es menor que el tamaño de los puntos de datos, puede usar esta propiedad para establecer si desea mostrar las etiquetas de datos. Esta propiedad solo se aplica a gráficos 2D.
style

Especifica el estilo del gráfico.
title

Representa el título del gráfico especificado, incluido el texto, la visibilidad, la posición y el formato del título.
top

Especifica la distancia, en puntos, desde el borde superior del objeto hasta la parte superior de la fila 1 (en una hoja de cálculo) o la parte superior del área del gráfico (en un gráfico).
width

Especifica el ancho, en puntos, del objeto de gráfico.
worksheet

La hoja de cálculo que contiene el gráfico actual.

Métodos

activate()

Activa el gráfico en la interfaz de usuario de Excel.
delete()

Elimina el objeto de gráfico.
getDataTable()

Obtiene la tabla de datos del gráfico. Si el gráfico no permite una tabla de datos, producirá una excepción.
getDataTableOrNullObject()

Obtiene la tabla de datos del gráfico. Si el gráfico no permite una tabla de datos, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
getImage(width, height, fittingMode)

Representa el gráfico como una imagen codificada en Base64 escalando el gráfico para ajustarlo a las dimensiones especificadas. La relación de aspecto se conserva como parte del cambio de tamaño.
getImage(width, height, fittingModeString)

Representa el gráfico como una imagen codificada en Base64 escalando el gráfico para ajustarlo a las dimensiones especificadas. La relación de aspecto se conserva como parte del cambio de tamaño.
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.
setData(sourceData, seriesBy)

Configura los datos de origen para el gráfico.
setData(sourceData, seriesByString)

Configura los datos de origen para el gráfico.
setPosition(startCell, endCell)

Coloca el gráfico con respecto a las celdas de la hoja de cálculo.
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.Chart es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ChartData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Eventos

onActivated

Se produce cuando se activa el gráfico.
onDeactivated

Se produce cuando se desactiva el gráfico.

Detalles de las propiedades

axes

Representa los ejes del gráfico.

readonly axes: Excel.ChartAxes;

Valor de propiedad

Excel.ChartAxes

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

categoryLabelLevel

Especifica una constante de enumeración de nivel de etiqueta de categoría de gráfico, que hace referencia al nivel de las etiquetas de categoría de origen.

categoryLabelLevel: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

chartType

Especifica el tipo del gráfico. Vea Excel.ChartType para más información.

chartType: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel";

Valor de propiedad

Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel"

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

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

Excel.RequestContext

dataLabels

Representa la clase DataLabels del gráfico.

readonly dataLabels: Excel.ChartDataLabels;

Valor de propiedad

Excel.ChartDataLabels

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

displayBlanksAs

Especifica la forma en que las celdas en blanco se trazan en un gráfico.

displayBlanksAs: Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted";

Valor de propiedad

Excel.ChartDisplayBlanksAs | "NotPlotted" | "Zero" | "Interplotted"

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

format

Encapsula las propiedades de formato del área del gráfico.

readonly format: Excel.ChartAreaFormat;

Valor de propiedad

Excel.ChartAreaFormat

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

height

Especifica el alto, en puntos, del objeto de gráfico.

height: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

id

Identificador único del gráfico.

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

left

Distancia, en puntos, desde el lado izquierdo del gráfico hasta el origen de la hoja de cálculo.

left: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

legend

Representa la leyenda del gráfico.

readonly legend: Excel.ChartLegend;

Valor de propiedad

Excel.ChartLegend

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

// Set to show legend of Chart1 and make it on top of the chart.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.legend.visible = true;
    chart.legend.position = "Top"; 
    chart.legend.overlay = false; 
    await context.sync()
    
    console.log("Legend Shown ");
});

name

Especifica el nombre de un objeto de gráfico.

name: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

// Rename the chart to new name, resize the chart to 200 points in both height and weight.
// Move Chart1 to 100 points to the top and left.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.name = "New Name";
    chart.top = 100;
    chart.left = 100;
    chart.height = 200;
    chart.width = 200;
    await context.sync(); 
});

pivotOptions

Contiene las opciones del gráfico dinámico.

readonly pivotOptions: Excel.ChartPivotOptions;

Valor de propiedad

Excel.ChartPivotOptions

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

plotArea

Representa el área de trazado del gráfico.

readonly plotArea: Excel.ChartPlotArea;

Valor de propiedad

Excel.ChartPlotArea

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

plotBy

Especifica la manera en que las columnas o las filas se usan como series de datos en el gráfico.

plotBy: Excel.ChartPlotBy | "Rows" | "Columns";

Valor de propiedad

Excel.ChartPlotBy | "Rows" | "Columns"

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

plotVisibleOnly

True si solo se trazan las celdas visibles. False si se trazan tanto las celdas visibles como las ocultas.

plotVisibleOnly: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

series

Representa una sola serie o una colección de series del gráfico.

readonly series: Excel.ChartSeriesCollection;

Valor de propiedad

Excel.ChartSeriesCollection

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

seriesNameLevel

Especifica una constante de enumeración de nivel de nombre de serie de gráfico, que hace referencia al nivel de los nombres de las series de origen.

seriesNameLevel: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

showAllFieldButtons

Especifica si se van a mostrar todos los botones de campo en un gráfico dinámico.

showAllFieldButtons: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

showDataLabelsOverMaximum

Especifica si se muestran las etiquetas de datos cuando el valor es mayor que el valor máximo en el eje de valores. Si el eje de valores es menor que el tamaño de los puntos de datos, puede usar esta propiedad para establecer si desea mostrar las etiquetas de datos. Esta propiedad solo se aplica a gráficos 2D.

showDataLabelsOverMaximum: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

style

Especifica el estilo del gráfico.

style: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

title

Representa el título del gráfico especificado, incluido el texto, la visibilidad, la posición y el formato del título.

readonly title: Excel.ChartTitle;

Valor de propiedad

Excel.ChartTitle

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

top

Especifica la distancia, en puntos, desde el borde superior del objeto hasta la parte superior de la fila 1 (en una hoja de cálculo) o la parte superior del área del gráfico (en un gráfico).

top: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

width

Especifica el ancho, en puntos, del objeto de gráfico.

width: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

worksheet

La hoja de cálculo que contiene el gráfico actual.

readonly worksheet: Excel.Worksheet;

Valor de propiedad

Excel.Worksheet

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

Detalles del método

activate()

Activa el gráfico en la interfaz de usuario de Excel.

activate(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

delete()

Elimina el objeto de gráfico.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.delete();
    await context.sync(); 
});

getDataTable()

Obtiene la tabla de datos del gráfico. Si el gráfico no permite una tabla de datos, producirá una excepción.

getDataTable(): Excel.ChartDataTable;

Devoluciones

Excel.ChartDataTable

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

getDataTableOrNullObject()

Obtiene la tabla de datos del gráfico. Si el gráfico no permite una tabla de datos, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getDataTableOrNullObject(): Excel.ChartDataTable;

Devoluciones

Excel.ChartDataTable

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-table.yaml

// This function adds a data table to a chart that already exists on the worksheet. 
await Excel.run(async (context) => {
  // Retrieve the chart named "SalesChart" from the "Sample" worksheet.
  const chart = context.workbook.worksheets.getItem("Sample").charts.getItem("SalesChart");

  // Get the data table object for the chart and set it to visible.
  const chartDataTable = chart.getDataTableOrNullObject();
  chartDataTable.load("visible");
  chartDataTable.visible = true;
  await context.sync();
});

getImage(width, height, fittingMode)

Representa el gráfico como una imagen codificada en Base64 escalando el gráfico para ajustarlo a las dimensiones especificadas. La relación de aspecto se conserva como parte del cambio de tamaño.

getImage(width?: number, height?: number, fittingMode?: Excel.ImageFittingMode): OfficeExtension.ClientResult<string>;

Parámetros

width

number

Opcional. Ancho deseado de la imagen resultante.

height

number

Opcional. Alto deseado de la imagen resultante.

fittingMode
Excel.ImageFittingMode

Opcional. Método utilizado para escalar el gráfico a las dimensiones especificadas (si se establecen tanto el alto como el ancho).

Devoluciones

OfficeExtension.ClientResult<string>

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

Ejemplos

await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    const image = chart.getImage();
    await context.sync(); 
});

getImage(width, height, fittingModeString)

Representa el gráfico como una imagen codificada en Base64 escalando el gráfico para ajustarlo a las dimensiones especificadas. La relación de aspecto se conserva como parte del cambio de tamaño.

getImage(width?: number, height?: number, fittingModeString?: "Fit" | "FitAndCenter" | "Fill"): OfficeExtension.ClientResult<string>;

Parámetros

width

number

Opcional. Ancho deseado de la imagen resultante.

height

number

Opcional. Alto deseado de la imagen resultante.

fittingModeString

"Fit" | "FitAndCenter" | "Fill"

Opcional. Método utilizado para escalar el gráfico a las dimensiones especificadas (si se establecen tanto el alto como el ancho).

Devoluciones

OfficeExtension.ClientResult<string>

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

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.ChartLoadOptions): Excel.Chart;

Parámetros

options
Excel.Interfaces.ChartLoadOptions

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

Devoluciones

Excel.Chart

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

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

Ejemplos

// Get a chart named "Chart1".
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.load('name');
    await context.sync();

    console.log(chart.name);
});

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

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

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

Parámetros

properties
Excel.Interfaces.ChartUpdateData

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

Parámetros

properties
Excel.Chart

Devoluciones

void

setData(sourceData, seriesBy)

Configura los datos de origen para el gráfico.

setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy): void;

Parámetros

sourceData
Excel.Range

Objeto de intervalo correspondiente a los datos de origen.

seriesBy
Excel.ChartSeriesBy

Especifica la manera en que las columnas o las filas se usan como series de datos en el gráfico. Puede ser una de las siguientes: Auto (valor predeterminado), Filas y Columnas. Vea Excel.ChartSeriesBy para más información.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

// Set the sourceData to be the range at "A1:B4" and seriesBy to be "Columns".
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sheet1");
    const chart = sheet.charts.getItem("Chart1");
    const sourceData = sheet.getRange("A1:B4");
    chart.setData(sourceData, "Columns");
    await context.sync();
});

setData(sourceData, seriesByString)

Configura los datos de origen para el gráfico.

setData(sourceData: Range, seriesByString?: "Auto" | "Columns" | "Rows"): void;

Parámetros

sourceData
Excel.Range

Objeto de intervalo correspondiente a los datos de origen.

seriesByString

"Auto" | "Columns" | "Rows"

Especifica la manera en que las columnas o las filas se usan como series de datos en el gráfico. Puede ser una de las siguientes: Auto (valor predeterminado), Filas y Columnas. Vea Excel.ChartSeriesBy para más información.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

setPosition(startCell, endCell)

Coloca el gráfico con respecto a las celdas de la hoja de cálculo.

setPosition(startCell: Range | string, endCell?: Range | string): void;

Parámetros

startCell

Excel.Range | string

Celda de inicio. Aquí es adonde se moverá el gráfico. La celda de inicio es la celda superior izquierda o superior derecha, en función de la configuración del usuario de la presentación de derecha a izquierda.

endCell

Excel.Range | string

Opcional. Última celda. Si se especifica, el ancho y el alto del gráfico se establecerán de modo que cubran totalmente esta celda o rango.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

await Excel.run(async (context) => { 
    const sheetName = "Charts";
    const rangeSelection = "A1:B4";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeSelection);
    const sourceData = sheetName + "!" + "A1:B4";
    const chart = context.workbook.worksheets.getItem(sheetName).charts.add("pie", range, "auto");
    chart.width = 500;
    chart.height = 300;
    chart.setPosition("C2", null);
    await context.sync(); 
});

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.Chart es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ChartData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.ChartData;

Devoluciones

Excel.Interfaces.ChartData

Detalles del evento

onActivated

Se produce cuando se activa el gráfico.

readonly onActivated: OfficeExtension.EventHandlers<Excel.ChartActivatedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.ChartActivatedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-chart-activated.yaml

await Excel.run(async (context) => {

    const pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");

    // Register the onActivated and onDeactivated event handlers.
    pieChart.onActivated.add(chartActivated);
    pieChart.onDeactivated.add(chartDeactivated);

    await context.sync();

    console.log("Added handlers for Chart onActivated and onDeactivated events.");
});

...

async function chartActivated(event) {
    await Excel.run(async (context) => {
        // Retrieve the worksheet.
        const sheet = context.workbook.worksheets.getActiveWorksheet();

        // Retrieve the activated chart by ID and load the name of the chart. 
        const activatedChart = sheet.charts.getItem(event.chartId);
        activatedChart.load(["name"]);
        await context.sync();

        // Print out the activated chart's data.
        console.log(`A chart was activated. ID: ${event.chartId}. Chart name: ${activatedChart.name}.`);
    });
}

onDeactivated

Se produce cuando se desactiva el gráfico.

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.ChartDeactivatedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.ChartDeactivatedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-chart-activated.yaml

await Excel.run(async (context) => {

    const pieChart = context.workbook.worksheets.getActiveWorksheet().charts.getItem("Pie");

    // Register the onActivated and onDeactivated event handlers.
    pieChart.onActivated.add(chartActivated);
    pieChart.onDeactivated.add(chartDeactivated);

    await context.sync();

    console.log("Added handlers for Chart onActivated and onDeactivated events.");
});

...

async function chartDeactivated(event) {
    await Excel.run(async (context) => {
        // Callback function for when the chart is deactivated.
        console.log("The pie chart is NOT active.");
    });
}