FacetNode Class Methods
In this section, the FacetNode class methods are presented in alphabetical order.
Syntax
addChild(&node)
Description
Use this method to add a child facet node to the current facet node.
Parameters
Field or Control |
Definition |
---|---|
&node |
Specifies the child facet node as a FacetNode object. |
Returns
None.
Syntax
FacetNode(FacetName, NodeName, Path, DisplayValue, DocCount)
Description
Use this constructor to instantiate a FacetNode object for a specific facet.
Parameters
Field or Control |
Definition |
---|---|
FacetName |
Specifies the name of the facet as a string and is used to refer to that member of the superclass. |
NodeName |
Specifies the name of this facet node as a string. |
Path |
Specifies the value of the facet as a string and is used to refer to that member of the superclass. |
DisplayValue |
Specifies the display value for this facet node as a string. |
DocCount |
Specifies an integer representing the number of documents that would be returned if this facet node were selected as a search filter. |
Returns
A FacetNode object.
Syntax
getChildNodes()
Description
Use this method to return an array of child nodes.
Parameters
None.
Returns
An array of FacetNode objects.