Class: SparklineSetting

Sheets.Sparklines.SparklineSetting

Table of contents

Constructors

• constructor

Properties

• options

Methods

• clone

Constructors

constructor

• new SparklineSetting(setting?)

Creates the sparkline settings.

Parameters

Properties

options

• options: ISparklineSetting

Indicates the options for the sparkline. options.axisColor the color of the axis options.firstMarkerColor the color of the first data point for each sparkline in this sparkline group options.highMarkerColor the color of the highest data point for each sparkline in this sparkline group options.lastMarkerColor the color of the last data point for each sparkline in this sparkline group options.lowMarkerColor the color of the lowest data point for each sparkline in this sparkline group options.markersColor a value that specifies the color of the data markers for each sparkline in this sparkline group options.negativeColor a value that specifies the color of the negative data points for each sparkline in this sparkline group options.seriesColor a value that specifies the color for each sparkline in this sparkline group options.displayEmptyCellsAs Indicates how to display the empty cells options.rightToLeft Indicates whether each sparkline in the sparkline group is displayed in a right-to-left manner options.displayHidden Indicates whether data in hidden cells is plotted for the sparklines in this sparkline group options.displayXAxis Indicates whether the horizontal axis is displayed for each sparkline in this sparkline group options.showFirst a value that indicates whether the first data point is formatted differently for each sparkline in this sparkline group options.showHigh a value that specifies whether the data points with the highest value are formatted differently for each sparkline in this sparkline group options.showLast a value that indicates whether the last data point is formatted differently for each sparkline in this sparkline group options.showLow a value that specifies whether the data points with the lowest value are formatted differently for each sparkline in this sparkline group options.showNegative a value that specifies whether the negative data points are formatted differently for each sparkline in this sparkline group options.showMarkers a value that specifies whether data markers are displayed for each sparkline in this sparkline group options.manualMax Indicates the maximum for the vertical axis that is shared across all sparklines in this sparkline group. The axis is zero if maxAxisType does not equal custom options.manualMin Indicates the minimum for the vertical axis that is shared across all sparklines in this sparkline group. The axis is zero if minAxisType does not equal custom options.maxAxisType Indicates how the vertical axis maximum is calculated for the sparklines in this sparkline group options.minAxisType Indicates how the vertical axis minimum is calculated for the sparklines in this sparkline group options.groupMaxValue Gets the maximum value of the sparkline group options.groupMinValue Gets the minimum value of the sparkline group options.lineWeight Indicates the line weight for each sparkline in the sparkline group, where the line weight is measured in points. The weight must be greater than or equal to zero, and must be less than or equal to 3 (LineSeries only supports line weight values in the range of 0.0-3.0)

example

var data = new GC.Spread.Sheets.Range(1, 0, 8, 1);
var setting = new GC.Spread.Sheets.Sparklines.SparklineSetting();
setting.options.showMarkers = true;
setting.options.lineWeight = 3;
setting.options.displayXAxis = true;
setting.options.showFirst = true;
setting.options.showLast = true;
setting.options.showLow = true;
setting.options.showHigh = true;
setting.options.showNegative = true;
setting.options.seriesColor = "Text 2 1";
setting.options.firstMarkerColor = "Text 2 3";
setting.options.negativeColor = "Accent 2 1";
setting.options.markersColor = "Accent 3 1";
setting.options.lowMarkerColor = "Accent 4 1";
setting.options.highMarkerColor = "Accent 6 1";
setting.options.lastMarkerColor = "Accent 6 6";
setting.options.axisColor ="Text 1 1";
sheet.addSpan(13, 0, 4, 3, null);
sheet.setSparkline(13, 0, data, GC.Spread.Sheets.Sparklines.DataOrientation.Vertical, GC.Spread.Sheets.Sparklines.SparklineType.line, setting);
sheet.setValue(1, 0, 1);
sheet.setValue(2, 0, -2);
sheet.setValue(3, 0, -1);
sheet.setValue(4, 0, 6);
sheet.setValue(5, 0, 4);
sheet.setValue(6, 0, -4);
sheet.setValue(7, 0, 3);

Methods

clone

▸ clone(): SparklineSetting

Clones sparkline settings.

Returns

SparklineSetting

The cloned sparkline setting.