SpreadJS 13
GC.Spread.Sheets.ConditionalFormatting Namespace / DataBarRule class / showBarOnly Method
Whether to display the data bar without text.
In This Topic
    showBarOnly Method
    In This Topic
    Gets or sets whether to display the data bar without text.
    Syntax
    var instance = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule(minType, minValue, maxType, maxValue, color, ranges);
    var returnValue; // Type: any
    returnValue = instance.showBarOnly(value);
    function showBarOnly( 
       value : boolean
    ) : any;

    Parameters

    value
    Whether to display the data bar without text.

    Return Value

    If no value is set, returns whether the widget displays the data bar without text; otherwise, returns the data bar rule.
    Example
    This example uses the showBarOnly method.
    activeSheet.setValue(0,0,1,3);
    activeSheet.setValue(1,0,15,3);
    activeSheet.setValue(2,0,25,3);
    activeSheet.setValue(3,0,-1,3);
    
    var dataBarRule = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule();
    dataBarRule.ranges([new GC.Spread.Sheets.Range(0,0,4,1)]);
    dataBarRule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
    dataBarRule.minValue(-1);
    dataBarRule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
    dataBarRule.maxValue(40);
    dataBarRule.color("green");
    dataBarRule.showBorder(true);
    dataBarRule.borderColor("orange");
    dataBarRule.dataBarDirection(GC.Spread.Sheets.ConditionalFormatting.BarDirection.leftToRight);
    dataBarRule.negativeFillColor("yellow");
    dataBarRule.useNegativeFillColor(true);
    dataBarRule.negativeBorderColor("red");
    dataBarRule.useNegativeBorderColor(true);
    dataBarRule.axisPosition(GC.Spread.Sheets.ConditionalFormatting.DataBarAxisPosition.automatic);
    dataBarRule.axisColor("blue");
    dataBarRule.showBarOnly(false);
    activeSheet.conditionalFormats.addRule(dataBarRule);
    Remarks
    The default value is false.
    See Also