FacetFilter Control.
Constructor for a new FacetFilter.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
new sap.ui.ux3.FacetFilter(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | id for the new control, generated automatically if no id is given |
|
mSettings? | object | initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
visibleItemCountMode | sap.ui.ux3.VisibleItemCountMode | Fixed | If the value is "Auto" - the Facet Filter takes the whole available height. If "Fixed" , then the default number of Facet Filter Items (5) is visible. Visibility: public |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
lists | 0..n | sap.ui.ux3.FacetFilterList |
Facet Filter list represents the list of the filter values and the title of this list. |
Method | Description |
---|---|
addList |
Adds some list to the aggregation lists. |
destroyLists |
Destroys all the lists in the aggregation lists. |
sap.ui.ux3.FacetFilter.extend |
Creates a new subclass of class sap.ui.ux3.FacetFilter with name
|
getLists |
Gets content of aggregation lists. Facet Filter list represents the list of the filter values and the title of this list. |
sap.ui.ux3.FacetFilter.getMetadata |
Returns a metadata object for class sap.ui.ux3.FacetFilter. |
getVisibleItemCountMode |
Gets current value of property visibleItemCountMode. If the value is "Auto" - the Facet Filter takes the whole available height. If "Fixed" , then the default number of Facet Filter Items (5) is visible. Default value is |
indexOfList |
Checks for the provided |
insertList |
Inserts a list into the aggregation lists. |
removeAllLists |
Removes all the controls from the aggregation lists. Additionally, it unregisters them from the hosting UIArea. |
removeList |
Removes a list from the aggregation lists. |
setVisibleItemCountMode |
Sets a new value for property visibleItemCountMode. If the value is "Auto" - the Facet Filter takes the whole available height. If "Fixed" , then the default number of Facet Filter Items (5) is visible. When called with a value of Default value is |
Adds some list to the aggregation lists.
Param | Type | DefaultValue | Description |
---|---|---|---|
oList | sap.ui.ux3.FacetFilterList |
The list to add; if empty, nothing is inserted |
Creates a new subclass of class sap.ui.ux3.FacetFilter with name sClassName
and enriches it with the information contained in oClassInfo
.
oClassInfo
might contain the same kind of information as described in sap.ui.core.Control.extend.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Gets content of aggregation lists.
Facet Filter list represents the list of the filter values and the title of this list.
Gets current value of property visibleItemCountMode.
If the value is "Auto" - the Facet Filter takes the whole available height. If "Fixed" , then the default number of Facet Filter Items (5) is visible.
Default value is Fixed
.
Checks for the provided sap.ui.ux3.FacetFilterList
in the aggregation lists. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oList | sap.ui.ux3.FacetFilterList |
The list whose index is looked for |
Inserts a list into the aggregation lists.
Param | Type | DefaultValue | Description |
---|---|---|---|
oList | sap.ui.ux3.FacetFilterList |
The list to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation lists.
Additionally, it unregisters them from the hosting UIArea.
Removes a list from the aggregation lists.
Param | Type | DefaultValue | Description |
---|---|---|---|
vList | int string sap.ui.ux3.FacetFilterList |
The list to remove or its index or id |
Sets a new value for property visibleItemCountMode.
If the value is "Auto" - the Facet Filter takes the whole available height. If "Fixed" , then the default number of Facet Filter Items (5) is visible.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Fixed
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sVisibleItemCountMode | sap.ui.ux3.VisibleItemCountMode | Fixed |
New value for property |