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.
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.
format	Encapsula las propiedades de formato del área del gráfico.
height	Especifica el alto, en puntos, del objeto de 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.
series	Representa una sola serie o una colección de series 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

delete()	Elimina el objeto de gráfico.
getImage(width, height, fittingMode)	Representa el gráfico como una imagen con codificación Base64 al escalar el gráfico 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 con codificación Base64 al escalar el gráfico 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.stringify`a su vez, llama al `toJSON` método del objeto que se le pasa). Mientras que el objeto Excel.Chart original 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.

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 ]

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 ]

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 ]

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(); 
});

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 ]

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

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(); 
});

getImage(width, height, fittingMode)

Representa el gráfico como una imagen con codificación Base64 al escalar el gráfico 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 con codificación Base64 al escalar el gráfico 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"

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