SpreadJS 13
GC.Spread.Sheets Namespace / Worksheet type / setSparkline Method
The row index.
The column index.
The data range.
The data orientation.
The sparkline type.
The sparkline setting.
The date axis range.
The date axis range orientation.
In This Topic
    setSparkline Method
    In This Topic
    Sets the sparkline for a cell.
    Syntax
    var instance = new GC.Spread.Sheets.Worksheet(name);
    var value; // Type: Sparkline
    value = instance.setSparkline(row,
                                  col,
                                  dataRange,
                                  dataOrientation,
                                  sparklineType,
                                  sparklineSetting,
                                  dateAxisRange,
                                  dateAxisOrientation);
    function setSparkline( 
       row : number,
       col : number,
       dataRange : undefined,
       dataOrientation : DataOrientation,
       sparklineType : SparklineType,
       sparklineSetting : SparklineSetting,
       dateAxisRange : undefined,
       dateAxisOrientation : DataOrientation
    ) : Sparkline;

    Parameters

    row
    The row index.
    col
    The column index.
    dataRange
    The data range.
    dataOrientation
    The data orientation.
    sparklineType
    The sparkline type.
    sparklineSetting
    The sparkline setting.
    dateAxisRange
    The date axis range.
    dateAxisOrientation
    The date axis range orientation.

    Return Value

    The sparkline.
    Example
    This example creates a sparkline for the specified range.
    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);
    sheet.setValue(8, 0, 8);
    See Also

    Reference

    Worksheet type