gem.control. CategoryFilterControl

Control for displaying a categories (properties) filter applied to a data source control

Constructor

new CategoryFilterControl(filterOptions, addedDataControl)

Parameters:
NameTypeDescription
filterOptionsobject

category filter options

Properties
NameTypeAttributesDefaultDescription
parentContainerstring

the parent element id where to add the filter element

collapsiblebool<optional>
true

create a collapsible filter

startCollapsedbool<optional>
true

show filter categories collapsed at start-up

namestring

unique name of the filter

titlestring<optional>

title text to display for the filter

categoriesArray.<object>
Properties
NameTypeDescription
labelstring

label text to display for the filter option

filterobject
Properties
NameTypeDescription
keystring

data source item property key to filter

valuestring

data source item property value to filter

childrenobject

applicable for 'checkboxes' style

stylestring<optional>
'radio'

available options 'radio', 'checkboxes'

cssClassesobject<optional>

customize filter style rules

Properties
NameTypeAttributesDescription
containerstring<optional>
filterHeaderstring<optional>
collapsiblestring<optional>
inputContainerstring<optional>
titleContainerstring<optional>
addedDataControlgem.control.AddedDataControl

data source control

Source