LIDOR SYSTEMS

Advanced User Interface Controls and Components

IntegralUI Web

Documentation and API Reference


IntegralUITreeView

Represents the TreeView component for Angular. Displays hierarchical data structures.

Properties


  • allowDrag
  • Gets or sets a value indicating whether items from TreeView can be dragged
  • allowDrop
  • Gets or sets a value indicating whether the TreeView can accept data during drag&drop
  • allowFilter
  • Gets or sets a value indicating whether filter is active
  • allowFocus
  • Gets or sets a value indicating whether keyboard focus is allowed
  • appRef
  • Holds a reference to application view
  • autoExpand
  • Determines whether the target item during drag drop automatically expands.
  • controlStyle
  • Specifies an object that contains all style settings for the TreeView
  • data
  • Specifies an object that holds data related to the component
  • dataFields
  • Specifies data fields that match the data in local data source
  • enabled
  • Determines whether the TreeView is enabled or disabled
  • focusedItem
  • Gets or sets the item that has the input focus
  • indent
  • Gets or sets the distance to indent each of the child tree items levels
  • itemDisplay
  • Specifies whether the item space is displayed partially or in full
  • items
  • Gets the collection of tree items that are assigned to the TreeView
  • mouseWheelSpeed
  • Specifies the speed of the mouse wheel by which TreeView is scrolled
  • name
  • Uniquely identifies the component
  • selectedItem
  • an object that points to the currently selected item
  • selectionMode
  • Specifies the selection type: none, single or multiple
  • showExpandBox
  • Determines whether expand box is visible or not for all items
  • showScroll
  • Specifies whether the horizontal, vertical or both scrollbars are visible or not
  • size
  • Gets or sets the width and height of the TreeView in pixels from code
  • sorting
  • Gets or sets the sort order which items are sorted
  • state
  • Provides information about the current state of the TreeView: disabled, hovered, etc.
  • virtualMode
  • Gets or sets a value indicating whether virtualization is active

Events


  • afterCollapse
  • Occurs after item is collapsed
  • afterExpand
  • Occurs after item is expanded
  • afterSelect
  • Occurs after item is selected
  • beforeCollapse
  • Occurs before item starts to collapse
  • beforeExpand
  • Occurs before item starts to expand
  • beforeSelect
  • Occurs before item is selected
  • change
  • Occurs when data is changed during filtering or sorting
  • clear
  • Occurs when all items are removed
  • dragDrop
  • Occurs when a drag-and-drop operation is completed
  • dragEnd
  • Occurs when drag drop operation ends
  • dragEnter
  • when mouse cursor enters the TreeView space during drag drop operation
  • dragLeave
  • Occurs when mouse cursor leaves the TreeView space during drag drop operation
  • dragOver
  • Occurs when an object is dragged over the component's bounds
  • dragStart
  • Occurs just before item is dragged
  • enabledChanged
  • Occurs when enabled property value changes
  • itemAdded
  • Occurs after item is added to the collection
  • itemAdding
  • Occurs before item is added to the collection
  • itemClick
  • Occurs when item is clicked using the left mouse button
  • itemDblClick
  • Occurs when item is double clicked using the left mouse button
  • itemHover
  • Occurs when mouse cursor hovers over item space
  • itemRemoved
  • Occurs after item is removed from the collection
  • itemRemoving
  • Occurs before item is removed from the collection
  • itemRightClick
  • Occurs when item is clicked using the right mouse button
  • keyDown
  • Occurs when key is hold down while the item has focus
  • keyPress
  • Occurs when key is pressed while the item has focus
  • keyUp
  • Occurs when key is released while the item has focus
  • loadComplete
  • Occurs when data loading process is completed
  • scrollPosChanged
  • Occurs when position of scrollbar has changed
  • selectionChanged
  • Occurs whenever selection changes from one item to another
  • stateChanged
  • Occurs when state property value changes
  • updateComplete
  • Occurs when updating of component layout is completed

Methods


  • addItem
  • Adds a new item
  • beginLoad
  • Enables change of the expand box image with an animated gif
  • clearItems
  • Removes all items
  • clearSelection
  • Removes the selection status for all items
  • cloneItem
  • Creates a deep copy of specified item
  • collapse
  • Collapses the specified item
  • endLoad
  • Disables changes of the expand box image and returns its default appearance
  • expand
  • Expands the specified item
  • exportToJSON
  • Exports the TreeView data in a JSON file format
  • filter
  • Filters the list based on specified parameters
  • findItemById
  • Searches for an item using specified id
  • findItemByText
  • Searches for an item using specified text
  • getFullList
  • Retrieves a flat list of all items in the TreeView
  • getItemLevel
  • Retrieves the current level of the item within the tree hieararchy
  • getItemParent
  • Gets the parent item of the specified item
  • getList
  • Returns a list of all items
  • getNextItem
  • Gets the next item in the tree hierarchy from the specified item
  • getPrevItem
  • Gets the previous item in the tree hierarchy from specified item
  • getTopItem
  • Retrieves the item that appears as a first visible item in the current view
  • insertItemAfter
  • Inserts a new item after specified item
  • insertItemAt
  • Inserts a new item at specified position
  • insertItemBefore
  • Inserts a new item before specified item
  • loadData
  • Populates the TreeView content using local or remote data source
  • moveFocusFromItem
  • Moves the input focus from specified item to another item depending on direction
  • moveItem
  • Moves the specified item to a new position within the tree hiararchy
  • refresh
  • Applies the control styles and updates the appearance of the TreeView
  • removeItem
  • Removes the specified item
  • removeItemAt
  • Removes an item at specified position
  • resumeLayout
  • Resumes the component layout and updates it
  • selectItems
  • Changes the status of provided items as selected
  • scrollPos
  • Gets or Sets the position of the scrollbar
  • scrollTo
  • Scrolls the list so that specified item is visible in current view
  • sort
  • Reorders all items in tree structure either in ascending or descending order
  • suspendLayout
  • Suspends the component layout from any update operations
  • toggle
  • Toggles the specified item to either the expanded or collapsed state
  • updateLayout
  • Updates the TreeView layout