Version 1
Common GrapeCity DataViewsJS External module

Common External module

Type aliases

AddRowPosition

AddRowPosition: "top" | "bottom"

Defines available values for [[IGridLayoutOptions.autoAddRowPosition]]

CellRendererFn

CellRendererFn: Object

Define interface of custom cell renderer function.

ColumnAction

ColumnAction: string | IColumnAction

Predefined or custom column action

ColumnChangeKind

ColumnChangeKind: "visible" | "pinned" | "resized" | "groupCollapsed"

Defines values for IColumnChangedEventArgs.type

ColumnCssClassFn

ColumnCssClassFn: Object

Defines interface of IColumn.cssClass function

param

the arguments the function will take

returns

single or multiple CSS class names

DataRecord

DataRecord: HashMap<string>

Defines type of one data record in a dataset.

DataSet

DataSet: DataRecord[] | IDataSource

Type alias for array of data records or a custom data source interface.

EditingStatus

EditingStatus: "beforeStartEditing" | "startEditing" | "beforeEndEditing" | "endEditing" | "cancelEditing"

Defines values for IEditingEventArgs.status

EventHandler

EventHandler<TArgs>: Object

Represents an event handler. Event handlers are functions invoked when events are raised.

Type parameters

  • TArgs

FormatFunc

FormatFunc: Object

Defines interface of formatting callback used to format displayed values in the DataView

param

the arguments the format function will take

returns

the formatted value

HeaderRowRenderFn

HeaderRowRenderFn: Object

Defines interface of custom renderer function of header row

param

the entire row data

param

the DOM container

HierarchyOffsetFn

HierarchyOffsetFn: Object

Defines interface of IHierarchyDescriptor.offset callback

param

instance of DataManagerNode

SortConverter

SortConverter: Object

Defines signature of sort converter.

param

The raw value that needs to be sorted.

returns

The converted value.

TimeLineScale

TimeLineScale: "hourQuarter" | "hour" | "day" | "week" | "month"

Defines values for IGanttOptions.timeLineScale