ValueColumn

Column information model that inherits GridColumn

Signature:

export interface ValueColumn extends GridColumn

Extends: GridColumn

Remarks

Additional formatting information, etc. is included.

[subclass]

DataColumn

SeriesColumn

Events

Properties

Events Desc

buttonVisibleCallback

Column button display callback

Type - ButtonVisibleCallback

Remarks:

When column.button is set, it is used to display the button only when certain conditions are met.

Example:

column.buttonVisibleCallback = function(grid, index, focused, mouseEntered) {
 return (grid.getValue(index.itemIndex, index.fieldName) === "AAA" && (focused || mouseEntered))
}

styleCallback

Callbacks for styling

Type - CellStyleCallback

Example:

const f = function (grid, cell) {
    return {
        styleName: 'custom-cell'
        editor: 'text'
    }
}
column.styleCallback = f;

Properties Desc

blankWhenCopy

Whether to pass an empty value when copying to the clipboard

For SeriesColumn, the default value is true.

Type - boolean

blankWhenExport

Whether to pass an empty value when exporting

Type - boolean

booleanFormat

Format displayed when the value is in Boolean format specified in the column.

Type - string

Remarks:

Separated with a colon (:) or semicolon (;), the left side is false, and the right side is true.

Example) 'Nub: Yub'

button

Button to display on the right side of the data cell

Type - string

Example:

column.button = 'popup';

buttonVisibility

How to display column buttons

Type - ButtonVisibility

datetimeFormat

If the format displayed when the value is in the date format specified in the column is undefined, the numberFormat specified in GridBase.formatOptions is applied. .

Type - string

Remarks:

Example) 'yy-M-dd'

displayMinusZero

Whether to display something like -0.00 as 0.00

Type - boolean

edgeMark

EdgeMark display status

Type - EdgeMark

Remarks:

Used to highlight cells.

editButtonVisibility

How to display cell editor buttons

Type - ButtonVisibility

Remarks:

Cell editors whose buttons are currently displayed include DropDownCellEditor, DateCellEditor, and SearchCellEditor.

editor

editor

Type - LineCellEditor | PasswordCellEditor | NumberCellEditor | MultiLineCellEditor | DropDownCellEditor | MultiCheckCellEditor | SearchCellEditor | DateCellEditor | BTDateCellEditor | ConfigObject | string

Remarks:

See CellEditor

exportStyleName

Style name to be used when exported to Excel

Type - string

numberFormat

Format displayed when the value is in the numeric format specified in the column

When changing the thousands symbol and decimal point, specify them separately with ;.

Type - string | null

Remarks:

Example) If ' #,##0.### ' undefined, the numberFormat specified in GridBase.formatOptions apply.

Format - Format; Decimal point symbol; Thousands symbol; Rounding classification

Rounding distinction - How to handle specified decimal places c - round up f - round down a - display as absolute value

Example:

// Display `,` for every thousand units and round off decimal places
gridView.columnByName("number").numberFormat = "#,##0";
 
// When changing the thousands symbol and decimal point
gridView.columnByName("number").numberFormat = "#,##0.00;,;."
 
// Display only up to 2 decimal places and discard the 3rd place.
gridView.columnByName("number").numberFormat = "#,##0.00;;;f"

popupMenu

Pop-up menu

Type - ConfigObject[]

Remarks:

Once a menu is designated, the menu button is activated when the mouse enters or focuses on a data cell. MenuItem is an array form of the model.

popupMenuName

Pop-up menu name

Type - string

Remarks:

The menu registered with GridBase.addPopupMenu() is used as the pop-up menu for the column.

prefix

text to be added before

Type - string

Remarks:

When displaying data, the text to be added in front of the specified value is displayed in front of the value.

renderer

renderer

Type - TextCellRenderer | BarCellRenderer | ImageCellRenderer | IconCellRenderer | CheckCellRenderer | MultiCheckCellRenderer | ButtonCellRenderer | ShapeCellRenderer | LinkCellRenderer | SignalBarCellRenderer | Code39CellRenderer | Code128CellRenderer | SeriesTextCellRenderer | SparkLineRenderer | SparkColumnRenderer | SparkWinLossRenderer | ActualTargetTextRenderer | ActualTargetBulletRenderer | TemplateCellRenderer | ConfigObject | string

Remarks:

See CellRenderer

styleName

style class name

Type - string

suffix

text to be added after

Type - string

Remarks:

When displaying data, the text to be added after designation is attached to the end of the value.

textFormat

Format displayed when the value is in text format

Type - string

Remarks:

Separate with a semicolon (;) and specify the same type as the first parameter of String.prototype.replace on the left and the second parameter on the right. Example) '([A-Za-z]*); Mr\. \$1'

textInputCase

Case conversion type of values entered into the editor

Type - TextInputCase

valueSeparator

Separator to separate values

Type - string

Remarks:

A separator used to distinguish values when data is in the form of “value, value” and displayed in the form of “label, label” or a separator used to distinguish the values of fields.