DataViews
Common
Version 1
GrapeCity DataViewsJS External module Common GrapeCity DataViewsJS External module

Common External module

Classes

Interfaces

Type aliases

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

ColumnEditor

ColumnEditor: ICustomEditorConstructor | TextInputEditor

Defines column editor types.

DataRecord

DataRecord: HashMap<string>

Defines type of one data record in a dataset.

DataScopeType

DataScopeType: "group" | "node"

Data scope types

DataSet

DataSet: DataRecord[] | IDataSource

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

DataViewSelection

DataViewSelection: "all" | "selectedRows" | "selectedCells" | "selectedColumns"

DataView selection.

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

FilterOperator

FilterOperator: "∈" | "memberOf" | "∉" | "notMemberOf" | "=" | "equal" | "!=" | "≠" | "<>" | "notEqual" | ">" | "greaterThan" | ">=" | "greaterThanAndEqual" | "<" | "lessThan" | "<=" | "lessThanAndEqual" | "beginWith" | "notBeginWith" | "endWith" | "notEndWith" | "contain" | "notContain" | "after" | "afterOrEqual" | "before" | "beforeOrEqual" | "tomorrow" | "today" | "yesterday" | "nextWeek" | "thisWeek" | "lastWeek" | "nextMonth" | "thisMonth" | "lastMonth" | "nextQuarter" | "thisQuarter" | "lastQuarter" | "nextYear" | "thisYear" | "lastYear" | "yearToDate" | "inQuarter" | "inMonth"

Defines available filter operators

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

GanttLabelFormatter

GanttLabelFormatter: Object

Defines label formatter

GroupConverter

GroupConverter: Object

A function that is used to specify the grouping name

param

The raw value that needs to be grouped

param

The full record that needs to be grouped

returns

The converted 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

MonthNames

MonthNames: Object

Defines month names.

SelectedItem

SelectedItem: Object

Defines type of selected record

SortConverter

SortConverter: Object

Defines signature of sort converter.

param

The raw value that needs to be sorted.

param

The full record that needs to be sorted.

returns

The converted value.

TextInputEditor

TextInputEditor: Object

Defines interface for text-based editors.

TimeLineScale

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

Defines values for IGanttOptions.timeLineScale

WeekDays

WeekDays: Object

Defines week days.