DataViews
Common
Version 1
Common Interface IGrid GrapeCity DataViewsJS Interface

IGrid Interface

Represents multi-purpose data view component

Heirarchy

Events

Properties

Methods

Events

beforeLoadRange

beforeLoadRange: Event<IBeforeLoadRangeEventArgs>

This event occurs before loading next data range.

columnChanged

columnChanged: Event<IColumnChangedEventArgs>

This event occurs when the user changes the column visibility, pinned option, or column width, or expands or collapses the column group from UI

columnReorder

columnReorder: Event<IColumnReorderEventArgs>

This event occurs when the user starts dragging the column and before dropping the column in the column header

editing

editing: Event<IEditingEventArgs>

This event occurs before editing, once editing has started, before editing has ended, or editing has stopped

focusChanged

focusChanged: Event<IFocusChangedEventArgs>

This event occurs when the focused row is changed. The event fires on GridLayout or HorizontalLayout

grouping

grouping: Event<IGroupingEventArgs>

This event occurs when the user updates groups with UI actions. The event is fired before the actual update happens

rowClick

rowClick: Event<IRowClickEventArgs>

This event occurs when clicking the row

rowDbClick

rowDbClick: Event<IRowClickEventArgs>

This event occurs when double-clicking the row

rowReorder

rowReorder: Event<IRowReorderEventArgs>

This event occurs when the user starts dragging the row header and before inserting the row at new position

scrollOver

scrollOver: Event<IScrollEventArgs>

This event occurs when scrolling over grid.

selectionChanged

selectionChanged: Event<ISelectionChangedEventArgs>

This event occurs when the user changes the selection using UI actions

Properties

columns

columns: IColumn[]

Gets or sets the columns definitions array. Notice that set new value will not refresh UI automatically, call DataView.invalidate if want to see UI changes

container

container: HTMLElement

Gets the HTML element where the grid attached to

data

data: IDataManager

Gets instance of DataManager

layoutEngine

layoutEngine: ILayoutEngine

Gets instance of current ILayoutEngine

options

options: IGridOptions

Gets grid options.

uid

uid: string

Get the unique id of the current instance

Methods

clearSelection

  • clearSelection(): void

  • Clears selected cells.

    Returns void

destroy

  • destroy(): void

  • Removes the DataView instance from the host and destroys all resources used by the current instance which includes layout engine and group strategy

    Returns void

export

  • export(options: ExportOptions): any

  • Export data from the grid. Filtered rows are not included

    Parameters

    • options: ExportOptions

      export options

    Returns any

formatDataItem

  • formatDataItem(dataItem: any): any

  • Formats the dataItem based on column formats.

    Parameters

    • dataItem: any

      Object that needs to be formatted.

    Returns any

    The formatted object.

getItem

  • Gets item information by given index or row id.

    Parameters

    • index: ItemKey

      the input view index or row id. notice that the index is the view index in control

    Returns IItemInfo

    the queried item information

  • Gets items information by given array of indices or row ids

    Parameters

    • index: ItemKey[]

      an array of indices or row ids

    Returns IItemInfo[]

    the queried items

getSelections

  • Gets the data of selected rows.

    Returns SelectedItem[]

    The information of selected rows, including data, sourceRow and columns id.

invalidate

  • invalidate(): void

  • Invalidates the entire control

    Returns void

refresh

  • refresh(area: string): void

  • Refreshes the specified part of the grid.

    Parameters

    • area: string

      The area that needs to be refreshed.

    Returns void