RealGrid2 API
Interface
MultiCheckCellRenderer

MultiCheckCellRenderer

Renderer that selects one or more than one value

Signature:

export interface MultiCheckCellRenderer extends CellRenderer

Extends: CellRenderer

Remarks

Select one or several values specified in values or DataColumn.values.

[Superclass]

CellRenderer

Example

//string type
column.renderer = 'multicheck';
 
//object type
column.renderer = {
 "type": "multicheck",
 "values": ["Apple","Pear","Grape"],
 "labels": ["apple","pear","grape"],
 "multiSelect": true
}

Events

PropertyTypeDescription
disabledCallbackMultiCheckDisabledCallbackA callback that determines whether to disable
keyToValueCallbackMultiCheckKeydownCallbackA callback that retrieves the value to select or deselect on keydown

Properties

PropertyTypeDescription
directionLayoutDirectionArrange the list horizontally or vertically.
gapnumberSpacing between items
itemDirectionLayoutDirectionArrange the selection box and label horizontally or vertically.
itemGapnumberSpacing between input element and label element
itemReversebooleanChange the order of selection boxes and labels.
labelsstring[]Display values in list
multiSelectbooleanMultiple selection
type"multicheck"Type: Multiple Select
useCtrlNumberbooleanWhether to select when Ctrl + number is entered
useImagesbooleanDisplay the selection box using an image.
valuesstring[]Actual values in list
wrapbooleanWhether to wrap a line if the total width of the item is larger than the width of the cell

Event Desk

disabledCallback

A callback that determines whether to disable it or not.

Type - MultiCheckDisabledCallback

Remarks:

If true is returned from the callback, it becomes disabled.


keyToValueCallback

A callback that retrieves the value to select or deselect on keydown

Type - MultiCheckKeydownCallback


Properties Desc

direction

Arrange the list horizontally or vertically.

Type - LayoutDirection


gap

Spacing between items

Type - number


itemDirection

Arrange the selection box and label horizontally or vertically.

Type - LayoutDirection


itemGap

Spacing between input element and label element

Type - number


itemReverse

Change the order of selection boxes and labels.

Type - boolean


labels

Display values in list

Type - string[]


multiSelect

Multiple selection?

Type - boolean


type

Type: Multiple Select

Type - "multicheck"


useCtrlNumber

Whether to select when Ctrl + number is entered

Type - boolean

Remarks:

When changing the shortcut key, use MultiCheckCellRenderer.keyToValueCallback.


useImages

Display the selection box using an image.

Type - boolean


values

actual values in list

Type - string[]


wrap

Whether to wrap a line if the total width of the item is greater than the width of the cell

Type - boolean