IconSetRule class

Represents an icon set rule with the specified parameters.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GcSpread.Sheets.IconSetRule(iconSetType);

function IconSetRule;

Example

This example creates a new icon set rule and sets the range and icon for it.

Javascript

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 cfs = activeSheet.getConditionalFormats();
var iconSetRule = new GcSpread.Sheets.IconSetRule();
iconSetRule.ranges =[new GcSpread.Sheets.Range(0,0,4,1)];
iconSetRule.iconSetType(GcSpread.Sheets.IconSetType.FourTrafficLights);
var iconCriteria = iconSetRule.iconCriteria();
iconCriteria[0] = new GcSpread.Sheets.IconCriterion(true, GcSpread.Sheets.IconValueType.Number, 1);
iconCriteria[1] = new GcSpread.Sheets.IconCriterion(true, GcSpread.Sheets.IconValueType.Number, 10);
iconCriteria[2] = new GcSpread.Sheets.IconCriterion(true, GcSpread.Sheets.IconValueType.Number, 20);
iconSetRule.reverseIconOrder(false);
iconSetRule.showIconOnly(false);
cfs.addRule(iconSetRule);

Inheritance Hierarchy

Object
GcSpread.Sheets.ScaleRule
GcSpread.Sheets.IconSetRule

Constructors

	Name	Description
	IconSetRule Constructor	Represents an icon set rule with the specified parameters.

Top

Fields

	Name	Description
	ranges	(Inherited from GcSpread.Sheets.ConditionRuleBase)
	style	(Inherited from GcSpread.Sheets.ConditionRuleBase)

Top

Methods

	Name	Description
	contains	(Inherited from GcSpread.Sheets.ConditionRuleBase)
	evaluate	Returns the specified value of the rule if the cell meets the condition.
	getExpected	(Inherited from GcSpread.Sheets.ConditionRuleBase)
	getIcon	Gets the icon based on the specific iconSetType and iconIndex.
	iconCriteria	Gets the icon criteria.
	iconSetType	Gets or sets the type of icon set.
	intersects	(Inherited from GcSpread.Sheets.ConditionRuleBase)
	priority	(Inherited from GcSpread.Sheets.ConditionRuleBase)
	reset	Resets the rule.
	reverseIconOrder	Gets or sets whether to reverse icon order.
	showIconOnly	Gets or sets whether to display the icon only.
	stopIfTrue	(Inherited from GcSpread.Sheets.ScaleRule)

Top

Reference

GcSpread.Sheets Namespace
Using the Icon Set Rule