LIDOR SYSTEMS

Advanced User Interface Controls and Components

IntegralUI Web

Documentation and API Reference


IntegralUI.Grid

Represents a Grid directive for AngularJS, displays tabular data sets.

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 Grid can be dragged
  • allowDrop
  • Gets or sets a value indicating whether the Grid can accept data during drag&drop
  • allowFilter
  • Determines whether filter can be applied to the Grid
  • allowFocus
  • Determines whether the rows and cells in the Grid can accept the input focus
  • autoUpdate
  • Determines whether grid layout is updated automatically when its size changes
  • columns
  • Gets the collection of column objects that are assigned to the Grid
  • controlStyle
  • Specifies an object that holds a style which determines the appearance of all parts of the Grid
  • dataFields
  • Specifies data fields that match the data in local data source
  • displayMode
  • Specifies the performance level of the Grid
  • editorSettings
  • Specifies an object that contains all property settings for the editors used in the Grid
  • enabled
  • Determines whether Grid directive is enabled or disabled
  • events
  • Specifies an object that holds all event handlers in the Grid
  • 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 Grid
  • grouping
  • An object that determines whether grouping feature is enabled
  • groups
  • Gets the collection of groups that are assigned to the Grid
  • 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 Grid
  • name
  • Gets or sets the name of the Grid
  • options
  • Specifies an object that holds all options available in the Grid
  • paging
  • An object that determines the page size and whether pagination feature is enabled
  • 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 Grid
  • selectionMode
  • Gets or sets the method by which tree rows are selected in the Grid
  • 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


  • afterEdit
  • Occurs after editing process ends
  • afterLabelEdit
  • Occurs after row label is edited
  • afterSelect
  • Occurs after row is selected
  • beforeEdit
  • Occurs before editing process starts
  • beforeLabelEdit
  • Occurs before row label is edited
  • beforeSelect
  • Occurs before row is selected
  • cellClick
  • Occurs when cell is clicked
  • cellHover
  • Occurs when mouse cursor hovers over cell space
  • cellvalueChanged
  • Occurs after cell value is changed
  • cellvalueChanging
  • Occurs before cell value is changed
  • change
  • Occurs when data is changed during filtering or sorting
  • clearColumns
  • Occurs when all columns are removed
  • clearGroups
  • Occurs when all groups are removed
  • clearRows
  • Occurs when all rows are removed
  • columnAdded
  • Occurs after column is added to the collection
  • columnAdding
  • Occurs before column is added to the collection
  • columnClick
  • Occurs when column is clicked
  • columnDblClick
  • Occurs when column is double clicked
  • columnHover
  • Occurs when the mouse cursor hovers over column header
  • columnPoschanged
  • Occurs after column changes its position during column reordering
  • columnPoschanging
  • Occurs before column changes its position during column reordering
  • columnRemoved
  • Occurs after column is removed from the collection
  • columnRemoving
  • Occurs before column is removed from the collection
  • columnRightclick
  • Occurs when column header is clicked using right mouse button
  • columnSizechanged
  • Occurs when column changes its size
  • dragDrop
  • Occurs when a drag-and-drop operation is completed
  • dragEnter
  • Occurs when an object is dragged into the component's bounds
  • dragLeave
  • Occurs when an object is dragged out of the component's bounds
  • dragOver
  • Occurs when an object is dragged over the component's bounds
  • gotFocus
  • Occurs when row or cell receives the input focus
  • groupAdded
  • Occurs after group is added to the collection
  • groupAdding
  • Occurs before group is added to the collection
  • groupChange
  • Occurs when group order has changed during drag drop operation
  • groupRemoved
  • Occurs after group is removed from the collection
  • groupRemoving
  • Occurs before group is removed from the collection
  • keyDown
  • Occurs when key is pressed down for the first time
  • keyPress
  • Occurs when key is pressed
  • keyUp
  • Occurs when key is released
  • loadComplete
  • Occurs when data loading process is completed
  • lostFocus
  • Occurs when row or cell loses the input focus
  • rowAdded
  • Occurs after row is added to the collection
  • rowAdding
  • Occurs before row is added to the collection
  • rowClick
  • Occurs when row is clicked
  • rowDblClick
  • Occurs when row is double clicked
  • rowHover
  • Occurs when the mouse cursor hovers over row space
  • rowRemoved
  • Occurs after row is removed from the collection
  • rowRemoving
  • Occurs before row is removed from the collection
  • rowRightClick
  • Occurs when row is clicked using right mouse button
  • scrollPosChanged
  • Occurs when position of scrollbar has changed
  • selectionChanged
  • Occurs whenever selection changes from one row to another
  • updateComplete
  • Occurs when updating of control layout is completed

Methods


  • addColumn
  • Adds a new column
  • addGroup
  • Adds a new group
  • addRow
  • Adds a new row
  • beginLoad
  • Enables change of the expand box image with an animated gif
  • clearColumns
  • Removes all columns
  • clearGroups
  • Removes all groups
  • clearRows
  • Removes all rows
  • clearSelection
  • Removes the selection status for all rows
  • closeEditor
  • Removes the editor from specified cell and completes the editing process
  • 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
  • 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 Grid data, based on specified conditions
  • findRowById
  • Searches for an row using specified id
  • 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
  • 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
  • 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
  • insertGroupAfter
  • Inserts a new group after specified group
  • insertGroupAt
  • Inserts a new group at specified position
  • insertGroupBefore
  • Inserts a new group before specified group
  • 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 Grid 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
  • removeGroup
  • Removes the specified group
  • removeGroupAt
  • Removes a group at specified position
  • removeRow
  • Removes the specified row
  • removeRowAt
  • Removes an row at specified position
  • resumeLayout
  • Resumes the Grid layout and updates it, internally calls the updateLayout method
  • scrollTo
  • Scrolls the current view of the Grid 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 Grid scroll bar
  • sort
  • Reorders all rows in grid structure either in ascending or descending order
  • suspendLayout
  • Suspends the Grid layout from any updates
  • topRow
  • Gets or sets the currently visible row displayed at top position
  • updateLayout
  • Updates the Grid layout
  • updateView
  • Updates only the current view of the Grid