Constructor
new FilterRefineBy(filterTreeType)
Creates a new FilterRefineBy
Parameters:
Name | Type | Description |
---|---|---|
filterTreeType |
FilterTreeEnum | 'vertical' or 'horizontal' |
Extends
Members
children :Array
Array of child components
Type:
- Array
- Overrides:
- Default Value:
- []
- Source:
parent :Component
The parent component
Type:
- Component
- Overrides:
- Default Value:
- null
- Source:
refineByItems :Array
List of refine by items
Type:
- Array
Methods
_callAllBindEvents()
Bind events on the component (include all child-components)
- Overrides:
- Source:
_callAllInit()
Initialize the component (include all child-components)
- Overrides:
- Source:
_callAllRender()
Render the component (include all child-components)
- Overrides:
- Source:
addComponent(childComponent)
Add the child component into a component
Parameters:
Name | Type | Description |
---|---|---|
childComponent |
Object | The child component |
- Overrides:
- Source:
afterBindEvents()
After bind evnets on the component
- Overrides:
- Source:
afterInit()
After initialize callback
- Overrides:
- Source:
afterRender()
After reder component callback
- Overrides:
- Source:
beforeBindEvents()
Before bind events on component callback
- Overrides:
- Source:
beforeInit()
Before initialize callback
- Overrides:
- Source:
beforeRender()
Before reder component callback
- Overrides:
- Source:
bindEvents()
Bind events on the component
- Overrides:
- Source:
getTemplate() → {string}
Get the refine by's html template.
Depending on its filterTreeType, it returns different templates for 'vertical' and 'horizontal'
Returns:
Raw html template
- Type
- string
init()
Initialize component
- Overrides:
- Source:
isBindEvents()
Returns whether or not binding the events on a component
- Overrides:
- Source:
isLoopThroughChild()
Returns whether or not the childs of a component is refresh
- Overrides:
- Source:
isRender()
Returns whether or not the component is rendered
- Overrides:
- Source:
refresh()
Refresh component
- Overrides:
- Source:
removeComponent(childComponent)
Remove a child component of a component
Parameters:
Name | Type | Description |
---|---|---|
childComponent |
Object | The child component |
- Overrides:
- Source:
render()
Render compoment
- Overrides:
- Source:
setData()
Set data for refine by.
It doesn't have input param, because it gets the data from existing filter option.
Call this setData function after you've called setData on filter options.