coveo-search-ui
Version:
Coveo JavaScript Search Framework
1,842 lines • 103 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>CategoryFacet | Coveo JavaScript Search Framework - Reference Documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="https://use.typekit.net/bqa0xml.css"></link>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.8.2/css/all.min.css" />
<link rel="stylesheet" href="../assets/css/main.css">
<link rel="stylesheet" href="../assets/css/overrides.css">
<link rel="stylesheet" href="../assets/css/coveo-connect-header.css">
<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10122/css/CoveoFullSearch.min.css" />
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>
<script type="text/javascript" src="https://static.cloud.coveo.com/coveo.analytics.js/coveoua.js"></script>
<script src="../assets/js/modernizr.js"></script>
<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10122/js/CoveoJsSearch.min.js"></script>
<script src="../assets/js/coveo-connect-header.js"></script>
<script src="../assets/gen/js/playground.js"></script>
<script src="../assets/js/searchUIrefDoc.js"></script>
<link href="../assets/favicon.ico" rel="shortcut icon" type="image/x-icon">
</head>
<body>
<header class="no-sticky">
<div class="content">
<div class="main-header">
<div class="logo">
<a class="logo-img-wrap" href="https://coveo.com">
<div class="logo-imgbg">
<svg width="124" height="32" viewBox="0 0 409 104" fill="none" xmlns="http://www.w3.org/2000/svg">
<g clip-path="url(#clip0)">
<path d="M164.7 36.2L159.8 41.4C156.4 38.1 152.8 36.2 147.9 36.2C139.4 36.2 133 42.9 133 52.3C133 61.7 139.4 68.4 147.9 68.4C152.5 68.4 156.9 66.5 160.1 63.2L164.7 68.4C160.7 73 155 75.4 148.3 75.4C134.3 75.4 125.2 65.4 125.2 52.3C125.2 38.9 134.3 28.9 148.3 28.9C154.6 28.8 160.6 31.5 164.7 36.2Z" fill="white"/>
<path d="M219.4 52.3C219.4 65.4 209.4 75.4 196 75.4C182.3 75.4 172.3 65.4 172.3 52.3C172.3 38.9 182.3 28.9 196 28.9C209.4 28.9 219.4 38.9 219.4 52.3ZM180.2 52.3C180.2 61.7 186.9 68.4 196 68.4C204.8 68.4 211.5 61.7 211.5 52.3C211.5 42.9 204.8 36.2 196 36.2C186.9 36.2 180.2 42.9 180.2 52.3Z" fill="white"/>
<path d="M252.3 74.5H243.1L224.3 30.1H232.8L247.7 66.9L262.6 30.1H270.8L252.3 74.5Z" fill="white"/>
<path d="M318.8 52V55H283.8C284.7 64.1 291.1 68.7 298.7 68.7C303.8 68.8 308.8 66.9 312.7 63.5L316.7 68.7C311.2 73.9 305.1 75.5 298.4 75.5C285 75.5 275.6 66.4 275.6 52.4C275.6 38.7 285 29 297.8 29C310 28.9 318.8 38.6 318.8 52ZM283.9 48.6H311.3C310.4 41 305.2 35.8 297.9 35.8C290 35.9 285.1 41 283.9 48.6Z" fill="white"/>
<path d="M376 52.3C376 65.4 366 75.4 352.6 75.4C338.9 75.4 328.9 65.4 328.9 52.3C328.9 38.9 338.9 28.9 352.6 28.9C365.9 28.9 376 38.9 376 52.3ZM336.8 52.3C336.8 61.7 343.5 68.4 352.6 68.4C361.4 68.4 368.1 61.7 368.1 52.3C368.1 42.9 361.4 36.2 352.6 36.2C343.4 36.2 336.8 42.9 336.8 52.3Z" fill="white"/>
<path d="M88.1 14.9C79.5 6.4 68.3 1.2 56.2 0C55.3 0 54.6 0.8 54.6 1.8C54.6 2.2 54.7 2.5 55 2.8L73.8 21.3C73.8 21.6 73.8 21.6 73.5 21.6C68.3 17.8 62.2 15.5 55.9 14.9C55.3 14.8 54.8 15.2 54.7 15.8C54.7 16.1 54.8 16.4 55 16.7L67.8 29.5C67.8 29.5 67.8 29.8 67.5 29.5C64 27.3 60.1 25.9 55.9 25.5C55.3 25.5 55 26.1 55.3 26.7L76.9 48.3C77.5 48.9 78.4 48.3 78.1 47.7C77.8 43.6 76.4 39.6 74.1 36.1C73.8 36.1 74.1 35.8 74.1 36.1L86.6 48.3C87.2 48.9 88.4 48.3 88.4 47.4C87.7 41 85.4 34.8 81.7 29.5C81.4 29.5 81.7 29.2 81.7 29.5L100.6 48C101.1 48.6 101.9 48.7 102.5 48.3C103 48 103.2 47.4 103 46.8C101.9 34.7 96.6 23.4 88.1 14.9Z" fill="#00ADFF"/>
<path d="M14.9 14.9C23.6 6.5 34.8 1.2 46.8 0C47.7 0 48.4 0.6 48.5 1.5C48.5 1.9 48.4 2.4 48 2.7L29.5 21.3C29.2 21.6 29.5 21.6 29.5 21.6C34.8 17.8 41 15.5 47.4 14.9C48.3 14.9 48.9 16.1 48.3 16.7L35.6 29.5C35.3 29.5 35.6 29.8 35.6 29.5C39.1 27.3 43 26 47.2 25.5C47.8 25.5 48.4 26.1 47.8 26.7L26.1 48.3C25.5 48.9 24.9 48.3 24.9 47.7C25.3 43.6 26.8 39.6 29.2 36.1C29.2 36.1 28.9 35.8 28.9 36.1L16.7 48.3C15.8 48.9 14.6 48.3 14.9 47.4C15.5 40.9 17.8 34.7 21.6 29.5C21.6 29.5 21.3 29.2 21.3 29.5L2.7 48C1.5 49.2 0 48.3 0 46.8C1.2 34.8 6.5 23.6 14.9 14.9Z" fill="#F05245"/>
<path d="M14.9 88.8C23.4 97.4 34.7 102.7 46.8 103.7C47.6 103.8 48.3 103.3 48.4 102.5C48.5 102 48.3 101.6 48 101.2L29.5 82.4C29.2 82.4 29.5 82.1 29.5 82.4C34.8 86.2 41 88.5 47.4 89C48.3 89 48.9 87.8 48.3 87.2L35.6 74.5C35.3 74.2 35.6 74.2 35.6 74.2C39 76.5 43 78 47.1 78.4C47.7 78.4 48.3 77.5 47.7 77.2L26.1 55.6C25.5 55 24.9 55.3 24.9 56.2C25.3 60.3 26.8 64.3 29.2 67.8C29.2 67.8 28.9 68.1 28.9 67.8L16.7 55.6C15.8 55 14.6 55.3 14.9 56.5C15.5 62.9 17.8 69 21.6 74.1C21.6 74.3 21.5 74.4 21.3 74.4L2.7 55.6C2 55 0.9 55.2 0.4 55.9C0.2 56.2 0.1 56.5 0 56.9C1.1 68.9 6.4 80.2 14.9 88.8Z" fill="#1CEBCF"/>
<path d="M88.1 88.8C79.6 97.5 68.3 102.8 56.2 103.7C55 104 54.1 102.2 55 101.3L73.8 82.5C73.8 82.5 73.8 82.2 73.5 82.5C68.3 86.3 62.2 88.6 55.9 89.2C55.3 89.3 54.8 88.8 54.7 88.2C54.7 87.9 54.8 87.6 55 87.3L67.8 74.5C67.8 74.2 67.8 74.2 67.5 74.2C64.1 76.6 60.1 78.1 56 78.4C55.5 78.3 55.2 77.9 55.3 77.5C55.3 77.4 55.3 77.3 55.4 77.2L77 55.6C77.6 55 78.5 55.3 78.2 56.2C77.9 60.3 76.5 64.3 74.2 67.8C73.9 67.8 74.2 68.1 74.2 67.8L86.7 55.6C87.1 55.2 87.8 55.2 88.2 55.6C88.4 55.8 88.5 56.2 88.5 56.5C87.8 62.8 85.5 68.9 81.8 74.1C81.5 74.4 81.8 74.4 81.8 74.4L100.6 55.6C101.5 54.7 103.3 55.6 103 56.8C102 68.9 96.7 80.2 88.1 88.8Z" fill="#FFE300"/>
<path opacity="0.87" d="M390.8 31.9V43H388.9V31.9H385.4V30.1H394.4V31.9H390.8Z" fill="white"/>
<path opacity="0.87" d="M407.7 43V34.4L404.7 40.5999H403.3L400.3 34.4V43H398.3V30.2H400.3L404 38.2L407.7 30.2H409.6V43H407.7Z" fill="white"/>
</g>
<defs>
<clipPath id="clip0">
<rect width="409" height="104" fill="white"/>
</clipPath>
</defs>
</svg>
</div>
</a>
<a class="logo-text" href="https://docs.coveo.com">
<span class="logo-text-bar">|</span>
<span class="logo-text-custom">docs</span>
</a>
</div>
<div class="search">
<div id="coveoConnectHeaderStandaloneSearchbox" class="searchbox">
<div class="CoveoSearchbox" style="display: flex;" type="text" data-auto-focus="false" data-enable-omnibox="true"
data-inline="false" data-enable-wildcards="true" data-enable-search-as-you-type="false"
data-enable-reveal-query-suggest-addon="true" data-enable-query-syntax="true"
data-enable-field-addon="true" data-placeholder="Search"></div>
<div class="CoveoAnalytics"></div>
</div>
</div>
<nav class="subnav">
<ul>
<li><a href="https://connect.coveo.com/" target="_blank">Community</a></li>
<li><a href="https://docs.google.com/forms/d/e/1FAIpQLSeyNL18g4JWIDR5xEyIMY48JIjyjwXRmlCveecjXBNSLh4Ygg/viewform?usp=sf_link" target="_blank">Feedback</a></li>
<li><a href="https://docs.coveo.com/en/3378/">News</a></li>
</ul>
</nav>
</div>
</div>
</header>
<subHeader class="no-sticky">
<div class="content">
<nav class="navBar">
<ul>
<li><button class="dropdownButton">Guides<i class="fas fa-chevron-down"></i>
<ul class="dropdown">
<li><a href="https://docs.coveo.com/en/1724/">Searching With Coveo</a></li>
<li><a href="https://docs.coveo.com/en/2648/">Project Guide</a></li>
<li><a href="https://docs.coveo.com/en/1351/">Services</a></li>
</li>
</ul>
</button>
</li>
<li>
<button class="dropdownButton">API Reference<i class="fas fa-chevron-down"></i>
<ul class="dropdown">
<li><a href="https://coveo.github.io/search-ui/" target="_blank">JavaScript Search Framework</a></li>
<!-- <li><a href="#">Atomic</a></li> -->
<li><a href="https://docs.coveo.com/en/headless/latest/reference/">Headless</a></li>
<li><a href="https://docs.coveo.com/en/12/">Push API</a></li>
<li><a href="https://docs.coveo.com/en/8/">Field API</a></li>
<li><a href="https://docs.coveo.com/en/13/">Search API</a></li>
<li><a href="https://docs.coveo.com/en/18/">Usage Analytics API</a></li>
<li><a href="https://docs.coveo.com/en/4/">Other APIs</a></li>
</ul>
</button>
</li>
<li>
<button class="dropdownButton">Extensions<i class="fas fa-chevron-down"></i>
<ul class="dropdown">
<li><a href="https://docs.coveo.com/en/1499/">Coveo for Commerce</a></li>
<li><a href="https://docs.coveo.com/en/1243/">Coveo for Salesforce</a></li>
<li><a href="https://docs.coveo.com/en/1479/">Coveo for ServiceNow</a></li>
<li><a href="https://docs.coveo.com/en/2709/">Coveo for Sitecore</a></li>
</ul>
</button>
</li>
</ul>
</nav>
</div>
</subHeader>
<div class="container container-main">
<div class="row">
<div id="toc-column" class="col-1 col-menu menu-sticky-wrap menu-highlight">
<div id="filter-box-container">
<div id="filter-box-header">Filter</div>
<div id="filter-box-body">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<div class="ctr-box-filter">
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited" title="Display inherited methods and properties"> Inherited</label><br>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="filter-box-footer"></div>
</div>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<a id="globals-toc-link" href=../globals.html><b>Globals</b></a>
</ul>
<ul class="current">
<li class="current tsd-kind-coveo-component">
<a href="categoryfacet.html" class="tsd-kind-icon">Category<wbr>Facet</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component">
<a href="categoryfacet.html#changeactivepath" class="tsd-kind-icon">change<wbr>Active<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited">
<a href="categoryfacet.html#debuginfo" class="tsd-kind-icon">debug<wbr>Info</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component">
<a href="categoryfacet.html#debugvalue" class="tsd-kind-icon">debug<wbr>Value</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component">
<a href="categoryfacet.html#deselectcurrentvalue" class="tsd-kind-icon">deselect<wbr>Current<wbr>Value</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited">
<a href="categoryfacet.html#disable" class="tsd-kind-icon">disable</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited">
<a href="categoryfacet.html#enable" class="tsd-kind-icon">enable</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component">
<a href="categoryfacet.html#getavailablevalues" class="tsd-kind-icon">get<wbr>Available<wbr>Values</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited">
<a href="categoryfacet.html#getbindings" class="tsd-kind-icon">get<wbr>Bindings</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component">
<a href="categoryfacet.html#getcaption" class="tsd-kind-icon">get<wbr>Caption</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component">
<a href="categoryfacet.html#getvisibleparentvalues" class="tsd-kind-icon">get<wbr>Visible<wbr>Parent<wbr>Values</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component">
<a href="categoryfacet.html#hide" class="tsd-kind-icon">hide</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component">
<a href="categoryfacet.html#reload" class="tsd-kind-icon">reload</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component">
<a href="categoryfacet.html#reset" class="tsd-kind-icon">reset</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component">
<a href="categoryfacet.html#selectvalue" class="tsd-kind-icon">select<wbr>Value</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component">
<a href="categoryfacet.html#show" class="tsd-kind-icon">show</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component">
<a href="categoryfacet.html#showless" class="tsd-kind-icon">show<wbr>Less</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component">
<a href="categoryfacet.html#showmore" class="tsd-kind-icon">show<wbr>More</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited tsd-is-static">
<a href="categoryfacet.html#get" class="tsd-kind-icon">get</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a href="categoryfacet.html#bind" class="tsd-kind-icon">bind</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a href="categoryfacet.html#componentoptionsmodel" class="tsd-kind-icon">component<wbr>Options<wbr>Model</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a href="categoryfacet.html#componentstatemodel" class="tsd-kind-icon">component<wbr>State<wbr>Model</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a href="categoryfacet.html#disabled" class="tsd-kind-icon">disabled</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a href="categoryfacet.html#logger" class="tsd-kind-icon">logger</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a href="categoryfacet.html#querycontroller" class="tsd-kind-icon">query<wbr>Controller</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a href="categoryfacet.html#querystatemodel" class="tsd-kind-icon">query<wbr>State<wbr>Model</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a href="categoryfacet.html#root" class="tsd-kind-icon">root</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a href="categoryfacet.html#searchinterface" class="tsd-kind-icon">search<wbr>Interface</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited tsd-is-static">
<a href="categoryfacet.html#id" class="tsd-kind-icon">ID</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-coveo-component tsd-is-inherited">
<a href="categoryfacet.html#usageanalytics" class="tsd-kind-icon">usage<wbr>Analytics</a>
</li>
<li class=" tsd-kind-object-literal tsd-parent-kind-coveo-component tsd-is-static">
<a href="categoryfacet.html#options" class="tsd-kind-icon">options</a>
</li>
<li class=" tsd-kind-constructor tsd-parent-kind-coveo-component tsd-is-inherited">
<a href="categoryfacet.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
<div id="separator"></div>
<div class="col-2 col-content">
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<a id="home-menu-link" class="aui-nav-link" title="Go to the home page" href=..>
<i class="fa fa-home" aria-hidden="true"></i>
</a>
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="categoryfacet.html">CategoryFacet</a>
</li>
</ul>
<h1>Coveo CategoryFacet Component (CoveoCategoryFacet)</h1>
</div>
</div>
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>The <code>CategoryFacet</code> component is a facet that renders values in a hierarchical fashion. It determines the filter to apply depending on the
current selected path of values.</p>
</div>
<p>The path is a sequence of values that leads to a specific value in the hierarchy.
It is an array listing all the parents of a file (e.g., <code>['c', 'folder1']</code> for the <code>c:\folder1\text1.txt</code> file).</p>
<p>This facet requires a <a href="categoryfacet.html#options.field"><code>field</code></a> with a special format to work correctly (see <a href="https://docs.coveo.com/en/2667">Using the Category Facet Component</a>).</p>
<dl class="tsd-comment-tags">
<dt>Not supported in</dt>
<dd><p><a href="https://docs.coveo.com/en/1107/">Coveo for Salesforce Free</a></p>
</dd>
<dt>Available since</dt>
<dd><p><a href="https://docs.coveo.com/en/3277/#january-2019-release-v2539512">January 2019 Release (v2.5395.12)</a></p>
</dd>
</dl>
</div>
</section>
<div class="preview-container tsd-panel">
<div class="overlay"></div>
</div>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-coveo-component"><a href="categoryfacet.html#changeactivepath" class="tsd-kind-icon">change<wbr>Active<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited"><a href="categoryfacet.html#debuginfo" class="tsd-kind-icon">debug<wbr>Info</a></li>
<li class="tsd-kind-method tsd-parent-kind-coveo-component"><a href="categoryfacet.html#debugvalue" class="tsd-kind-icon">debug<wbr>Value</a></li>
<li class="tsd-kind-method tsd-parent-kind-coveo-component"><a href="categoryfacet.html#deselectcurrentvalue" class="tsd-kind-icon">deselect<wbr>Current<wbr>Value</a></li>
<li class="tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited"><a href="categoryfacet.html#disable" class="tsd-kind-icon">disable</a></li>
<li class="tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited"><a href="categoryfacet.html#enable" class="tsd-kind-icon">enable</a></li>
<li class="tsd-kind-method tsd-parent-kind-coveo-component"><a href="categoryfacet.html#getavailablevalues" class="tsd-kind-icon">get<wbr>Available<wbr>Values</a></li>
<li class="tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited"><a href="categoryfacet.html#getbindings" class="tsd-kind-icon">get<wbr>Bindings</a></li>
<li class="tsd-kind-method tsd-parent-kind-coveo-component"><a href="categoryfacet.html#getcaption" class="tsd-kind-icon">get<wbr>Caption</a></li>
<li class="tsd-kind-method tsd-parent-kind-coveo-component"><a href="categoryfacet.html#getvisibleparentvalues" class="tsd-kind-icon">get<wbr>Visible<wbr>Parent<wbr>Values</a></li>
<li class="tsd-kind-method tsd-parent-kind-coveo-component"><a href="categoryfacet.html#hide" class="tsd-kind-icon">hide</a></li>
<li class="tsd-kind-method tsd-parent-kind-coveo-component"><a href="categoryfacet.html#reload" class="tsd-kind-icon">reload</a></li>
<li class="tsd-kind-method tsd-parent-kind-coveo-component"><a href="categoryfacet.html#reset" class="tsd-kind-icon">reset</a></li>
<li class="tsd-kind-method tsd-parent-kind-coveo-component"><a href="categoryfacet.html#selectvalue" class="tsd-kind-icon">select<wbr>Value</a></li>
<li class="tsd-kind-method tsd-parent-kind-coveo-component"><a href="categoryfacet.html#show" class="tsd-kind-icon">show</a></li>
<li class="tsd-kind-method tsd-parent-kind-coveo-component"><a href="categoryfacet.html#showless" class="tsd-kind-icon">show<wbr>Less</a></li>
<li class="tsd-kind-method tsd-parent-kind-coveo-component"><a href="categoryfacet.html#showmore" class="tsd-kind-icon">show<wbr>More</a></li>
<li class="tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited tsd-is-static"><a href="categoryfacet.html#get" class="tsd-kind-icon">get</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited"><a href="categoryfacet.html#bind" class="tsd-kind-icon">bind</a></li>
<li class="tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited"><a href="categoryfacet.html#componentoptionsmodel" class="tsd-kind-icon">component<wbr>Options<wbr>Model</a></li>
<li class="tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited"><a href="categoryfacet.html#componentstatemodel" class="tsd-kind-icon">component<wbr>State<wbr>Model</a></li>
<li class="tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited"><a href="categoryfacet.html#disabled" class="tsd-kind-icon">disabled</a></li>
<li class="tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited"><a href="categoryfacet.html#logger" class="tsd-kind-icon">logger</a></li>
<li class="tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited"><a href="categoryfacet.html#querycontroller" class="tsd-kind-icon">query<wbr>Controller</a></li>
<li class="tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited"><a href="categoryfacet.html#querystatemodel" class="tsd-kind-icon">query<wbr>State<wbr>Model</a></li>
<li class="tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited"><a href="categoryfacet.html#root" class="tsd-kind-icon">root</a></li>
<li class="tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited"><a href="categoryfacet.html#searchinterface" class="tsd-kind-icon">search<wbr>Interface</a></li>
<li class="tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited tsd-is-static"><a href="categoryfacet.html#id" class="tsd-kind-icon">ID</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-coveo-component tsd-is-inherited"><a href="categoryfacet.html#usageanalytics" class="tsd-kind-icon">usage<wbr>Analytics</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Component Options</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.basepath" class="tsd-kind-icon">base<wbr>Path</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.debug" class="tsd-kind-icon">debug</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.delimitingcharacter" class="tsd-kind-icon">delimiting<wbr>Character</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.dependson" class="tsd-kind-icon">depends<wbr>On</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.dependsoncondition" class="tsd-kind-icon">depends<wbr>OnCondition</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.displaysearchbutton" class="tsd-kind-icon">display<wbr>Search<wbr>Button</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.displaysearchontop" class="tsd-kind-icon">display<wbr>Search<wbr>OnTop</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.enablefacetsearch" class="tsd-kind-icon">enable<wbr>Facet<wbr>Search</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.enablemoreless" class="tsd-kind-icon">enable<wbr>More<wbr>Less</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.facetsearchdelay" class="tsd-kind-icon">facet<wbr>Search<wbr>Delay</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.field" class="tsd-kind-icon">field</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.id-1" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.injectiondepth" class="tsd-kind-icon">injection<wbr>Depth</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.maximumdepth" class="tsd-kind-icon">maximum<wbr>Depth</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.numberofresultsinfacetsearch" class="tsd-kind-icon">number<wbr>OfResults<wbr>InFacet<wbr>Search</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.numberofvalues" class="tsd-kind-icon">number<wbr>OfValues</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.pagesize" class="tsd-kind-icon">page<wbr>Size</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.title" class="tsd-kind-icon">title</a></li>
<li class="tsd-kind-variable tsd-parent-kind-object-literal"><a href="categoryfacet.html#options.valuecaption" class="tsd-kind-icon">value<wbr>Caption</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-coveo-component tsd-is-inherited"><a href="categoryfacet.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component">
<a name="changeactivepath" class="tsd-anchor"></a>
<h3>change<wbr>Active<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component">
<li class="tsd-signature tsd-kind-icon">change<wbr>Active<wbr>Path<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L515">ui/CategoryFacet/CategoryFacet.ts
:515</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Changes the active path.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path: <span class="tsd-signature-type">string[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited">
<a name="debuginfo" class="tsd-anchor"></a>
<h3>debug<wbr>Info</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">debug<wbr>Info<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/basecomponent.html">BaseComponent</a>.<a href="../classes/basecomponent.html#debuginfo">debugInfo</a></p>
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/BaseComponent.ts#L41">ui/Base/BaseComponent.ts
:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return the debug info about this component.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component">
<a name="debugvalue" class="tsd-anchor"></a>
<h3>debug<wbr>Value</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component">
<li class="tsd-signature tsd-kind-icon">debug<wbr>Value<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L678">ui/CategoryFacet/CategoryFacet.ts
:678</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Goes through any value that contains the value parameter, and verifies whether there are missing parents.
Issues are then logged in the console.
If you do not want to specify a value, you can simply enable <a href="categoryfacet.html#options.debug">CategoryFacet.options.debug</a> and do an empty query.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component">
<a name="deselectcurrentvalue" class="tsd-anchor"></a>
<h3>deselect<wbr>Current<wbr>Value</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component">
<li class="tsd-signature tsd-kind-icon">deselect<wbr>Current<wbr>Value<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L624">ui/CategoryFacet/CategoryFacet.ts
:624</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Deselects the last value in the hierarchy that is applied to the query. When at the top of the hierarchy, this method does nothing.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited">
<a name="disable" class="tsd-anchor"></a>
<h3>disable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">disable<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/basecomponent.html">BaseComponent</a>.<a href="../classes/basecomponent.html#disable">disable</a></p>
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/BaseComponent.ts#L52">ui/Base/BaseComponent.ts
:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Disable the component.
Normally this means that the component will not execute handlers for the framework events (query events, for example).
Components are enabled by default on creation.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited">
<a name="enable" class="tsd-anchor"></a>
<h3>enable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">enable<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/basecomponent.html">BaseComponent</a>.<a href="../classes/basecomponent.html#enable">enable</a></p>
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/BaseComponent.ts#L61">ui/Base/BaseComponent.ts
:61</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enable the component.
Normally this means that the component will execute handlers for the framework events (query events, for example).
Components are enabled by default on creation.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component">
<a name="getavailablevalues" class="tsd-anchor"></a>
<h3>get<wbr>Available<wbr>Values</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component">
<li class="tsd-signature tsd-kind-icon">get<wbr>Available<wbr>Values<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L592">ui/CategoryFacet/CategoryFacet.ts
:592</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the values at the bottom of the hierarchy. These are the values that are not yet applied to the query.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object[]</span></h4>
<p>simple object with three fields: <code>value</code>, <code>count</code> and <code>path</code>.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited">
<a name="getbindings" class="tsd-anchor"></a>
<h3>get<wbr>Bindings</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Bindings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/icomponentbindings.html" class="tsd-signature-type">IComponentBindings</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/component.html">Component</a>.<a href="../classes/component.html#getbindings">getBindings</a></p>
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/Component.ts#L328">ui/Base/Component.ts
:328</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return the bindings, or environment, for the current component.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/icomponentbindings.html" class="tsd-signature-type">IComponentBindings</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component">
<a name="getcaption" class="tsd-anchor"></a>
<h3>get<wbr>Caption</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component">
<li class="tsd-signature tsd-kind-icon">get<wbr>Caption<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L690">ui/CategoryFacet/CategoryFacet.ts
:690</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The string to find a caption for.
Returns the caption for a value or the value itself if no caption is available.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component">
<a name="getvisibleparentvalues" class="tsd-anchor"></a>
<h3>get<wbr>Visible<wbr>Parent<wbr>Values</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component">
<li class="tsd-signature tsd-kind-icon">get<wbr>Visible<wbr>Parent<wbr>Values<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CategoryValueDescriptor[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L541">ui/CategoryFacet/CategoryFacet.ts
:541</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns all the visible parent values.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CategoryValueDescriptor[]</span></h4>
<p>simple object with three fields: <code>value</code>, <code>count</code> and <code>path</code>.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component">
<a name="hide" class="tsd-anchor"></a>
<h3>hide</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component">
<li class="tsd-signature tsd-kind-icon">hide<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L652">ui/CategoryFacet/CategoryFacet.ts
:652</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hides the component.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component">
<a name="reload" class="tsd-anchor"></a>
<h3>reload</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component">
<li class="tsd-signature tsd-kind-icon">reload<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L531">ui/CategoryFacet/CategoryFacet.ts
:531</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Reloads the facet with the same path.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component">
<a name="reset" class="tsd-anchor"></a>
<h3>reset</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component">
<li class="tsd-signature tsd-kind-icon">reset<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L643">ui/CategoryFacet/CategoryFacet.ts
:643</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Resets the facet to its initial state.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component">
<a name="selectvalue" class="tsd-anchor"></a>
<h3>select<wbr>Value</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component">
<li class="tsd-signature tsd-kind-icon">select<wbr>Value<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L609">ui/CategoryFacet/CategoryFacet.ts
:609</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Selects a value from the currently available values.
If the given value to select is not in the available values, it will throw an error.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component">
<a name="show" class="tsd-anchor"></a>
<h3>show</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component">
<li class="tsd-signature tsd-kind-icon">show<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L659">ui/CategoryFacet/CategoryFacet.ts
:659</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Shows the component.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component">
<a name="showless" class="tsd-anchor"></a>
<h3>show<wbr>Less</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component">
<li class="tsd-signature tsd-kind-icon">show<wbr>Less<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L579">ui/CategoryFacet/CategoryFacet.ts
:579</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Shows less values, up to the original number of values.</p>
</div>
<p>See the <a href="categoryfacet.html#options.enablemoreless"><code>enableMoreLess</code></a>, and
<a href="categoryfacet.html#options.numberofvalues"><code>numberOfValues</code></a> options.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component">
<a name="showmore" class="tsd-anchor"></a>
<h3>show<wbr>More</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component">
<li class="tsd-signature tsd-kind-icon">show<wbr>More<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L564">ui/CategoryFacet/CategoryFacet.ts
:564</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Shows more values according to <a href="categoryfacet.html#options.pagesize">CategoryFacet.options.pageSize</a>.</p>
</div>
<p>See the <a href="categoryfacet.html#options.enablemoreless"><code>enableMoreLess</code></a>, and
<a href="categoryfacet.html#options.numberofvalues"><code>numberOfValues</code></a> options.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited tsd-is-static">
<a name="get" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> get</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-coveo-component tsd-is-inherited tsd-is-static">
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, componentClass<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, noThrow<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/basecomponent.html" class="tsd-signature-type">BaseComponent</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/component.html">Component</a>.<a href="../classes/component.html#get">get</a></p>
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/Component.ts#L410">ui/Base/Component.ts
:410</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the bound component to the given HTMLElement. Throws an assert if the HTMLElement has no component bound, unless using the noThrow argument.<br/>
If there is multiple component bound to the current HTMLElement, you must specify the component class.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>element: <span class="tsd-signature-type">HTMLElement</span></h5>
<div class="tsd-comment tsd-typography">
<p>HTMLElement for which to get the bound component.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> componentClass: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> noThrow: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>Boolean option to tell the method to not throw on error.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../classes/basecomponent.html" class="tsd-signature-type">BaseComponent</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a name="bind" class="tsd-anchor"></a>
<h3>bind</h3>
<div class="tsd-signature tsd-kind-icon">bind<span class="tsd-signature-symbol">:</span> <a href="../classes/componentevents.html" class="tsd-signature-type">ComponentEvents</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/component.html">Component</a>.<a href="../classes/component.html#bind">bind</a></p>
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/Component.ts#L270">ui/Base/Component.ts
:270</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>Allows the component to bind events and execute them only when it is enabled.</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{Coveo.ComponentEvents}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a name="componentoptionsmodel" class="tsd-anchor"></a>
<h3>component<wbr>Options<wbr>Model</h3>
<div class="tsd-signature tsd-kind-icon">component<wbr>Options<wbr>Model<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ComponentOptionsModel</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/component.html">Component</a>.<a href="../classes/component.html#componentoptionsmodel">componentOptionsModel</a></p>
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/Component.ts#L294">ui/Base/Component.ts
:294</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Contains the state of options for different components. Mainly used by <a href="resultlink.html">ResultLink</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a name="componentstatemodel" class="tsd-anchor"></a>
<h3>component<wbr>State<wbr>Model</h3>
<div class="tsd-signature tsd-kind-icon">component<wbr>State<wbr>Model<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ComponentStateModel</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/component.html">Component</a>.<a href="../classes/component.html#componentstatemodel">componentStateModel</a></p>
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/Component.ts#L282">ui/Base/Component.ts
:282</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers component state event when modified. Each component can listen to those events.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a name="disabled" class="tsd-anchor"></a>
<h3>disabled</h3>
<div class="tsd-signature tsd-kind-icon">disabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/basecomponent.html">BaseComponent</a>.<a href="../classes/basecomponent.html#disabled">disabled</a></p>
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/BaseComponent.ts#L23">ui/Base/BaseComponent.ts
:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>A disabled component will not participate in the query, or listen to <a href="../classes/componentevents.html">ComponentEvents</a>.</p>
</div>
<dl class="tsd-comment-tags">
<dt>type</dt>
<dd><p>{boolean}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a name="logger" class="tsd-anchor"></a>
<h3>logger</h3>
<div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Logger</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/basecomponent.html">BaseComponent</a>.<a href="../classes/basecomponent.html#logger">logger</a></p>
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/BaseComponent.ts#L18">ui/Base/BaseComponent.ts
:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Allows component to log in the dev console.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a name="querycontroller" class="tsd-anchor"></a>
<h3>query<wbr>Controller</h3>
<div class="tsd-signature tsd-kind-icon">query<wbr>Controller<span class="tsd-signature-symbol">:</span> <a href="../classes/querycontroller.html" class="tsd-signature-type">QueryController</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/component.html">Component</a>.<a href="../classes/component.html#querycontroller">queryController</a></p>
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/Component.ts#L286">ui/Base/Component.ts
:286</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Contains the singleton that allows to trigger queries.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a name="querystatemodel" class="tsd-anchor"></a>
<h3>query<wbr>State<wbr>Model</h3>
<div class="tsd-signature tsd-kind-icon">query<wbr>State<wbr>Model<span class="tsd-signature-symbol">:</span> <a href="../classes/querystatemodel.html" class="tsd-signature-type">QueryStateModel</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/component.html">Component</a>.<a href="../classes/component.html#querystatemodel">queryStateModel</a></p>
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/Component.ts#L278">ui/Base/Component.ts
:278</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a name="root" class="tsd-anchor"></a>
<h3>root</h3>
<div class="tsd-signature tsd-kind-icon">root<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLElement</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/component.html">Component</a>.<a href="../classes/component.html#root">root</a></p>
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/Component.ts#L274">ui/Base/Component.ts
:274</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A reference to the root HTMLElement (the <a href="searchinterface.html">SearchInterface</a>).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited">
<a name="searchinterface" class="tsd-anchor"></a>
<h3>search<wbr>Interface</h3>
<div class="tsd-signature tsd-kind-icon">search<wbr>Interface<span class="tsd-signature-symbol">:</span> <a href="searchinterface.html" class="tsd-signature-type">SearchInterface</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/component.html">Component</a>.<a href="../classes/component.html#searchinterface">searchInterface</a></p>
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/Component.ts#L290">ui/Base/Component.ts
:290</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A reference to the root of every component, the <a href="searchinterface.html">SearchInterface</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-coveo-component tsd-is-inherited tsd-is-static">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> ID</h3>
<div class="tsd-signature tsd-kind-icon">ID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/basecomponent.html">BaseComponent</a>.<a href="../classes/basecomponent.html#id">ID</a></p>
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/BaseComponent.ts#L28">ui/Base/BaseComponent.ts
:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The static ID that each component needs in order to be identified.<br/>
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-coveo-component tsd-is-inherited">
<a name="usageanalytics" class="tsd-anchor"></a>
<h3>usage<wbr>Analytics</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-coveo-component tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ianalyticsclient.html" class="tsd-signature-type">IAnalyticsClient</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/component.html">Component</a>.<a href="../classes/component.html#usageanalytics">usageAnalytics</a></p>
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/Component.ts#L343">ui/Base/Component.ts
:343</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A reference to the <a href="analytics.html#client">Analytics.client</a>.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/ianalyticsclient.html" class="tsd-signature-type">IAnalyticsClient</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Component Options</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.basepath" class="tsd-anchor"></a>
<h3>base<wbr>Path</h3>
<div class="tsd-signature tsd-kind-icon">base<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L233">ui/CategoryFacet/CategoryFacet.ts
:233</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>The path to use as the path prefix for every query.</p>
</div>
<p><strong>Example:</strong></p>
<p>You have the following files indexed on a file system:</p>
<pre><code>c:<span class="hljs-string">\</span>
folder1<span class="hljs-string">\</span>
text1.txt
folder2<span class="hljs-string">\</span>
folder3<span class="hljs-string">\</span>
text2.txt
</code></pre><p>Setting the <code>basePath</code> to <code>c</code> would display <code>folder1</code> and <code>folder2</code> in the <code>CategoryFacet</code>, but omit <code>c</code>.</p>
<p>This options accepts an array of values. To specify a "deeper" starting path in your tree, you need to use comma-separated values.</p>
<p>For example, setting <code>data-base-path="c,folder1"</code> on the component markup would display <code>folder3</code> in the <code>CategoryFacet</code>, but omit <code>c</code> and <code>folder1</code>.</p>
<dl class="tsd-comment-tags">
<dt>Default</dt>
<dd><p><code>[]</code></p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.debug" class="tsd-anchor"></a>
<h3>debug</h3>
<div class="tsd-signature tsd-kind-icon">debug<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L246">ui/CategoryFacet/CategoryFacet.ts
:246</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>Whether to activate field format debugging.
This options logs messages in the console for any potential encountered issues.
This option can have negative effects on performance, and should only be activated when debugging.</p>
</div>
<dl class="tsd-comment-tags">
<dt>Default</dt>
<dd><p><code>false</code></p>
</dd>
</dl>
</div>
<div class="tsd-panel">
<div class="tsd-signature-type">Markup configuration example(s) :</div>
<pre>data-debug='true'
data-debug='false'</pre>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.delimitingcharacter" class="tsd-anchor"></a>
<h3>delimiting<wbr>Character</h3>
<div class="tsd-signature tsd-kind-icon">delimiting<wbr>Character<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L211">ui/CategoryFacet/CategoryFacet.ts
:211</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>The character that specifies the hierarchical dependency.</p>
</div>
<p><strong>Example:</strong></p>
<p>If your field has the following values:</p>
<p><code>@field: c; c>folder2; c>folder2>folder3;</code></p>
<p>The delimiting character is <code>></code>.</p>
<p>Default value is <code>|</code>.</p>
<dl class="tsd-comment-tags">
<dt>Default</dt>
<dd><p><code>|</code></p>
</dd>
</dl>
</div>
<div class="tsd-panel">
<div class="tsd-signature-type">Markup configuration example(s) :</div>
<pre>data-delimiting-character='foo'</pre>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.dependson" class="tsd-anchor"></a>
<h3>depends<wbr>On</h3>
<div class="tsd-signature tsd-kind-icon">depends<wbr>On<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L295">ui/CategoryFacet/CategoryFacet.ts
:295</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>The <a href="@link Facet.options.id">id</a> of another facet in which at least one value must be selected in order
for the dependent category facet to be visible.</p>
</div>
<p><strong>Default:</strong> <code>undefined</code> and the category facet does not depend on any other facet to be displayed.</p>
<dl class="tsd-comment-tags">
<dt>Available since</dt>
<dd><p><a href="https://docs.coveo.com/en/2990/">September 2019 Release (v2.7023)</a></p>
</dd>
</dl>
</div>
<div class="tsd-panel">
<div class="tsd-signature-type">Markup configuration example(s) :</div>
<pre>data-depends-on='foo'</pre>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.dependsoncondition" class="tsd-anchor"></a>
<h3>depends<wbr>OnCondition</h3>
<div class="tsd-signature tsd-kind-icon">depends<wbr>OnCondition<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IDependentFacetCondition</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L307">ui/CategoryFacet/CategoryFacet.ts
:307</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>A function that verifies whether the current state of the <code>dependsOn</code> facet allows the dependent facet to be displayed.</p>
</div>
<p>If specified, the function receives a reference to the resolved <code>dependsOn</code> facet component instance as an argument, and must return a boolean.
The function's argument should typically be treated as read-only.</p>
<p>By default, the dependent facet is displayed whenever one or more values are selected in its <code>dependsOn</code> facet.</p>
<dl class="tsd-comment-tags">
<dt>Only effective when</dt>
<dd><p><a href="categoryfacet.html#options.dependson"><code>dependsOn</code></a> is <a href="https://developer.mozilla.org/en-US/docs/Glossary/Truthy">truthy</a></p>
</dd>
<dt>Additional documentation</dt>
<dd><p><a href="https://docs.coveo.com/3210/">Defining Dependent Facets</a></p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.displaysearchbutton" class="tsd-anchor"></a>
<h3>display<wbr>Search<wbr>Button</h3>
<div class="tsd-signature tsd-kind-icon">display<wbr>Search<wbr>Button<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L324">ui/CategoryFacet/CategoryFacet.ts
:324</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>Whether to display the facet search widget as a button instead of a search bar.</p>
</div>
<dl class="tsd-comment-tags">
<dt>Default</dt>
<dd><p><code>true</code></p>
</dd>
<dt>Available since</dt>
<dd><p><a href="https://docs.coveo.com/3293/">July 2020 Release (v2.9373)</a></p>
</dd>
</dl>
</div>
<div class="tsd-panel">
<div class="tsd-signature-type">Markup configuration example(s) :</div>
<pre>data-display-search-button='true'
data-display-search-button='false'</pre>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.displaysearchontop" class="tsd-anchor"></a>
<h3>display<wbr>Search<wbr>OnTop</h3>
<div class="tsd-signature tsd-kind-icon">display<wbr>Search<wbr>OnTop<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L318">ui/CategoryFacet/CategoryFacet.ts
:318</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>Whether to display the facet search widget above the facet values instead of below them.</p>
</div>
<dl class="tsd-comment-tags">
<dt>Default</dt>
<dd><p><code>false</code></p>
</dd>
<dt>Available since</dt>
<dd><p><a href="https://docs.coveo.com/3293/">July 2020 Release (v2.9373)</a></p>
</dd>
</dl>
</div>
<div class="tsd-panel">
<div class="tsd-signature-type">Markup configuration example(s) :</div>
<pre>data-display-search-on-top='true'
data-display-search-on-top='false'</pre>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.enablefacetsearch" class="tsd-anchor"></a>
<h3>enable<wbr>Facet<wbr>Search</h3>
<div class="tsd-signature tsd-kind-icon">enable<wbr>Facet<wbr>Search<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L141">ui/CategoryFacet/CategoryFacet.ts
:141</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>Whether to display a search box at the bottom of the facet for searching among the available facet
<a href="categoryfacet.html#options.field"><code>field</code></a> values.</p>
</div>
<p>See also the <a href="categoryfacet.html#options.facetsearchdelay"><code>facetSearchDelay</code></a>, and
<a href="categoryfacet.html#options.numberofresultsinfacetsearch"><code>numberOfResultsInFacetSearch</code></a> options.</p>
<p>Default value is <code>true</code>.</p>
<dl class="tsd-comment-tags">
<dt>Default</dt>
<dd><p><code>true</code></p>
</dd>
</dl>
</div>
<div class="tsd-panel">
<div class="tsd-signature-type">Markup configuration example(s) :</div>
<pre>data-enable-facet-search='true'
data-enable-facet-search='false'</pre>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.enablemoreless" class="tsd-anchor"></a>
<h3>enable<wbr>More<wbr>Less</h3>
<div class="tsd-signature tsd-kind-icon">enable<wbr>More<wbr>Less<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L190">ui/CategoryFacet/CategoryFacet.ts
:190</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>Whether to enable the <strong>More</strong> and <strong>Less</strong> buttons in the Facet.</p>
</div>
<p>See also the <a href="categoryfacet.html#options.pagesize"><code>pageSize</code></a> option.</p>
<p>Default value is <code>true</code>.</p>
<dl class="tsd-comment-tags">
<dt>Default</dt>
<dd><p><code>true</code></p>
</dd>
</dl>
</div>
<div class="tsd-panel">
<div class="tsd-signature-type">Markup configuration example(s) :</div>
<pre>data-enable-more-less='true'
data-enable-more-less='false'</pre>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.facetsearchdelay" class="tsd-anchor"></a>
<h3>facet<wbr>Search<wbr>Delay</h3>
<div class="tsd-signature tsd-kind-icon">facet<wbr>Search<wbr>Delay<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L182">ui/CategoryFacet/CategoryFacet.ts
:182</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>If the <a href="categoryfacet.html#options.enablefacetsearch"><code>enableFacetSearch</code></a> option is <code>true</code>, specifies the delay (in
milliseconds) before sending a search request to the server when the user starts typing in the category facet search box.</p>
</div>
<p>Specifying a smaller value makes results appear faster. However, chances of having to cancel many requests
sent to the server increase as the user keeps on typing new characters.</p>
<p>Default value is <code>100</code>. Minimum value is <code>0</code>.</p>
<dl class="tsd-comment-tags">
<dt>Minimum</dt>
<dd><p><code>0</code></p>
</dd>
<dt>Default</dt>
<dd><p><code>100</code></p>
</dd>
</dl>
</div>
<div class="tsd-panel">
<div class="tsd-signature-type">Markup configuration example(s) :</div>
<pre>data-facet-search-delay='10'</pre>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.field" class="tsd-anchor"></a>
<h3>field</h3>
<div class="tsd-signature tsd-kind-icon">field<span class="tsd-signature-symbol">:</span> <a href="../interfaces/ifieldoption.html" class="tsd-signature-type">IFieldOption</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L115">ui/CategoryFacet/CategoryFacet.ts
:115</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>The index field whose values the facet should use. The field values should have the form:
<code>the; the|path; the|path|to; the|path|to|given; the|path|to|given|item;</code>
where the delimiting character is <code>|</code>. This default delimiting character can be changed using the <a href="categoryfacet.html#options.delimitingcharacter">delimitingCharacter</a> option.</p>
</div>
<p>To help you verify whether your fields are setup correctly, see the <a href="categoryfacet.html#options.debug">CategoryFacet.options.debug</a> option
and the <a href="categoryfacet.html#debugvalue">CategoryFacet.debugValue</a> method.</p>
<p>See <a href="https://docs.coveo.com/en/2667">Using the Category Facet Component</a>.</p>
<dl class="tsd-comment-tags">
<dt>Required</dt>
<dd><p>Specifying a value for this option is required for the component to work</p>
</dd>
</dl>
</div>
<div class="tsd-panel">
<div class="tsd-signature-type">Markup configuration example(s) :</div>
<pre>data-field='@foo'</pre>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.id-1" class="tsd-anchor"></a>
<h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L151">ui/CategoryFacet/CategoryFacet.ts
:151</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A unique identifier for the facet. Among other things, this identifier serves the purpose of saving
the facet state in the URL hash.</p>
</div>
<p>If you have two facets with the same field on the same page, you should specify an <code>id</code> value for at least one of
those two facets. This <code>id</code> must be unique among the facets.</p>
<p>Default value is the <a href="categoryfacet.html#options.field"><code>field</code></a> option value.</p>
</div>
<div class="tsd-panel">
<div class="tsd-signature-type">Markup configuration example(s) :</div>
<pre>data-id='foo'</pre>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.injectiondepth" class="tsd-anchor"></a>
<h3>injection<wbr>Depth</h3>
<div class="tsd-signature tsd-kind-icon">injection<wbr>Depth<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L165">ui/CategoryFacet/CategoryFacet.ts
:165</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>The <em>injection depth</em> to use.</p>
</div>
<p>The injection depth determines how many results to scan in the index to ensure that the category facet lists all potential
facet values. Increasing this value enhances the accuracy of the listed values at the cost of performance.</p>
<p>Default value is <code>1000</code>. Minimum value is <code>1000</code>.</p>
<dl class="tsd-comment-tags">
<dt>Not supported in</dt>
<dd><p>salesforcefree</p>
</dd>
<dt>Minimum</dt>
<dd><p><code>1000</code></p>
</dd>
<dt>Default</dt>
<dd><p><code>1000</code></p>
</dd>
</dl>
</div>
<div class="tsd-panel">
<div class="tsd-signature-type">Markup configuration example(s) :</div>
<pre>data-injection-depth='1500'</pre>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.maximumdepth" class="tsd-anchor"></a>
<h3>maximum<wbr>Depth</h3>
<div class="tsd-signature tsd-kind-icon">maximum<wbr>Depth<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L240">ui/CategoryFacet/CategoryFacet.ts
:240</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>The maximum number of levels to traverse in the hierarchy.
This option does not count the length of the base path. The depth depends on what is shown in the interface.</p>
</div>
<p>Default value is <code>Number.MAX_VALUE</code>.</p>
<dl class="tsd-comment-tags">
<dt>Minimum</dt>
<dd><p><code>1</code></p>
</dd>
</dl>
</div>
<div class="tsd-panel">
<div class="tsd-signature-type">Markup configuration example(s) :</div>
<pre>data-maximum-depth='10'</pre>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.numberofresultsinfacetsearch" class="tsd-anchor"></a>
<h3>number<wbr>OfResults<wbr>InFacet<wbr>Search</h3>
<div class="tsd-signature tsd-kind-icon">number<wbr>OfResults<wbr>InFacet<wbr>Search<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L172">ui/CategoryFacet/CategoryFacet.ts
:172</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>If the <a href="categoryfacet.html#options.enablefacetsearch"><code>enableFacetSearch</code></a> option is <code>true</code>, specifies the number of
values to display in the facet search results popup.</p>
</div>
<p>Default value is <code>15</code>. Minimum value is <code>1</code>.</p>
<dl class="tsd-comment-tags">
<dt>Minimum</dt>
<dd><p><code>1</code></p>
</dd>
<dt>Default</dt>
<dd><p><code>15</code></p>
</dd>
</dl>
</div>
<div class="tsd-panel">
<div class="tsd-signature-type">Markup configuration example(s) :</div>
<pre>data-number-of-results-in-facet-search='10'</pre>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.numberofvalues" class="tsd-anchor"></a>
<h3>number<wbr>OfValues</h3>
<div class="tsd-signature tsd-kind-icon">number<wbr>OfValues<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L130">ui/CategoryFacet/CategoryFacet.ts
:130</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>The maximum number of field values to display by default in the facet before the user
clicks the arrow to show more.</p>
</div>
<p>See also the <a href="categoryfacet.html#options.enablemoreless"><code>enableMoreLess</code></a> option.</p>
<dl class="tsd-comment-tags">
<dt>Minimum</dt>
<dd><p><code>0</code></p>
</dd>
<dt>Default</dt>
<dd><p><code>5</code></p>
</dd>
</dl>
</div>
<div class="tsd-panel">
<div class="tsd-signature-type">Markup configuration example(s) :</div>
<pre>data-number-of-values='10'</pre>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.pagesize" class="tsd-anchor"></a>
<h3>page<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">page<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L197">ui/CategoryFacet/CategoryFacet.ts
:197</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-deprecated">
</dl>
<div class="lead">
<p>If the <a href="categoryfacet.html#options.enablemoreless"><code>enableMoreLess</code></a> option is <code>true</code>, specifies the number of
additional results to fetch when clicking the <strong>More</strong> button.</p>
</div>
<p>Default value is <code>10</code>. Minimum value is <code>1</code>.</p>
<dl class="tsd-comment-tags">
<dt>Only effective when</dt>
<dd><p><a href="categoryfacet.html#options.enablemoreless"><code>enableMoreLess</code></a> is <a href="https://developer.mozilla.org/en-US/docs/Glossary/Truthy">truthy</a></p>
</dd>
<dt>Minimum</dt>
<dd><p><code>1</code></p>
</dd>
<dt>Default</dt>
<dd><p><code>10</code></p>
</dd>
</dl>
</div>
<div class="tsd-panel">
<div class="tsd-signature-type">Markup configuration example(s) :</div>
<pre>data-page-size='10'</pre>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.title" class="tsd-anchor"></a>
<h3>title</h3>
<div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L121">ui/CategoryFacet/CategoryFacet.ts
:121</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The title to display at the top of the facet.</p>
</div>
<p>Default value is the localized string for <code>NoTitle</code>.</p>
</div>
<div class="tsd-panel">
<div class="tsd-signature-type">Markup configuration example(s) :</div>
<pre>data-title='foo'</pre>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="options.valuecaption" class="tsd-anchor"></a>
<h3>value<wbr>Caption</h3>
<div class="tsd-signature tsd-kind-icon">value<wbr>Caption<span class="tsd-signature-symbol">:</span> <a href="../interfaces/istringmap.html" class="tsd-signature-type">IStringMap</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/CategoryFacet/CategoryFacet.ts#L286">ui/CategoryFacet/CategoryFacet.ts
:286</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specifies a JSON object describing a mapping of facet values to their desired captions. See
<a href="https://developers.coveo.com/x/jBsvAg">Normalizing Facet Value Captions</a>.</p>
</div>
<p><strong>Note:</strong>
If this option is specified, the facet search box will be unavailable.</p>
<p><strong>Examples:</strong></p>
<p>You can set the option in the <a href="../globals.html#init">'init'</a> call:</p>
<pre><code class="lang-javascript"><span class="hljs-keyword">var</span> myValueCaptions = {
<span class="hljs-string">"txt"</span> : <span class="hljs-string">"Text files"</span>,
<span class="hljs-string">"html"</span> : <span class="hljs-string">"Web page"</span>,
[ ... ]
};
Coveo.init(<span class="hljs-built_in">document</span>.querySelector(<span class="hljs-string">"#search"</span>), {
<span class="hljs-attr">Facet</span> : {
<span class="hljs-attr">valueCaption</span> : myValueCaptions
}
});
</code></pre>
<p>Or before the <code>init</code> call, using the <a href="categoryfacet.html#options">'options'</a> top-level function:</p>
<pre><code class="lang-javascript">Coveo.options(<span class="hljs-built_in">document</span>.querySelector(<span class="hljs-string">"#search"</span>), {
<span class="hljs-attr">Facet</span> : {
<span class="hljs-attr">valueCaption</span> : myValueCaptions
}
});
</code></pre>
<p>Or directly in the markup:</p>
<pre><code class="lang-html"><span class="hljs-comment"><!-- Ensure that the double quotes are properly handled in data-value-caption. --></span>
<span class="hljs-tag"><<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">'CoveoCategoryFacet'</span> <span class="hljs-attr">data-field</span>=<span class="hljs-string">'@myotherfield'</span> <span class="hljs-attr">data-value-caption</span>=<span class="hljs-string">'{"txt":"Text files","html":"Web page"}'</span>></span><span class="hljs-tag"></<span class="hljs-name">div</span>></span>
</code></pre>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-coveo-component tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-coveo-component tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Category<wbr>Facet<span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span>, type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, bindings<span class="tsd-signature-symbol">?: </span><a href="../interfaces/icomponentbindings.html" class="tsd-signature-type">IComponentBindings</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="categoryfacet.html" class="tsd-signature-type">CategoryFacet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/component.html">Component</a>.<a href="../classes/component.html#constructor">constructor</a></p>
<ul>
<li>Defined in
<a href="https://github.com/coveo/search-ui/tree/master/src/ui/Base/Component.ts#L296">ui/Base/Component.ts
:296</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create a new Component. Resolve all <a href="../interfaces/icomponentbindings.html">IComponentBindings</a> if not provided.<br/>
Create a new Logger for this component.
Attach the component to the <a href="searchinterface.html">SearchInterface</a>.<br/></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>element: <span class="tsd-signature-type">HTMLElement</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The HTMLElement on which to create the component. Used to bind data on the element.</p>
</div>
</div>
</li>
<li>
<h5>type: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The unique identifier for this component. See: <a href="../interfaces/icomponentdefinition.html#id">IComponentDefinition.ID</a>. Used to generate the unique Coveo CSS class associated with every component.</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> bindings: <a href="../interfaces/icomponentbindings.html" class="tsd-signature-type">IComponentBindings</a><span class="tsd-signature-symbol"> = {}</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The environment for every component. Optional, but omitting to provide one will impact performance.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="categoryfacet.html" class="tsd-signature-type">CategoryFacet</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><span class="tsd-signature-type">IAutoLayoutAdjustableInsideFacetColumn</span></li>
</ul>
</section>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer> </div>
</div>
</div>
<script src="../assets/js/main.js"></script>
<script src="../assets/js/generateMetaData.js"></script>
</body>
</html>