# Wijmo_Olap.Pivotfilter

## Content

<div class="content__tsd">
						<div style="display:flex;justify-content:space-between;align-items:center">
							<h1>
								PivotFilter Class
							</h1>
						</div>
						<section class="tsd-comment">
							<div class="tsd-comment">
								<div class="lead">
									<p>Represents a filter used to select values for a <a href="wijmo_olap.pivotfield.html">PivotField</a>.</p>
								</div>
								<p>There are two types of filter: by value and by condition.</p>
								<p>Value filters allow users to select specific values they want
									to include in the analysis. This is done by checking specific
								values from a list.</p>
								<p>Condition filters include two conditions specified by an operator
									and a value (e.g. 'begins with' and 's'). The conditions may
								be combined with an 'and' or an 'or' operator.</p>
								<p>When the <a href="wijmo_olap.pivotengine.html">PivotEngine</a> is connected to server-based data
									sources, only condition filters can be used (value filters are
								automatically hidden).</p>
							</div>
						</section>
						<section class="tsd-hierarchy">
							<h3>Heirarchy</h3>
							<ul class="tsd-hierarchy">
								<li>
									<span class="target">PivotFilter</span>
								</li>
							</ul>
						</section>
						<section class="tsd-index-group">
							<section class="tsd-index-panel">
								<div class="tsd-index-content">
									<section class="tsd-index-section ">
										<div class="title">
											<div class="gc_api_tree-item_icon_img_wrapper">
												<div class="gc_api_tree-item_icon_img" data-expand="true">
												</div>
											</div>
											<h3>
												Constructors
											</h3>
										</div>
										<ul class="tsd-index-list">
											<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="wijmo_olap.pivotfilter.html#constructor" class="tsd-kind-icon">constructor</a></li>
										</ul>
									</section>
									<section class="tsd-index-section ">
										<div class="title">
											<div class="gc_api_tree-item_icon_img_wrapper">
												<div class="gc_api_tree-item_icon_img" data-expand="true">
												</div>
											</div>
											<h3>
												Properties
											</h3>
										</div>
										<ul class="tsd-index-list">
											<li class="tsd-kind-property tsd-parent-kind-class"><a href="wijmo_olap.pivotfilter.html#conditionfilter" class="tsd-kind-icon">condition<wbr>Filter</a></li>
											<li class="tsd-kind-property tsd-parent-kind-class"><a href="wijmo_olap.pivotfilter.html#filtertype" class="tsd-kind-icon">filter<wbr>Type</a></li>
											<li class="tsd-kind-property tsd-parent-kind-class"><a href="wijmo_olap.pivotfilter.html#isactive" class="tsd-kind-icon">is<wbr>Active</a></li>
											<li class="tsd-kind-property tsd-parent-kind-class"><a href="wijmo_olap.pivotfilter.html#valuefilter" class="tsd-kind-icon">value<wbr>Filter</a></li>
										</ul>
									</section>
									<section class="tsd-index-section ">
										<div class="title">
											<div class="gc_api_tree-item_icon_img_wrapper">
												<div class="gc_api_tree-item_icon_img" data-expand="true">
												</div>
											</div>
											<h3>
												Methods
											</h3>
										</div>
										<ul class="tsd-index-list">
											<li class="tsd-kind-method tsd-parent-kind-class"><a href="wijmo_olap.pivotfilter.html#apply" class="tsd-kind-icon">apply</a></li>
											<li class="tsd-kind-method tsd-parent-kind-class"><a href="wijmo_olap.pivotfilter.html#clear" class="tsd-kind-icon">clear</a></li>
										</ul>
									</section>
								</div>
							</section>
						</section>
						<section class="tsd-panel-group tsd-member-group ">
							<h2>Constructors</h2>
							<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
								<a name="constructor" class="tsd-anchor"></a>
								<h3>constructor</h3>
								<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
									<li class="tsd-signature tsd-kind-icon">new <wbr>Pivot<wbr>Filter<span class="tsd-signature-symbol">(</span>field<span class="tsd-signature-symbol">: </span><a href="wijmo_olap.pivotfield.html" class="tsd-signature-type">PivotField</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="wijmo_olap.pivotfilter.html" class="tsd-signature-type">PivotFilter</a></li>
								</ul>
								<ul class="tsd-descriptions">
									<li class="tsd-description">
										<aside class="tsd-sources">
										</aside>
										<div class="tsd-comment">
											<div class="lead">
												<p>Initializes a new instance of the <a href="wijmo_olap.pivotfilter.html">PivotFilter</a> class.</p>
											</div>
										</div>
										<h4 class="tsd-parameters-title">Parameters</h4>
										<ul class="tsd-parameters">
											<li>
												<h5>field: <a href="wijmo_olap.pivotfield.html" class="tsd-signature-type">PivotField</a></h5>
												<div class="tsd-comment">
													<div class="lead">
														<p><a href="wijmo_olap.pivotfield.html">PivotField</a> that owns this filter.</p>
													</div>
												</div>
											</li>
										</ul>
										<h4 class="tsd-returns-title">Returns <a href="wijmo_olap.pivotfilter.html" class="tsd-signature-type">PivotFilter</a></h4>
									</li>
								</ul>
							</section>
						</section>
						<section class="tsd-panel-group tsd-member-group ">
							<h2>Properties</h2>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
								<a name="conditionfilter" class="tsd-anchor"></a>
								<h3>conditionFilter</h3>
								<div class="tsd-signature tsd-kind-icon">condition<wbr>Filter<span class="tsd-signature-symbol">:</span> <a href="wijmo_grid_filter.conditionfilter.html" class="tsd-signature-type">ConditionFilter</a></div>
								<aside class="tsd-sources">
								</aside>
								<div class="tsd-comment">
									<div class="lead">
										<p>Gets the <a href="wijmo_grid_filter.conditionfilter.html">ConditionFilter</a> in this <a href="wijmo_olap.pivotfilter.html">PivotFilter</a>.</p>
									</div>
								</div>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
								<a name="filtertype" class="tsd-anchor"></a>
								<h3>filterType</h3>
								<div class="tsd-signature tsd-kind-icon">filter<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="../enums/wijmo_grid_filter.filtertype.html" class="tsd-signature-type">FilterType</a></div>
								<aside class="tsd-sources">
								</aside>
								<div class="tsd-comment">
									<div class="lead">
										<p>Gets or sets the types of filtering provided by this filter.</p>
									</div>
									<p>Setting this property to null causes the filter to use the value
										defined by the owner filter's <a href="wijmo_grid_filter.flexgridfilter.html#defaultfiltertype">FlexGridFilter.defaultFilterType</a>
									property.</p>
								</div>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
								<a name="isactive" class="tsd-anchor"></a>
								<h3>isActive</h3>
								<div class="tsd-signature tsd-kind-icon">is<wbr>Active<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
								<aside class="tsd-sources">
								</aside>
								<div class="tsd-comment">
									<div class="lead">
										<p>Gets a value that indicates whether the filter is active.</p>
									</div>
								</div>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
								<a name="valuefilter" class="tsd-anchor"></a>
								<h3>valueFilter</h3>
								<div class="tsd-signature tsd-kind-icon">value<wbr>Filter<span class="tsd-signature-symbol">:</span> <a href="wijmo_grid_filter.valuefilter.html" class="tsd-signature-type">ValueFilter</a></div>
								<aside class="tsd-sources">
								</aside>
								<div class="tsd-comment">
									<div class="lead">
										<p>Gets the <a href="wijmo_grid_filter.valuefilter.html">ValueFilter</a> in this <a href="wijmo_olap.pivotfilter.html">PivotFilter</a>.</p>
									</div>
								</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-class">
								<a name="apply" class="tsd-anchor"></a>
								<h3>apply</h3>
								<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
									<li class="tsd-signature tsd-kind-icon">apply<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
								</ul>
								<ul class="tsd-descriptions">
									<li class="tsd-description">
										<aside class="tsd-sources">
										</aside>
										<div class="tsd-comment">
											<div class="lead">
												<p>Gets a value that indicates whether a value passes the filter.</p>
											</div>
										</div>
										<h4 class="tsd-parameters-title">Parameters</h4>
										<ul class="tsd-parameters">
											<li>
												<h5>value: <span class="tsd-signature-type">any</span></h5>
												<div class="tsd-comment">
													<p>The value to test.</p>
												</div>
											</li>
										</ul>
										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
									</li>
								</ul>
							</section>
							<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
								<a name="clear" class="tsd-anchor"></a>
								<h3>clear</h3>
								<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
									<li class="tsd-signature tsd-kind-icon">clear<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">
										</aside>
										<div class="tsd-comment">
											<div class="lead">
												<p>Clears the filter.</p>
											</div>
										</div>
										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
									</li>
								</ul>
							</section>
						</section>
					</div>