LIDOR SYSTEMS

Advanced User Interface Controls and Components

IntegralUI Web

Documentation and API Reference


IntegralUI.TreeGrid

Represents a TreeGrid directive for AngularJS. Displays hierarchical collection of row objects in multiple columns.

Properties


  • allowCellFocus
  • Gets or sets a value indicating whether row cells can accept input focus
  • allowColumnReorder
  • Gets or sets a value indicating whether columns can be reordered using drag-drop
  • 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
  • Determines whether filter can be applied to the TreeGrid
  • allowFocus
  • Determines whether the rows and cells in the TreeGrid can accept the input focus
  • autoExpand
  • Determines whether during drag drop operation, the row will expand whenever a dragged row is carried over row's space
  • autoSize
  • Determines whether grid height is based on how many rows are visible
  • autoUpdate
  • Determines whether grid layout is updated automatically when its size changes
  • 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
  • displayMode
  • Specifies the performance level of the TreeGrid
  • editorSettings
  • Specifies an object that contains all property settings for the editors used in the TreeGrid
  • enabled
  • Determines whether TreeGrid directive is enabled or disabled
  • events
  • Specifies an object that holds all event handlers in the TreeGrid
  • expandingColumnIndex
  • Sets the index of a column which cells will contain the expand box
  • gridLines
  • Determines whether horizontal and/or vertical lines are shown within the TreeGrid
  • hoverSelection
  • Determines whether an row can be selected while mouse cursor hovers over its space
  • indent
  • Gets or sets the distance to indent each of the child tree rows levels
  • labelEdit
  • Gets or sets a value indicating whether the text of the tree rows can be edited
  • mouseWheelSpeed
  • Specifies the scrolling speed when mouse wheel is used in the TreeGrid
  • name
  • Gets or sets the name of the TreeGrid
  • options
  • Specifies an object that holds all options available in the TreeGrid
  • paging
  • An object that determines the page size and whether pagination feature is enabled
  • pathSeparator
  • Gets or sets the delimiter string that the tree row path uses
  • rowHeight
  • Specifies the height of grid 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
  • selectionMode
  • Gets or sets the method by which tree rows are selected in the TreeGrid
  • showExpandBoxes
  • Determines whether expand boxes are visible or not
  • showFooter
  • Determines whether footer is visible or not
  • showHeader
  • Determines whether header is visible or not
  • showIcons
  • Determines whether icons are visible or not
  • sorting
  • Gets or sets the order by which rows are sorted

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
  • closeEditor
  • Removes the editor from specified cell and completes the editing process
  • collapse
  • Collapses the specified row
  • currentPage
  • Gets or sets the page that is currently visible
  • endLoad
  • Disables changes of the expand box image and returns its default appearance
  • ensureVisible
  • Ensures that the row is visible, expanding rows and scrolling the current view as necessary
  • expand
  • Expands the specified row
  • expandColIndex
  • Specifies teh column which contains cells with expand box
  • exportToJSON
  • Exports the whole tree structure as tree or flat list in JSON format
  • filter
  • Filters the TreeGrid data, based on specified conditions
  • findRowById
  • Searches for an row using specified id
  • findRowByPath
  • Searches for an row using specified path
  • findRowByText
  • Searches for an row using specified text
  • firstPage
  • Makes the first page visible
  • focus
  • Sets the input focus to specified tree row
  • getCellAt
  • Returns a cell over which mouse cursor is positioned
  • getFlatList
  • Returns an array representing the whole tree structure as a flat list
  • getFullPath
  • Gets the path from the root row to the specified row
  • getHoverColumn
  • Returns a column over which mouse cursor is hovering
  • getList
  • Gets the list of child rows for specified tree row
  • getMaxScrollPos
  • Retrieves the maximum scroll position of the scrollbar
  • getRowAt
  • Returns a row over which mouse cursor is positioned
  • getRowLevel
  • Gets the level of the row in tree view structure
  • getRowParent
  • Gets the parent row of the specified row
  • getScrollPos
  • Retrieves the current position of the scrollbar
  • 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
  • isScrollBarVisible
  • Checks whether the scrollbar is visible
  • lastPage
  • Makes the last page visible
  • loadData
  • Populates the TreeGrid content using local or remote data source
  • openEditor
  • Displays an editor for specified cell and starts the editing process
  • moveColumn
  • Moves a column in specified direction
  • moveRow
  • Moves a row or set of rows in specified direction
  • nextPage
  • Makes the next page from the current one visible
  • refresh
  • Refreshes the appearance and layout of a specified column, row or cell
  • prevPage
  • Makes the previous page from the current one visible
  • 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 TreeGrid layout and updates it, internally calls the updateLayout method
  • scrollTo
  • Scrolls the current view of the TreeGrid to show specified row at specified position
  • selectedColumn
  • Gets or sets the currently selected column
  • selectedRow
  • Gets or sets the currently selected row
  • selectedRows
  • Gets the collection of selected tree rows
  • setScrollPos
  • Sets the position of the TreeGrid scroll bar
  • sort
  • Reorders all rows in grid structure either in ascending or descending order
  • suspendLayout
  • Suspends the TreeGrid layout from any updates
  • toggle
  • Toggles the specified row to either the expanded or collapsed state
  • topRow
  • Gets or sets the currently visible row displayed at top position
  • updateLayout
  • Updates the TreeGrid layout
  • updateView
  • Updates only the current view of the TreeGrid