IGridSettings
Defined in: js-api/src/interfaces/d4.ts:3673
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
addNewRowOnLastRowEdit | boolean | Automatically adds a new row in the end of the dataframe when the last row is edited The grid should also be in the editable mode | js-api/src/interfaces/d4.ts:3687 |
allowBlockSelection | boolean | Mouse drag on the data cells selects both rows and columns | js-api/src/interfaces/d4.ts:3739 |
allowChangeCurrentObject | boolean | Whether the current object (shown in the context panel) is changed when you click on a column header. | js-api/src/interfaces/d4.ts:3790 |
allowColHeaderResizing | boolean | Resizing column header by dragging the border between the header and the first row | js-api/src/interfaces/d4.ts:3838 |
allowColReordering | boolean | Reordering columns by dragging the header | js-api/src/interfaces/d4.ts:3786 |
allowColResizing | boolean | Resizing columns by dragging the border between column headers | js-api/src/interfaces/d4.ts:3841 |
allowColSelection | boolean | Shift+click on a header to select a column Shift+mouse drag on the headers to select multiple columns Ctrl+click to invert selection Ctrl+Shift+click to deselect | js-api/src/interfaces/d4.ts:3745 |
allowColumnMenu | boolean | Whether the "hamburger" menu should be shown for a column when the mouse is over its header | js-api/src/interfaces/d4.ts:3771 |
allowContentPanning | boolean | Right-click and drag to pan content | js-api/src/interfaces/d4.ts:3761 |
allowDynamicMenus | boolean | - | js-api/src/interfaces/d4.ts:3940 |
allowEdit | boolean | Indicates whether the grid is editable. See also Show Add New Row Icon | js-api/src/interfaces/d4.ts:3678 |
allowRowDragging | boolean | Whether row (rows) can be dragged out of the grid. | js-api/src/interfaces/d4.ts:3793 |
allowRowReordering | boolean | Drag any cell (except the row number) to reorder rows Drag the row number column to select rows | js-api/src/interfaces/d4.ts:3749 |
allowRowResizing | boolean | Resize rows by dragging the border between rows on a row header. Applicable only to grid. | js-api/src/interfaces/d4.ts:3799 |
allowRowSelection | boolean | Mouse drag on the rows headers selects rows Ctrl+click to invert selection Shift+mouse drag to select multiple rows Ctrl+Shift+mouse drag to unselect | js-api/src/interfaces/d4.ts:3758 |
allowSorting | boolean | Whether to sort when user double-clicks on the column header | js-api/src/interfaces/d4.ts:3752 |
allowStickyMeta | "Auto" | "Always" | "Never" | - | js-api/src/interfaces/d4.ts:3902 |
autoResizeColumnWidths | boolean | Automatically resize column widths when row height is resized | js-api/src/interfaces/d4.ts:3781 |
autoScrollColumnIntoView | boolean | Automatically scroll column into view when this column becomes current | js-api/src/interfaces/d4.ts:3774 |
autoScrollRowIntoView | boolean | Automatically scroll current row into view when it is set from outside (for instance, as a result of clicking on a point in a scatter plot) | js-api/src/interfaces/d4.ts:3778 |
backColor | number | - | js-api/src/interfaces/d4.ts:3855 |
categoricalColorScheme | number[] | Applies only to columns with 100+ categories; below that, the column's color coding is used. | js-api/src/interfaces/d4.ts:3916 |
cellStyle | any | - | js-api/src/interfaces/d4.ts:3920 |
cellTextColor | number | - | js-api/src/interfaces/d4.ts:3863 |
colHeaderBackColor | number | - | js-api/src/interfaces/d4.ts:3859 |
colHeaderFont | string | - | js-api/src/interfaces/d4.ts:3830 |
colHeaderHeight | number | Column header height. If not specified, it is calculated automatically. See also Col Labels Orientation, Horz Col Labels Height | js-api/src/interfaces/d4.ts:3700 |
colHeaderMouseOverTextColor | number | - | js-api/src/interfaces/d4.ts:3861 |
colHeaderTextColor | number | - | js-api/src/interfaces/d4.ts:3857 |
colLabelsOrientation | "Auto" | "Horz" | "Vert" | Orientation of the column header text. In spreadsheet mode, it defaults to horizontal no matter how small the columns are. In heat map mode, it depends on whether the text can fit in the area. | js-api/src/interfaces/d4.ts:3835 |
colorCoding | "Auto" | "All" | "None" | Color-coding that applies to all columns. Additionally, each column can be individually color-coded. | js-api/src/interfaces/d4.ts:3824 |
columnHeaderTypes | string[] | - | js-api/src/interfaces/d4.ts:3918 |
columns | any[] | - | js-api/src/interfaces/d4.ts:3924 |
controlsFont | string | - | js-api/src/interfaces/d4.ts:3674 |
currentCellTextColor | number | - | js-api/src/interfaces/d4.ts:3865 |
currentRowCellStyle | any | - | js-api/src/interfaces/d4.ts:3922 |
currentRowColor | number | - | js-api/src/interfaces/d4.ts:3849 |
defaultCellFont | string | - | js-api/src/interfaces/d4.ts:3826 |
description | string | Viewer description that gets shown at the Descriptor Position. Markup is supported. | js-api/src/interfaces/d4.ts:3950 |
descriptionPosition | "Left" | "Right" | "Top" | "Bottom" | - | js-api/src/interfaces/d4.ts:3962 |
descriptionVisibilityMode | "Auto" | "Always" | "Never" | - | js-api/src/interfaces/d4.ts:3964 |
drawEveryRow | boolean | Indicates the way colors are sampled in the heatmap mode when there is not enough pixels on the screen for each row: True: each row is draws (but the result is blended and the resulting color might not represent any row) False: a row is sampled and then drawn as one pixel (but non-sampled rows do not get drawn at all) Applicable only to heatmap. | js-api/src/interfaces/d4.ts:3806 |
extendLastColumn | boolean | - | js-api/src/interfaces/d4.ts:3795 |
filter | string | Formula that filters out rows to show. Examples: ${AGE} > 20 or ${WEIGHT / 2)} > 100, ${SEVERITY} == 'Medium', ${RACE}.endsWith('sian') | js-api/src/interfaces/d4.ts:3938 |
frozenColumns | number | - | js-api/src/interfaces/d4.ts:3818 |
globalColorScaling | boolean | true: colors are scaled based on the global min/max in all numerical columns false: colors are scaled based on the column min/max. Applicable only to heatmap. | js-api/src/interfaces/d4.ts:3872 |
heatmapColors | boolean | Whether the heatmap should be color-coded (you might want to do it programmatically) See also [globalColorScaling] | js-api/src/interfaces/d4.ts:3876 |
heatmapHorzScroll | number[] | Heatmap horizontal scroll positions (maxRangeValue, minValue, maxValue) | js-api/src/interfaces/d4.ts:3905 |
heatmapVertScroll | number[] | Heatmap vertical scroll positions (maxRangeValue, minValue, maxValue) | js-api/src/interfaces/d4.ts:3908 |
help | string | Help to be shown when user clicks on the '?' icon on top. Could either be in markdown, or a URL (starting with '/' or 'http'). | js-api/src/interfaces/d4.ts:3954 |
horzColLabelsHeight | number | Height of the column labels when the orientation is horizontal, and Col Header Height is not specified. | js-api/src/interfaces/d4.ts:3708 |
initializationFunction | string | Namespace-qualified function that gets executed when a viewer is initialized | js-api/src/interfaces/d4.ts:3957 |
isGrid | boolean | Indicates whether the control is in the grid or heatmap mode. Typically, you don't need to change it manually. | js-api/src/interfaces/d4.ts:3729 |
isHeatmap | boolean | - | js-api/src/interfaces/d4.ts:3926 |
linearColorScheme | number[] | - | js-api/src/interfaces/d4.ts:3913 |
marginBottom | number | - | js-api/src/interfaces/d4.ts:3900 |
marginLeft | number | - | js-api/src/interfaces/d4.ts:3894 |
marginRight | number | - | js-api/src/interfaces/d4.ts:3898 |
marginTop | number | - | js-api/src/interfaces/d4.ts:3896 |
maxFontSize | number | - | js-api/src/interfaces/d4.ts:3828 |
maxHeatmapColumns | number | - | js-api/src/interfaces/d4.ts:3928 |
missingValueColor | number | - | js-api/src/interfaces/d4.ts:3843 |
mouseOverRowColor | number | - | js-api/src/interfaces/d4.ts:3851 |
mouseOverRowStripeColor | number | - | js-api/src/interfaces/d4.ts:3853 |
onInitializedScript | string | JavaScript that gets executed after a viewer is initialized and added to the TableView | js-api/src/interfaces/d4.ts:3960 |
pinnedRowColumnNames | string[] | - | js-api/src/interfaces/d4.ts:3723 |
pinnedRowValues | string[] | - | js-api/src/interfaces/d4.ts:3725 |
rowHeaderBackColor | number | - | js-api/src/interfaces/d4.ts:3867 |
rowHeight | number | Applicable only to grid | js-api/src/interfaces/d4.ts:3711 |
rowSource | "All" | "Filtered" | "Selected" | "SelectedOrCurrent" | "FilteredSelected" | "MouseOverGroup" | "CurrentRow" | "MouseOverRow" | Determines the rows shown on the plot. | js-api/src/interfaces/d4.ts:3931 |
rowTooltip | string | Newline-separated list of column names to be used in a tooltip. Requires showTooltip to be enabled. | js-api/src/interfaces/d4.ts:3892 |
selectedColsColor | number | - | js-api/src/interfaces/d4.ts:3847 |
selectedRowsColor | number | - | js-api/src/interfaces/d4.ts:3845 |
showAddNewRowIcon | boolean | When [allowEditable] is true, shows the last virtual row that the user can edit. This row gets appended to the underlying table as soon as any value is entered. The grid should also be in the editable mode | js-api/src/interfaces/d4.ts:3683 |
showCellTooltip | boolean | - | js-api/src/interfaces/d4.ts:3883 |
showColumnGridlines | boolean | - | js-api/src/interfaces/d4.ts:3783 |
showColumnGroups | boolean | - | js-api/src/interfaces/d4.ts:3763 |
showColumnLabels | boolean | - | js-api/src/interfaces/d4.ts:3693 |
showColumnTooltip | boolean | - | js-api/src/interfaces/d4.ts:3888 |
showContextMenu | boolean | Whether the context menu is shown | js-api/src/interfaces/d4.ts:3809 |
showCurrentCellOutline | boolean | - | js-api/src/interfaces/d4.ts:3820 |
showCurrentRowIndicator | boolean | Indicates current row with the Current Row Color. | js-api/src/interfaces/d4.ts:3717 |
showDefaultPopupMenu | boolean | Whether items applicable to all viewers (such as Pickup Style) should be shown in a popup menu. Also requires Show Context Menu. | js-api/src/interfaces/d4.ts:3736 |
showFriendlyName | boolean | When checked, friendly name gets shown underneath the column name. | js-api/src/interfaces/d4.ts:3696 |
showHeatmapScrollbars | boolean | Whether to show scrollbars in the heatmap mode Note that scrollbars will still be visible if they are not "expanded" | js-api/src/interfaces/d4.ts:3816 |
showLabels | "Auto" | "Always" | "Never" | - | js-api/src/interfaces/d4.ts:3881 |
showMouseOverRowIndicator | boolean | Indicates mouse-over row by drawing a vertical stripe on the row header | js-api/src/interfaces/d4.ts:3714 |
showReadOnlyNotifications | boolean | Whether to show notifications when the user tries to edit a read-only table | js-api/src/interfaces/d4.ts:3812 |
showRemoveRowIcon | boolean | When [allowEditable] is true, allows user to remove the mouse over row. The grid should also be in the editable mode | js-api/src/interfaces/d4.ts:3691 |
showRowGridlines | boolean | - | js-api/src/interfaces/d4.ts:3767 |
showRowHeader | boolean | - | js-api/src/interfaces/d4.ts:3765 |
showTitle | boolean | - | js-api/src/interfaces/d4.ts:3944 |
showTooltip | string | Controls grid tooltip visibility | js-api/src/interfaces/d4.ts:3879 |
showVisibleColumnsInTooltip | boolean | Include currently visible columns in a tooltip | js-api/src/interfaces/d4.ts:3886 |
sortByColumnNames | string[] | - | js-api/src/interfaces/d4.ts:3719 |
sortTypes | boolean[] | - | js-api/src/interfaces/d4.ts:3721 |
syncNewColumns | boolean | Determines whether newly added columns are added to the grid | js-api/src/interfaces/d4.ts:3911 |
table | string | - | js-api/src/interfaces/d4.ts:3946 |
title | string | - | js-api/src/interfaces/d4.ts:3942 |
topLevelDefaultMenu | boolean | When set to false, default menu appears under the 'Grid' submenu. | js-api/src/interfaces/d4.ts:3732 |
vertColLabelsHeight | number | Height of the column labels when the orientation is vertical, and Col Header Height is not specified. | js-api/src/interfaces/d4.ts:3704 |