Version 1
IGridInternal GrapeCity DataViewsJS Interface

IGridInternal Interface

Defines internal interface of the DataView

Heirarchy

Events

beforeLoadRange

beforeLoadRange: Event<IBeforeLoadRangeEventArgs>

This event occurs before loading next data range.

columnChanged

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

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

editing

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

focusChanged

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

grouping

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

rowClick

This event occurs when clicking the row

rowDbClick

This event occurs when double-clicking the row

scrollOver

scrollOver: Event<IScrollEventArgs>

This event occurs when scrolling over grid.

selectionChanged

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

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

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

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

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