/** * @license *------------------------------------------------------------------------------------------- * Copyright © 2026 Progress Software Corporation. All rights reserved. * Licensed under commercial license. See LICENSE.md in the package root for more information *------------------------------------------------------------------------------------------- */ /** * Represents the object of the `onExpandChange` event ([see example]({% slug overview_treeview %})). */ export interface TreeViewExpandChangeEvent { /** * The ItemClick event. */ event: any; /** * The item that is expanded or collapsed. */ item: any; /** * The hierarchical index of the item. The indices are zero-based. The first root item has a `0` (zero) index. If the first root item has children, the first child acquires a `0_0` index and the second acquires a `0_1` index. */ itemHierarchicalIndex: string; } /** * Represents the object of the `onItemClick` event ([see example]({% slug overview_treeview %})). */ export interface TreeViewItemClickEvent { /** * The ItemClick event. */ event: any; /** * The item that is clicked. */ item: any; /** * The hierarchical index of the item. The indices are zero-based. * The first root item has a `0` (zero) index. If the first root item has children, the first child acquires a `0_0` index and the second acquires a `0_1` index. */ itemHierarchicalIndex: string; } /** * Represents the object of the `onCheckChange` event ([see example]({% slug check_helper_funcs_treeview %})). */ export interface TreeViewCheckChangeEvent { /** * The item that is selected or deselected. */ item: any; /** * The hierarchical index of the item. The indices are zero-based. * The first root item has a `0` (zero) index. If the first root item has children, the first child acquires a `0_0` index and the second acquires a `0_1` index. */ itemHierarchicalIndex: string; } /** * Represents the object of the `onItemDragStart` event. */ export interface TreeViewItemDragStartEvent { /** * An event target. */ target: any; /** * The item that is dragged. */ item: any; /** * The hierarchical index of the dragged item. The indices are zero-based. * The first root item has a `0` (zero) index. If the first root item has children, the first child acquires a `0_0` index and the second acquires a `0_1` index. */ itemHierarchicalIndex: string; } /** * Represents the object of the `onItemDragOver` event ([see example]({% slug dragdrop_treeview %})). */ export interface TreeViewItemDragOverEvent { /** * The target that is associated with the dragged item. */ target: any; /** * The item that is dragged. */ item: any; /** * The hierarchical index of the dragged item. The indices are zero-based. * The first root item has a `0` (zero) index. If the first root item has children, the first child acquires a `0_0` index and the second acquires a `0_1` index. */ itemHierarchicalIndex: string; /** * The X (horizontal) coordinate (in pixels) at which the event occurred that is relative to the left edge of the entire document. * Includes any portion of the document which is not currently visible. */ pageX: number; /** * The Y (vertical) coordinate (in pixels) at which the event occurred that is relative to the whole document. * `pageY` observes any vertical scrolling of the page. */ pageY: number; /** * Provides the horizontal coordinate within the client area of the application at which the event occurred * (as opposed to the coordinate within the page). */ clientX: number; /** * Provides the vertical coordinate within the client area of the application at which the event occurred * (as opposed to the coordinate within the page). */ clientY: number; } /** * Represents the object of the `onItemDragEnd` event ([see example]({% slug dragdrop_treeview %})). */ export interface TreeViewItemDragEndEvent { /** * The target that is associated with the dragged item. */ target: any; /** * The item that is dragged. */ item: any; /** * The hierarchical index of the dragged item. The indices are zero-based. * The first root item has a `0` (zero) index. If the first root item has children, the first child acquires a `0_0` index and the second acquires a `0_1` index. */ itemHierarchicalIndex: string; /** * The X (horizontal) coordinate (in pixels) at which the event occured that is relative to the left edge of the entire document. * `pageX` includes any portion of the document that is not currently visible. */ pageX: number; /** * The Y (vertical) coordinate (in pixels) at which the event occured that is relative to the whole document. * `pageY` observes any vertical scrolling of the page. */ pageY: number; /** * Provides the horizontal coordinate within the client area of the application at which the event occurred * (as opposed to the coordinate within the page). */ clientX: number; /** * Provides the vertical coordinate within the client area of the application at which the event occurred * (as opposed to the coordinate within the page). */ clientY: number; }