@progress/kendo-angular-grid 19.1.2-develop.3 → 19.1.2-develop.5

package/filtering/operators/isnull-filter-operator.component.d.ts

@@ -7,8 +7,80 @@ import { FilterOperatorBase } from './filter-operator.base';
 import * as i0 from "@angular/core";
 /**
  * Represents the `IsNull` (**Is null**) filter operator. [See example](slug:filtering_grid#toc-using-the-built-in-directive).
+ * Use this operator to filter out values that are null.
+ * For more information and examples, see the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
  *
- * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
+ * @example
+ * ```html String Filter Cell
+ * <kendo-grid-column field="ProductName" title="Product Name">
+ *   <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
+ *     <kendo-grid-string-filter-cell
+ *       [column]="column"
+ *       [filter]="filter">
+ *       <kendo-filter-isnull-operator></kendo-filter-isnull-operator>
+ *     </kendo-grid-string-filter-cell>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
+ * ```html Numeric Filter Cell
+ * <kendo-grid-column field="UnitPrice" title="Price">
+ *   <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
+ *     <kendo-grid-numeric-filter-cell
+ *       [column]="column"
+ *       [filter]="filter">
+ *       <kendo-filter-isnull-operator></kendo-filter-isnull-operator>
+ *     </kendo-grid-numeric-filter-cell>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
+ * ```html Date Filter Cell
+ * <kendo-grid-column field="FirstOrderedOn">
+ *   <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
+ *     <kendo-grid-date-filter-cell
+ *       [column]="column"
+ *       [filter]="filter">
+ *       <kendo-filter-isnull-operator></kendo-filter-isnull-operator>
+ *      </kendo-grid-date-filter-cell>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
+ * @example
+ * ```html String Filter Menu
+ * <kendo-grid-column field="ProductName" title="Product Name">
+ *   <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
+ *     <kendo-grid-string-filter-menu
+ *       [column]="column"
+ *       [filter]="filter"
+ *       [filterService]="filterService">
+ *       <kendo-filter-isnull-operator></kendo-filter-isnull-operator>
+ *     </kendo-grid-string-filter-menu>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
+ * ```html Numeric Filter Menu
+ * <kendo-grid-column field="UnitPrice" title="Price">
+ *   <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
+ *     <kendo-grid-numeric-filter-menu
+ *       [column]="column"
+ *       [filter]="filter"
+ *       [filterService]="filterService">
+ *       <kendo-filter-isnull-operator></kendo-filter-isnull-operator>
+ *     </kendo-grid-numeric-filter-menu>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
+ * ```html Date Filter Menu
+ * <kendo-grid-column field="FirstOrderedOn">
+ *   <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
+ *     <kendo-grid-date-filter-menu
+ *       [column]="column"
+ *       [filter]="filter"
+ *       [filterService]="filterService">
+ *       <kendo-filter-isnull-operator></kendo-filter-isnull-operator>
+ *     </kendo-grid-date-filter-menu>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
  */
 export declare class IsNullFilterOperatorComponent extends FilterOperatorBase {
     constructor(ctx: ContextService);

package/filtering/operators/lt-filter-operator.component.d.ts

@@ -7,8 +7,33 @@ import { FilterOperatorBase } from './filter-operator.base';
 import * as i0 from "@angular/core";
 /**
  * Represents the `Less` (**Is less than**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
- *
+ * Use this operator to filter values less than the specified number.
  * [See example](slug:filter_row#toc-default-filter-operator).
+ *
+ * @example
+ * ```html Filter Cell
+ * <kendo-grid-column field="UnitPrice" title="Price">
+ *   <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
+ *     <kendo-grid-numeric-filter-cell
+ *       [column]="column"
+ *       [filter]="filter">
+ *       <kendo-filter-lt-operator></kendo-filter-lt-operator>
+ *     </kendo-grid-numeric-filter-cell>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
+ * ```html Filter Menu
+ * <kendo-grid-column field="UnitPrice" title="Price">
+ *   <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
+ *     <kendo-grid-numeric-filter-menu
+ *       [column]="column"
+ *       [filter]="filter"
+ *       [filterService]="filterService">
+ *       <kendo-filter-lt-operator></kendo-filter-lt-operator>
+ *     </kendo-grid-numeric-filter-menu>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
  */
 export declare class LessFilterOperatorComponent extends FilterOperatorBase {
     constructor(ctx: ContextService);

package/filtering/operators/lte-filter-operator.component.d.ts

@@ -7,8 +7,33 @@ import { FilterOperatorBase } from './filter-operator.base';
 import * as i0 from "@angular/core";
 /**
  * Represents the `LessOrEqualTo` (**Is less than or equal to**) [numeric filter](slug:filtering_grid#toc-numeric-filter) operator.
- *
+ * Use this operator to filter values less than or equal to the specified number.
  * [See example](slug:filter_row#toc-default-filter-operator).
+ *
+ * @example
+ * ```html Filter Cell
+ * <kendo-grid-column field="UnitPrice" title="Price">
+ *   <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
+ *     <kendo-grid-numeric-filter-cell
+ *       [column]="column"
+ *       [filter]="filter">
+ *       <kendo-filter-lte-operator></kendo-filter-lte-operator>
+ *     </kendo-grid-numeric-filter-cell>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
+ * ```html Filter Menu
+ * <kendo-grid-column field="UnitPrice" title="Price">
+ *   <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
+ *     <kendo-grid-numeric-filter-menu
+ *       [column]="column"
+ *       [filter]="filter"
+ *       [filterService]="filterService">
+ *       <kendo-filter-lte-operator></kendo-filter-lte-operator>
+ *     </kendo-grid-numeric-filter-menu>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
  */
 export declare class LessOrEqualToFilterOperatorComponent extends FilterOperatorBase {
     constructor(ctx: ContextService);

package/filtering/operators/neq-filter-operator.component.d.ts

@@ -7,8 +7,80 @@ import { FilterOperatorBase } from './filter-operator.base';
 import * as i0 from "@angular/core";
 /**
  * Represents the `NotEqual` (**Is not equal to**) filter operator. [See example](slug:filtering_grid#toc-using-the-built-in-directive).
+ * Use this operator to filter values that are not equal to the specified value.
+ * For more information and examples, see the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
  *
- * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
+ * @example
+ * ```html String Filter Cell
+ * <kendo-grid-column field="ProductName" title="Product Name">
+ *   <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
+ *     <kendo-grid-string-filter-cell
+ *       [column]="column"
+ *       [filter]="filter">
+ *       <kendo-filter-neq-operator></kendo-filter-neq-operator>
+ *     </kendo-grid-string-filter-cell>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
+ * ```html Numeric Filter Cell
+ * <kendo-grid-column field="UnitPrice" title="Price">
+ *   <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
+ *     <kendo-grid-numeric-filter-cell
+ *       [column]="column"
+ *       [filter]="filter">
+ *       <kendo-filter-neq-operator></kendo-filter-neq-operator>
+ *     </kendo-grid-numeric-filter-cell>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
+ * ```html Date Filter Cell
+ * <kendo-grid-column field="FirstOrderedOn">
+ *   <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
+ *     <kendo-grid-date-filter-cell
+ *       [column]="column"
+ *       [filter]="filter">
+ *       <kendo-filter-neq-operator></kendo-filter-neq-operator>
+ *      </kendo-grid-date-filter-cell>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
+ * @example
+ * ```html String Filter Menu
+ * <kendo-grid-column field="ProductName" title="Product Name">
+ *   <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
+ *     <kendo-grid-string-filter-menu
+ *       [column]="column"
+ *       [filter]="filter"
+ *       [filterService]="filterService">
+ *       <kendo-filter-neq-operator></kendo-filter-neq-operator>
+ *     </kendo-grid-string-filter-menu>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
+ * ```html Numeric Filter Menu
+ * <kendo-grid-column field="UnitPrice" title="Price">
+ *   <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
+ *     <kendo-grid-numeric-filter-menu
+ *       [column]="column"
+ *       [filter]="filter"
+ *       [filterService]="filterService">
+ *       <kendo-filter-neq-operator></kendo-filter-neq-operator>
+ *     </kendo-grid-numeric-filter-menu>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
+ * ```html Date Filter Menu
+ * <kendo-grid-column field="FirstOrderedOn">
+ *  <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
+ *     <kendo-grid-date-filter-menu
+ *       [column]="column"
+ *       [filter]="filter"
+ *       [filterService]="filterService">
+ *       <kendo-filter-neq-operator></kendo-filter-neq-operator>
+ *     </kendo-grid-date-filter-menu>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
  */
 export declare class NotEqualFilterOperatorComponent extends FilterOperatorBase {
     constructor(ctx: ContextService);

package/filtering/operators/not-contains-filter-operator.component.d.ts

@@ -7,8 +7,33 @@ import { FilterOperatorBase } from './filter-operator.base';
 import * as i0 from "@angular/core";
 /**
  * Represents the `DoesNotContain` (**Does not contain**) filter operator. [See example](slug:filtering_grid#toc-using-the-built-in-directive).
+ * Use this operator to filter values that do not contain the specified text.
+ * For more information and examples, see the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
  *
- * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
+ * @example
+ * ```html Filter Cell
+ * <kendo-grid-column field="ProductName" title="Product Name">
+ *   <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
+ *     <kendo-grid-string-filter-cell
+ *       [column]="column"
+ *       [filter]="filter">
+ *       <kendo-filter-not-contains-operator></kendo-filter-not-contains-operator>
+ *     </kendo-grid-string-filter-cell>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
+ * ```html Filter Menu
+ * <kendo-grid-column field="ProductName" title="Product Name">
+ *   <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
+ *     <kendo-grid-string-filter-menu
+ *       [column]="column"
+ *       [filter]="filter"
+ *       [filterService]="filterService">
+ *      <kendo-filter-not-contains-operator></kendo-filter-not-contains-operator>
+ *    </kendo-grid-string-filter-menu>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
  */
 export declare class DoesNotContainFilterOperatorComponent extends FilterOperatorBase {
     constructor(ctx: ContextService);

package/filtering/operators/starts-with-filter-operator.component.d.ts

@@ -7,8 +7,33 @@ import { FilterOperatorBase } from './filter-operator.base';
 import * as i0 from "@angular/core";
 /**
  * Represents the `StartsWith` (**Starts with**) filter operator. [See example](slug:filtering_grid#toc-using-the-built-in-directive).
+ * Use this operator to filter values that start with the specified text.
+ * For more information and examples, see the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
  *
- * For more information and examples, refer to the article on setting [default filter operators](slug:filter_row#toc-default-filter-operator).
+ * @example
+ * ```html Filter Cell
+ * <kendo-grid-column field="ProductName" title="Product Name">
+ *   <ng-template kendoGridFilterCellTemplate let-filter let-column="column">
+ *     <kendo-grid-string-filter-cell
+ *       [column]="column"
+ *       [filter]="filter">
+ *       <kendo-filter-startswith-operator></kendo-filter-startswith-operator>
+ *     </kendo-grid-string-filter-cell>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
+ * ```html Filter Menu
+ * <kendo-grid-column field="ProductName" title="Product Name">
+ *   <ng-template kendoGridFilterMenuTemplate let-filter let-column="column" let-filterService="filterService">
+ *     <kendo-grid-string-filter-menu
+ *       [column]="column"
+ *       [filter]="filter"
+ *       [filterService]="filterService">
+ *       <kendo-filter-startswith-operator></kendo-filter-startswith-operator>
+ *     </kendo-grid-string-filter-menu>
+ *   </ng-template>
+ * </kendo-grid-column>
+ * ```
  */
 export declare class StartsWithFilterOperatorComponent extends FilterOperatorBase {
     constructor(ctx: ContextService);

package/filtering/string-filter.component.d.ts

@@ -10,29 +10,30 @@ import { FilterComponent } from './filter-component.interface';
 import { ContextService } from '../common/provider.service';
 import * as i0 from "@angular/core";
 /**
+ * @hidden
  * Represents a base string filter component.
  */
 export declare abstract class StringFilterComponent extends BaseFilterCellComponent implements FilterComponent {
     protected ctx: ContextService;
     /**
-     * The column with which the filter is associated.
+     * Sets the column for this filter.
      * @type {ColumnComponent}
      */
     column: ColumnComponent;
     /**
-     * The default filter operator.
+     * Sets the default filter operator.
      * @type {string}
      * @default 'contains'
      */
     operator: string;
     /**
-     * The current filter for the associated column field.
+     * Gets the current filter for the column field.
      * @readonly
      * @type {FilterDescriptor}
      */
     get currentFilter(): FilterDescriptor;
     /**
-     * The current filter operator for the associated column field.
+     * Gets the current filter operator for the column field.
      * @readonly
      * @type {string}
      */