Excel.ChartSeries class
Representa una serie de un gráfico.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
Propiedades
axis |
Especifica el grupo de la serie especificada. |
bin |
Contiene las opciones de intervalo para gráficos de histograma y diagramas de Pareto. |
boxwhisker |
Contiene las opciones para el gráfico de cajas y bigotes. |
bubble |
Esto puede ser un valor entero entre 0 (cero) y 300, que representa el porcentaje del tamaño predeterminado. Esta propiedad solo se aplica a los gráficos de burbujas. |
chart |
Representa el tipo de gráfico de una serie. Vea |
context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
data |
Representa una colección de todas las etiquetas de datos de la serie. |
doughnut |
Representa el tamaño del agujero de los anillos de una serie de gráfico. Solo es válido en los gráficos de anillos y anillos explotados. Produce un |
explosion | Especifica el valor de explosión de un gráfico circular o un segmento de gráfico de anillos. Devuelve 0 (cero) si no hay expansión (el vértice del sector está en el centro del círculo). |
filtered | Especifica si la serie está filtrada. No aplicable para los gráficos de superficie. |
first |
Especifica el ángulo del primer gráfico circular o segmento de gráfico de anillos, en grados (en el sentido de las agujas del reloj desde vertical). Se aplica solo a gráficos circulares, circulares 3D y de anillos. Puede ser un valor comprendido entre 0 y 360. |
format | Representa el formato de una serie del gráfico, que incluye el formato de relleno y de línea. |
gap |
Representa el ancho del rango de una serie de gráfico. Solo es válido en gráficos de barras y columnas, así como clases específicas de gráficos circulares y de líneas. Produce una excepción de argumento no válida en gráficos no válidos. |
gradient |
Especifica el color del valor máximo de una serie de gráficos de mapa de regiones. |
gradient |
Especifica el tipo para el valor máximo de una serie de gráficos de mapa de regiones. |
gradient |
Especifica el valor máximo de una serie de gráficos de mapa de regiones. |
gradient |
Especifica el color del valor de punto medio de una serie de gráficos de mapa de regiones. |
gradient |
Especifica el tipo para el valor de punto medio de una serie de gráficos de mapa de regiones. |
gradient |
Especifica el valor de punto medio de una serie de gráficos de mapa de regiones. |
gradient |
Especifica el color del valor mínimo de una serie de gráficos de mapa de regiones. |
gradient |
Especifica el tipo para el valor mínimo de una serie de gráficos de mapa de regiones. |
gradient |
Especifica el valor mínimo de una serie de gráficos de mapa de regiones. |
gradient |
Especifica el estilo de degradado de serie de un gráfico de mapa de regiones. |
has |
Especifica si la serie tiene etiquetas de datos. |
invert |
Especifica el color de relleno de los puntos de datos negativos de una serie. |
invert |
True si Excel invierte el patrón en el elemento cuando corresponde a un número negativo. |
map |
Contiene las opciones para un gráfico de mapa de región. |
marker |
Especifica el color de fondo del marcador de una serie de gráficos. |
marker |
Especifica el color de primer plano del marcador de una serie de gráficos. |
marker |
Especifica el tamaño del marcador de una serie de gráficos. El intervalo de tamaño admitido es de 2 a 72. Este método devuelve un error InvalidArgument si se establece con un tamaño fuera del intervalo admitido. |
marker |
Especifica el estilo de marcador de una serie de gráficos. Vea |
name | Especifica el nombre de una serie en un gráfico. La longitud del nombre no debe tener más de 255 caracteres. |
overlap | Especifica cómo se colocan las barras y columnas. Puede ser un valor comprendido entre -100 y 100. Se aplica solo a los gráficos 2D de barras y columnas. |
parent |
Especifica el área de estrategia de etiqueta primaria de la serie para un gráfico de gráficos de rectángulos. |
plot |
Especifica el orden de trazado de una serie de gráficos dentro del grupo de gráficos. |
points | Devuelve una colección de todos los puntos de la serie. |
second |
Especifica el tamaño de la sección secundaria de un gráfico circular o un gráfico de barras circulares, como un porcentaje del tamaño del gráfico circular principal. Puede ser un valor comprendido entre 5 y 200. |
show |
Especifica si las líneas del conector se muestran en gráficos en cascada. |
show |
Especifica si se muestran líneas de directriz para cada etiqueta de datos de la serie. |
show |
Especifica si la serie tiene una sombra. |
smooth | Especifica si la serie es suave. Solo se aplica a gráficos de líneas y dispersión. |
split |
Especifica la forma en que se dividen las dos secciones de un gráfico circular de pie o de una barra de gráfico circular. |
split |
Especifica el valor de umbral que separa dos secciones de un gráfico circular de gráfico circular o un gráfico de barras circulares. |
trendlines | Colección de líneas de tendencia de la serie. |
vary |
True si Excel asigna un color o patrón diferente a cada marcador de datos. El gráfico debe contener una sola serie. |
x |
Indica el objeto de la barra de error de una serie de gráficos. |
y |
Indica el objeto de la barra de error de una serie de gráficos. |
Métodos
delete() | Elimina la serie del gráfico. |
get |
Obtiene los valores de una sola dimensión de la serie de gráficos. Estos pueden ser valores de categoría o valores de datos, dependiendo de la dimensión especificada y de cómo se asignan los datos para la serie de gráficos. |
get |
Obtiene los valores de una sola dimensión de la serie de gráficos. Estos pueden ser valores de categoría o valores de datos, dependiendo de la dimensión especificada y de cómo se asignan los datos para la serie de gráficos. |
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. |
set |
Establece los tamaños de burbuja de una serie de gráficos. Solo funciona para los gráficos de burbujas. |
set |
Establece los valores de una serie de gráficos. En el caso de los gráficos de dispersión, hace referencia a los valores del eje Y. |
set |
Establece los valores del eje X para una serie de gráficos. |
toJSON() | Invalida el método JavaScript |
Detalles de las propiedades
axisGroup
Especifica el grupo de la serie especificada.
axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary";
Valor de propiedad
Excel.ChartAxisGroup | "Primary" | "Secondary"
Comentarios
binOptions
Contiene las opciones de intervalo para gráficos de histograma y diagramas de Pareto.
readonly binOptions: Excel.ChartBinOptions;
Valor de propiedad
Comentarios
boxwhiskerOptions
Contiene las opciones para el gráfico de cajas y bigotes.
readonly boxwhiskerOptions: Excel.ChartBoxwhiskerOptions;
Valor de propiedad
Comentarios
bubbleScale
Esto puede ser un valor entero entre 0 (cero) y 300, que representa el porcentaje del tamaño predeterminado. Esta propiedad solo se aplica a los gráficos de burbujas.
bubbleScale: number;
Valor de propiedad
number
Comentarios
chartType
Representa el tipo de gráfico de una serie. 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
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
dataLabels
Representa una colección de todas las etiquetas de datos de la serie.
readonly dataLabels: Excel.ChartDataLabels;
Valor de propiedad
Comentarios
doughnutHoleSize
Representa el tamaño del agujero de los anillos de una serie de gráfico. Solo es válido en los gráficos de anillos y anillos explotados. Produce un InvalidArgument
error en gráficos no válidos.
doughnutHoleSize: number;
Valor de propiedad
number
Comentarios
explosion
Especifica el valor de explosión de un gráfico circular o un segmento de gráfico de anillos. Devuelve 0 (cero) si no hay expansión (el vértice del sector está en el centro del círculo).
explosion: number;
Valor de propiedad
number
Comentarios
filtered
Especifica si la serie está filtrada. No aplicable para los gráficos de superficie.
filtered: boolean;
Valor de propiedad
boolean
Comentarios
firstSliceAngle
Especifica el ángulo del primer gráfico circular o segmento de gráfico de anillos, en grados (en el sentido de las agujas del reloj desde vertical). Se aplica solo a gráficos circulares, circulares 3D y de anillos. Puede ser un valor comprendido entre 0 y 360.
firstSliceAngle: number;
Valor de propiedad
number
Comentarios
format
Representa el formato de una serie del gráfico, que incluye el formato de relleno y de línea.
readonly format: Excel.ChartSeriesFormat;
Valor de propiedad
Comentarios
gapWidth
Representa el ancho del rango de una serie de gráfico. Solo es válido en gráficos de barras y columnas, así como clases específicas de gráficos circulares y de líneas. Produce una excepción de argumento no válida en gráficos no válidos.
gapWidth: number;
Valor de propiedad
number
Comentarios
gradientMaximumColor
Especifica el color del valor máximo de una serie de gráficos de mapa de regiones.
gradientMaximumColor: string;
Valor de propiedad
string
Comentarios
gradientMaximumType
Especifica el tipo para el valor máximo de una serie de gráficos de mapa de regiones.
gradientMaximumType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";
Valor de propiedad
Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"
Comentarios
gradientMaximumValue
Especifica el valor máximo de una serie de gráficos de mapa de regiones.
gradientMaximumValue: number;
Valor de propiedad
number
Comentarios
gradientMidpointColor
Especifica el color del valor de punto medio de una serie de gráficos de mapa de regiones.
gradientMidpointColor: string;
Valor de propiedad
string
Comentarios
gradientMidpointType
Especifica el tipo para el valor de punto medio de una serie de gráficos de mapa de regiones.
gradientMidpointType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";
Valor de propiedad
Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"
Comentarios
gradientMidpointValue
Especifica el valor de punto medio de una serie de gráficos de mapa de regiones.
gradientMidpointValue: number;
Valor de propiedad
number
Comentarios
gradientMinimumColor
Especifica el color del valor mínimo de una serie de gráficos de mapa de regiones.
gradientMinimumColor: string;
Valor de propiedad
string
Comentarios
gradientMinimumType
Especifica el tipo para el valor mínimo de una serie de gráficos de mapa de regiones.
gradientMinimumType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";
Valor de propiedad
Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"
Comentarios
gradientMinimumValue
Especifica el valor mínimo de una serie de gráficos de mapa de regiones.
gradientMinimumValue: number;
Valor de propiedad
number
Comentarios
gradientStyle
Especifica el estilo de degradado de serie de un gráfico de mapa de regiones.
gradientStyle: Excel.ChartGradientStyle | "TwoPhaseColor" | "ThreePhaseColor";
Valor de propiedad
Excel.ChartGradientStyle | "TwoPhaseColor" | "ThreePhaseColor"
Comentarios
hasDataLabels
Especifica si la serie tiene etiquetas de datos.
hasDataLabels: boolean;
Valor de propiedad
boolean
Comentarios
invertColor
Especifica el color de relleno de los puntos de datos negativos de una serie.
invertColor: string;
Valor de propiedad
string
Comentarios
invertIfNegative
True si Excel invierte el patrón en el elemento cuando corresponde a un número negativo.
invertIfNegative: boolean;
Valor de propiedad
boolean
Comentarios
mapOptions
Contiene las opciones para un gráfico de mapa de región.
readonly mapOptions: Excel.ChartMapOptions;
Valor de propiedad
Comentarios
markerBackgroundColor
Especifica el color de fondo del marcador de una serie de gráficos.
markerBackgroundColor: string;
Valor de propiedad
string
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml
await Excel.run(async (context) => {
let sheet = context.workbook.worksheets.getItem("Sample");
let salesTable = sheet.tables.getItem("SalesTable");
let dataRange = sheet.getRange("A1:E7");
// Create an XY scatter chart.
let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
chart.title.text = "Bicycle Parts Quarterly Sales";
let series = chart.series;
let series0 = series.getItemAt(0);
let series1 = series.getItemAt(1);
let series2 = series.getItemAt(2);
let series3 = series.getItemAt(3);
// Set markers.
series0.markerStyle = "Dash";
series0.markerForegroundColor = "black";
series1.markerStyle = "Star";
series1.markerForegroundColor = "black";
series2.markerStyle = "X";
series2.markerSize = 12;
series3.markerStyle = "Triangle";
series3.markerBackgroundColor = "purple";
await context.sync();
});
markerForegroundColor
Especifica el color de primer plano del marcador de una serie de gráficos.
markerForegroundColor: string;
Valor de propiedad
string
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml
await Excel.run(async (context) => {
let sheet = context.workbook.worksheets.getItem("Sample");
let salesTable = sheet.tables.getItem("SalesTable");
let dataRange = sheet.getRange("A1:E7");
// Create an XY scatter chart.
let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
chart.title.text = "Bicycle Parts Quarterly Sales";
let series = chart.series;
let series0 = series.getItemAt(0);
let series1 = series.getItemAt(1);
let series2 = series.getItemAt(2);
let series3 = series.getItemAt(3);
// Set markers.
series0.markerStyle = "Dash";
series0.markerForegroundColor = "black";
series1.markerStyle = "Star";
series1.markerForegroundColor = "black";
series2.markerStyle = "X";
series2.markerSize = 12;
series3.markerStyle = "Triangle";
series3.markerBackgroundColor = "purple";
await context.sync();
});
markerSize
Especifica el tamaño del marcador de una serie de gráficos. El intervalo de tamaño admitido es de 2 a 72. Este método devuelve un error InvalidArgument si se establece con un tamaño fuera del intervalo admitido.
markerSize: number;
Valor de propiedad
number
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml
await Excel.run(async (context) => {
let sheet = context.workbook.worksheets.getItem("Sample");
let salesTable = sheet.tables.getItem("SalesTable");
let dataRange = sheet.getRange("A1:E7");
// Create an XY scatter chart.
let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
chart.title.text = "Bicycle Parts Quarterly Sales";
let series = chart.series;
let series0 = series.getItemAt(0);
let series1 = series.getItemAt(1);
let series2 = series.getItemAt(2);
let series3 = series.getItemAt(3);
// Set markers.
series0.markerStyle = "Dash";
series0.markerForegroundColor = "black";
series1.markerStyle = "Star";
series1.markerForegroundColor = "black";
series2.markerStyle = "X";
series2.markerSize = 12;
series3.markerStyle = "Triangle";
series3.markerBackgroundColor = "purple";
await context.sync();
});
markerStyle
Especifica el estilo de marcador de una serie de gráficos. Vea Excel.ChartMarkerStyle
para más información.
markerStyle: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture";
Valor de propiedad
Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml
await Excel.run(async (context) => {
let sheet = context.workbook.worksheets.getItem("Sample");
let salesTable = sheet.tables.getItem("SalesTable");
let dataRange = sheet.getRange("A1:E7");
// Create an XY scatter chart.
let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
chart.title.text = "Bicycle Parts Quarterly Sales";
let series = chart.series;
let series0 = series.getItemAt(0);
let series1 = series.getItemAt(1);
let series2 = series.getItemAt(2);
let series3 = series.getItemAt(3);
// Set markers.
series0.markerStyle = "Dash";
series0.markerForegroundColor = "black";
series1.markerStyle = "Star";
series1.markerForegroundColor = "black";
series2.markerStyle = "X";
series2.markerSize = 12;
series3.markerStyle = "Triangle";
series3.markerBackgroundColor = "purple";
await context.sync();
});
name
Especifica el nombre de una serie en un gráfico. La longitud del nombre no debe tener más de 255 caracteres.
name: string;
Valor de propiedad
string
Comentarios
overlap
Especifica cómo se colocan las barras y columnas. Puede ser un valor comprendido entre -100 y 100. Se aplica solo a los gráficos 2D de barras y columnas.
overlap: number;
Valor de propiedad
number
Comentarios
parentLabelStrategy
Especifica el área de estrategia de etiqueta primaria de la serie para un gráfico de gráficos de rectángulos.
parentLabelStrategy: Excel.ChartParentLabelStrategy | "None" | "Banner" | "Overlapping";
Valor de propiedad
Excel.ChartParentLabelStrategy | "None" | "Banner" | "Overlapping"
Comentarios
plotOrder
Especifica el orden de trazado de una serie de gráficos dentro del grupo de gráficos.
plotOrder: number;
Valor de propiedad
number
Comentarios
points
Devuelve una colección de todos los puntos de la serie.
readonly points: Excel.ChartPointsCollection;
Valor de propiedad
Comentarios
secondPlotSize
Especifica el tamaño de la sección secundaria de un gráfico circular o un gráfico de barras circulares, como un porcentaje del tamaño del gráfico circular principal. Puede ser un valor comprendido entre 5 y 200.
secondPlotSize: number;
Valor de propiedad
number
Comentarios
showConnectorLines
Especifica si las líneas del conector se muestran en gráficos en cascada.
showConnectorLines: boolean;
Valor de propiedad
boolean
Comentarios
showLeaderLines
Especifica si se muestran líneas de directriz para cada etiqueta de datos de la serie.
showLeaderLines: boolean;
Valor de propiedad
boolean
Comentarios
showShadow
Especifica si la serie tiene una sombra.
showShadow: boolean;
Valor de propiedad
boolean
Comentarios
smooth
Especifica si la serie es suave. Solo se aplica a gráficos de líneas y dispersión.
smooth: boolean;
Valor de propiedad
boolean
Comentarios
splitType
Especifica la forma en que se dividen las dos secciones de un gráfico circular de pie o de una barra de gráfico circular.
splitType: Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit";
Valor de propiedad
Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit"
Comentarios
splitValue
Especifica el valor de umbral que separa dos secciones de un gráfico circular de gráfico circular o un gráfico de barras circulares.
splitValue: number;
Valor de propiedad
number
Comentarios
trendlines
Colección de líneas de tendencia de la serie.
readonly trendlines: Excel.ChartTrendlineCollection;
Valor de propiedad
Comentarios
varyByCategories
True si Excel asigna un color o patrón diferente a cada marcador de datos. El gráfico debe contener una sola serie.
varyByCategories: boolean;
Valor de propiedad
boolean
Comentarios
xErrorBars
Indica el objeto de la barra de error de una serie de gráficos.
readonly xErrorBars: Excel.ChartErrorBars;
Valor de propiedad
Comentarios
yErrorBars
Indica el objeto de la barra de error de una serie de gráficos.
readonly yErrorBars: Excel.ChartErrorBars;
Valor de propiedad
Comentarios
Detalles del método
delete()
Elimina la serie del gráfico.
delete(): void;
Devoluciones
void
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const seriesCollection = sheet.charts.getItemAt(0).series;
seriesCollection.load("count");
await context.sync();
if (seriesCollection.count > 0) {
const series = seriesCollection.getItemAt(0);
// Delete the first series.
series.delete();
}
await context.sync();
});
getDimensionValues(dimension)
Obtiene los valores de una sola dimensión de la serie de gráficos. Estos pueden ser valores de categoría o valores de datos, dependiendo de la dimensión especificada y de cómo se asignan los datos para la serie de gráficos.
getDimensionValues(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<string[]>;
Parámetros
- dimension
- Excel.ChartSeriesDimension
Dimensión del eje del que proceden los datos.
Devoluciones
OfficeExtension.ClientResult<string[]>
Comentarios
[ Conjunto de API: ExcelApi 1.12 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-bubble-chart.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
// The sample chart is of type `Excel.ChartType.bubble`.
const bubbleChart = sheet.charts.getItem("Product Chart");
// Get the first series in the chart.
const firstSeries = bubbleChart.series.getItemAt(0);
// Get the values for the dimensions we're interested in.
const bubbleSize = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.bubbleSizes);
const xValues = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.xvalues);
const yValues = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.yvalues);
const category = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.categories);
await context.sync();
// Log the information.
console.log(`Series ${category.value} - X:${xValues.value},Y:${yValues.value},Bubble:${bubbleSize.value}`);
});
getDimensionValues(dimensionString)
Obtiene los valores de una sola dimensión de la serie de gráficos. Estos pueden ser valores de categoría o valores de datos, dependiendo de la dimensión especificada y de cómo se asignan los datos para la serie de gráficos.
getDimensionValues(dimensionString: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<string[]>;
Parámetros
- dimensionString
-
"Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"
Dimensión del eje del que proceden los datos.
Devoluciones
OfficeExtension.ClientResult<string[]>
Comentarios
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.ChartSeriesLoadOptions): Excel.ChartSeries;
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.ChartSeries;
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
// Rename the 1st series of Chart1 to "New Series Name".
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.series.getItemAt(0).name = "New Series Name";
await context.sync();
console.log("Series1 Renamed");
});
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.ChartSeries;
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.ChartSeriesUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parámetros
- properties
- Excel.Interfaces.ChartSeriesUpdateData
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.ChartSeries): void;
Parámetros
- properties
- Excel.ChartSeries
Devoluciones
void
setBubbleSizes(sourceData)
Establece los tamaños de burbuja de una serie de gráficos. Solo funciona para los gráficos de burbujas.
setBubbleSizes(sourceData: Range): void;
Parámetros
- sourceData
- Excel.Range
Objeto Range
correspondiente a los datos de origen.
Devoluciones
void
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-bubble-chart.yaml
await Excel.run(async (context) => {
/*
The table is expected to look like this:
Product, Inventory, Price, Current Market Share
Calamansi, 2000, $2.45, 10%
...
We want each bubble to represent a single row.
*/
// Get the worksheet and table data.
const sheet = context.workbook.worksheets.getItem("Sample");
const table = sheet.tables.getItem("Sales");
const dataRange = table.getDataBodyRange();
// Get the table data without the row names.
const valueRange = dataRange.getOffsetRange(0, 1).getResizedRange(0, -1);
// Create the chart.
const bubbleChart = sheet.charts.add(Excel.ChartType.bubble, valueRange);
bubbleChart.name = "Product Chart";
// Remove the default series, since we want a unique series for each row.
bubbleChart.series.getItemAt(0).delete();
// Load the data necessary to make a chart series.
dataRange.load(["rowCount", "values"]);
await context.sync();
// For each row, create a chart series (a bubble).
for (let i = 0; i < dataRange.rowCount; i++) {
const newSeries = bubbleChart.series.add(dataRange.values[i][0], i);
newSeries.setXAxisValues(dataRange.getCell(i, 1));
newSeries.setValues(dataRange.getCell(i, 2));
newSeries.setBubbleSizes(dataRange.getCell(i, 3));
// Show the product name and market share percentage.
newSeries.dataLabels.showSeriesName = true;
newSeries.dataLabels.showBubbleSize = true;
newSeries.dataLabels.showValue = false;
}
await context.sync();
});
setValues(sourceData)
Establece los valores de una serie de gráficos. En el caso de los gráficos de dispersión, hace referencia a los valores del eje Y.
setValues(sourceData: Range): void;
Parámetros
- sourceData
- Excel.Range
Objeto Range
correspondiente a los datos de origen.
Devoluciones
void
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
let seriesCollection = sheet.charts.getItemAt(0);
let rangeSelection = sheet.getRange("C2:C7");
let xRangeSelection = sheet.getRange("A1:A7");
// Add a series.
let newSeries = seriesCollection.series.add("Qtr2");
newSeries.setValues(rangeSelection);
newSeries.setXAxisValues(xRangeSelection);
await context.sync();
});
setXAxisValues(sourceData)
Establece los valores del eje X para una serie de gráficos.
setXAxisValues(sourceData: Range): void;
Parámetros
- sourceData
- Excel.Range
Objeto Range
correspondiente a los datos de origen.
Devoluciones
void
Comentarios
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 original Excel.ChartSeries
es un objeto de API, el toJSON
método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ChartSeriesData
) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.ChartSeriesData;