Icard/angular-clarity-master(work.../node_modules/primeng/tree/tree.interface.d.ts

194 lines
4.0 KiB
TypeScript

import { TemplateRef } from '@angular/core';
import { TreeNode } from 'primeng/api';
import { ScrollerOptions } from 'primeng/api';
/**
* Custom node select event.
* @see {@link Tree.onNodeSelect}
* @group Events
*/
export interface TreeNodeSelectEvent {
/**
* Browser event
*/
originalEvent: Event;
/**
* Node instance.
*/
node: TreeNode<any>;
}
/**
* Custom node unselect event.
* @see {@link Tree.onNodeUnSelect}
* @extends {TreeNodeSelectEvent}
* @group Events
*/
export interface TreeNodeUnSelectEvent extends TreeNodeSelectEvent {
}
/**
* Custom node expand event.
* @see {@link Tree.onNodeExpand}
* @extends {TreeNodeSelectEvent}
* @group Events
*/
export interface TreeNodeExpandEvent extends TreeNodeSelectEvent {
}
/**
* Custom node collapse event.
* @see {@link Tree.onNodeCollapse}
* @extends {TreeNodeSelectEvent}
* @group Events
*/
export interface TreeNodeCollapseEvent extends TreeNodeSelectEvent {
}
/**
* Custom context menu select event.
* @see {@link Tree.onNodeContextMenuSelect}
* @extends {TreeNodeSelectEvent}
* @group Events
*/
export interface TreeNodeContextMenuSelectEvent extends TreeNodeSelectEvent {
}
/**
* Custom node drop event.
* @see {@link Tree.onNodeDrop}
* @group Events
*/
export interface TreeNodeDropEvent {
/**
* Browser drag event.
*/
originalEvent?: DragEvent;
/**
* Dragged node instance.
*/
dragNode?: TreeNode<any> | null;
/**
* Dropped node instance.
*/
dropNode?: TreeNode<any> | null;
/**
* Index of the dragged node.
*/
index?: number;
/**
* Callback to invoke on drop.
*/
accept?: Function;
}
/**
* Custom lazy load event.
* @see {@link Tree.onLazyLoad}
* @group Events
*/
export interface TreeLazyLoadEvent {
/**
* First element index in viewport.
*/
first: number;
/**
* Last element index in viewport.
*/
last: number;
}
/**
* Custom scroll index change event.
* @see {@link Tree.onScrollIndexChange}
* @group Events
*/
export interface TreeScrollIndexChangeEvent extends TreeLazyLoadEvent {
}
/**
* Custom scroll event.
* @see {@link Tree.onScroll}
* @group Events
*/
export interface TreeScrollEvent {
/**
* Browser event.
*/
originalEvent?: Event;
}
/**
* Custom filter event.
* @see {@link Tree.onFilter}
* @group Events
*/
export interface TreeFilterEvent {
/**
* Filter value.
*/
filter: string;
/**
* Filtered nodes.
*/
filteredValue: TreeNode<any>[] | null | undefined;
}
/**
* Defines valid templates in Tree.
* @group Templates
*/
export interface TreeTemplates {
/**
* Custom header template.
*/
header(): TemplateRef<any>;
/**
* Custom empty message template.
*/
empty(): TemplateRef<any>;
/**
* Custom footer template.
*/
footer(): TemplateRef<any>;
/**
* Custom loader template.
* @param {Object} context - loader options.
*/
loader(context: {
/**
* Scroller options.
* @see {@link ScrollerOptions}
*/
options: ScrollerOptions;
}): TemplateRef<{
options: ScrollerOptions;
}>;
/**
* Custom toggler icon template.
* @param {Object} context - expand data.
*/
togglericon(context: {
/**
* Expanded state of the node.
*/
$implicit: boolean;
}): TemplateRef<{
$implicit: boolean;
}>;
/**
* Custom checkbox icon template.
* @param {Object} context - node data.
*/
checkboxicon(context: {
/**
* Checked state of the node.
*/
$implicit: boolean;
/**
* Partial selection state of the node.
*/
partialSelected: boolean;
}): TemplateRef<{
$implicit: boolean;
partialSelected: boolean;
}>;
/**
* Custom loading icon template.
*/
loadingicon(): TemplateRef<any>;
/**
* Custom filter icon template.
*/
filtericon(): TemplateRef<any>;
}