devextreme/ui/hierarchical_collection/ui.hierarchical_collection_widget.d.ts

HTML5 JavaScript Component Suite for Responsive Web Development

/**
* DevExtreme (ui/hierarchical_collection/ui.hierarchical_collection_widget.d.ts)
* Version: 20.1.7
* Build date: Tue Aug 25 2020
*
* Copyright (c) 2012 - 2020 Developer Express Inc. ALL RIGHTS RESERVED
* Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/
*/
import CollectionWidget, {
    CollectionWidgetOptions
} from '../collection/ui.collection_widget.base';

/** Warning! This type is used for internal purposes. Do not import it directly. */
export interface HierarchicalCollectionWidgetOptions<T = HierarchicalCollectionWidget> extends CollectionWidgetOptions<T> {
    /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget item is disabled. */
    disabledExpr?: string | Function;
    /** Specifies the data field whose values should be displayed. */
    displayExpr?: string | ((item: any) => string);
    /** Specifies whether the widget can be focused using keyboard navigation. */
    focusStateEnabled?: boolean;
    /** Specifies whether the widget changes its state when a user pauses on it. */
    hoverStateEnabled?: boolean;
    /** Specifies which data field contains nested items. */
    itemsExpr?: string | Function;
    /** Specifies which data field provides keys for TreeView items. */
    keyExpr?: string | Function;
    /** Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is selected. */
    selectedExpr?: string | Function;
}
/** Warning! This type is used for internal purposes. Do not import it directly. */

export default class HierarchicalCollectionWidget extends CollectionWidget {
    constructor(element: Element, options?: HierarchicalCollectionWidgetOptions)
    constructor(element: JQuery, options?: HierarchicalCollectionWidgetOptions)
}