Excel.Chart class

Paquete:
excel

Representa un objeto de gráfico de una hoja de cálculo. Para obtener más información sobre el modelo de objeto de gráfico, vea 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 de gráfico. Vea Excel.ChartType para más información.
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.
dataLabels

Representa la clase DataLabels del gráfico.
displayBlanksAs

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

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

Especifica la altura, 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 serie de origen.
showAllFieldButtons

Especifica si se muestran 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 más pequeño que el tamaño de los puntos de datos, puede usar esta propiedad para establecer si se mostrarán las etiquetas de datos. Esta propiedad solo se aplica a gráficos 2D.
style

Especifica el estilo de gráfico para el 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 en el gráfico. Si el gráfico no permite una tabla de datos, se producirá una excepción.
getDataTableOrNullObject()

Obtiene la tabla de datos en el 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 los métodos y propiedades *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, 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.
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.
setData(sourceData, seriesBy)

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

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

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

Eventos

onActivated

Ocurre cuando se activa el gráfico.
onDeactivated

Ocurre 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 de 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

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

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 manera en que se trazan las celdas en blanco 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 la altura, 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]

name

Especifica el nombre de un objeto de gráfico.

name: string;

Valor de propiedad

string

Comentarios

[Conjunto de API: ExcelApi 1.1]

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 serie de origen.

seriesNameLevel: number;

Valor de propiedad

number

Comentarios

[Conjunto de API: ExcelApi 1.8]

showAllFieldButtons

Especifica si se muestran 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 más pequeño que el tamaño de los puntos de datos, puede usar esta propiedad para establecer si se mostrarán 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 de gráfico para el 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]

getDataTable()

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

getDataTable(): Excel.ChartDataTable;

Devoluciones

Excel.ChartDataTable

Comentarios

[Conjunto de API: ExcelApi 1.14]

getDataTableOrNullObject()

Obtiene la tabla de datos en el 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 los métodos y propiedades *OrNullObject.

getDataTableOrNullObject(): Excel.ChartDataTable;

Devoluciones

Excel.ChartDataTable

Comentarios

[Conjunto de API: ExcelApi 1.14]

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 usado para escalar el gráfico a las dimensiones especificadas (si se establecen tanto la altura como el ancho).

Devoluciones

OfficeExtension.ClientResult<string>

Comentarios

[Conjunto de API: ExcelApi 1.2]

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?: "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.

fittingMode

"Fit" | "FitAndCenter" | "Fill"

Opcional. Método usado para escalar el gráfico a las dimensiones especificadas (si se establecen tanto la altura 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

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 API del mismo tipo.

set(properties: Interfaces.ChartUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties
Excel.Interfaces.ChartUpdateData

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.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 rango 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 uno de los siguientes: Automático (predeterminado), filas y columnas. Vea Excel.ChartSeriesBy para más información.

Devoluciones

void

Comentarios

[Conjunto de API: ExcelApi 1.1]

setData(sourceData, seriesBy)

Configura los datos de origen para el gráfico.

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

Parámetros

sourceData
Excel.Range

Objeto de rango correspondiente a los datos de origen.

seriesBy

"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 uno de los siguientes: Automático (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]

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

toJSON(): Excel.Interfaces.ChartData;

Devoluciones

Excel.Interfaces.ChartData

Detalles del evento

onActivated

Ocurre 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]

onDeactivated

Ocurre 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]