LIDOR SYSTEMS

Advanced User Interface Controls and Components

IntegralUI Web

Documentation and API Reference


IntegralUITreeGrid

Represents the TreeGrid component for Angular 2. Displays hierarchical data structures in multiple columns.

Properties


  • allowDrag
  • Gets or sets a value indicating whether rows from TreeGrid can be dragged
  • allowDrop
  • Gets or sets a value indicating whether the TreeGrid 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 the root application component
  • columns
  • Gets the collection of column objects that are assigned to the TreeGrid
  • controlStyle
  • Specifies an object that holds a style which determines the appearance of all parts of the TreeGrid
  • dataFields
  • Specifies data fields that match the data in local data source
  • expandColumnIndex
  • Sets the index of a column which cells will contain the expand box
  • focusedCell
  • Gets or sets the cell that has the input focus
  • gridLines
  • Determines whether horizontal and/or vertical lines are shown within the TreeGrid
  • name
  • Uniquely identifies the component
  • rowHeight
  • Specifies the height of treegrid rows, in pixels
  • rowIcon
  • A HTML element which represents a default icon shown for all rows that don't have an icon
  • rows
  • Gets the collection of tree rows that are assigned to the TreeGrid
  • selectedColumn
  • Gets or sets the currently selected column
  • selectedRow
  • Gets or sets the currently selected row
  • selectionMode
  • Gets or sets the method by which tree rows are selected in the TreeGrid
  • showFooter
  • Determines whether footer is visible or not
  • showHeader
  • Determines whether header is visible or not
  • sorting
  • Gets or sets the order by which rows are sorted
  • state
  • Provides information about the current state of the component

Events


Methods


  • addColumn
  • Adds a new column
  • addRow
  • Adds a new row
  • beginLoad
  • Enables change of the expand box image with an animated gif
  • clearColumns
  • Removes all columns
  • clearRows
  • Removes all rows
  • clearSelection
  • Removes the selection status for all rows
  • cloneRow
  • Creates a deep copy of the specified row object
  • collapse
  • Collapses the specified row
  • endLoad
  • Disables changes of the expand box image and returns its default appearance
  • expand
  • Expands the specified row
  • filter
  • Filters the list based on specified parameters
  • findRowById
  • Searches for an row using specified id
  • findRowByText
  • Searches for an row using specified text
  • getFullList
  • Returns an array representing the whole tree structure as a flat list
  • getList
  • Gets the list of child rows for specified tree row
  • getRowParent
  • Gets the parent row of the specified row
  • insertColumnAfter
  • Inserts a new column after specified column
  • insertColumnAt
  • Inserts a new column at specified position
  • insertColumnBefore
  • Inserts a new column before specified column
  • insertRowAfter
  • Inserts a new row after specified row
  • insertRowAt
  • Inserts a new row at specified position
  • insertRowBefore
  • Inserts a new row before specified row
  • isHorScrollVisible
  • Checks whether the horizontal scrollbar is visible
  • isVerScrollVisible
  • Checks whether the vertical scrollbar is visible
  • loadData
  • Populates the TreeGrid content using local or remote data source
  • moveFocusFromCell
  • Moves the input focus from specified cell to another cell depending on direction
  • refresh
  • Refreshes the appearance and layout of a specified column, row or cell
  • removeColumn
  • Removes the specified column
  • removeColumnAt
  • Removes a column at specified position
  • removeRow
  • Removes the specified row
  • removeRowAt
  • Removes an row at specified position
  • resumeLayout
  • Resumes the component layout and updates it
  • scrollPos
  • Gets or sets the position of the TreeGrid scroll bar
  • scrollTo
  • Scrolls the list so that specified row is visible in current view
  • selectRows
  • Sets a collection of tree rows as selected
  • sort
  • Reorders all rows in treegrid structure either in ascending or descending order by specified column
  • suspendLayout
  • Suspends the component layout from any update operations
  • toggle
  • Toggles the specified row to either the expanded or collapsed state
  • updateLayout
  • Updates the TreeGrid layout
  • updateView
  • Updates only the current view of the TreeGrid