IconFilter

IconFilter class

Represents icon filter.

class IconFilter;

Constructors

ConstructorDescription
constructor(Object)Constructs from an Object convertible to this.

Properties

PropertyTypeDescription
iconSetTypeIconSetTypeGets and sets which icon set is used in the filter criteria.
iconIdnumberGets and sets Zero-based index of an icon in an icon set.

Methods

MethodDescription
getIconSetType()@deprecated. Please use the ‘iconSetType’ property instead. Gets and sets which icon set is used in the filter criteria.
setIconSetType(IconSetType)@deprecated. Please use the ‘iconSetType’ property instead. Gets and sets which icon set is used in the filter criteria.
getIconId()@deprecated. Please use the ‘iconId’ property instead. Gets and sets Zero-based index of an icon in an icon set.
setIconId(number)@deprecated. Please use the ‘iconId’ property instead. Gets and sets Zero-based index of an icon in an icon set.
isNull()Checks whether the implementation object is null.
toObject()Gets the Object.

constructor(Object)

Constructs from an Object convertible to this.

constructor(obj: Object);

Parameters:

ParameterTypeDescription
objObjectThe object.

iconSetType

Gets and sets which icon set is used in the filter criteria.

iconSetType : IconSetType;

iconId

Gets and sets Zero-based index of an icon in an icon set.

iconId : number;

getIconSetType()

@deprecated. Please use the ‘iconSetType’ property instead. Gets and sets which icon set is used in the filter criteria.

getIconSetType() : IconSetType;

Returns

IconSetType

setIconSetType(IconSetType)

@deprecated. Please use the ‘iconSetType’ property instead. Gets and sets which icon set is used in the filter criteria.

setIconSetType(value: IconSetType) : void;

Parameters:

ParameterTypeDescription
valueIconSetTypeThe value to set.

getIconId()

@deprecated. Please use the ‘iconId’ property instead. Gets and sets Zero-based index of an icon in an icon set.

getIconId() : number;

setIconId(number)

@deprecated. Please use the ‘iconId’ property instead. Gets and sets Zero-based index of an icon in an icon set.

setIconId(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

toObject()

Gets the Object.

toObject() : Object;