Skip to main content

IGridSettings

Defined in: js-api/src/interfaces/d4.ts:3692

Properties​

PropertyTypeDescriptionDefined in
addNewRowOnLastRowEditbooleanAutomatically adds a new row in the end of the dataframe when the last row is edited The grid should also be in the editable modejs-api/src/interfaces/d4.ts:3706
allowBlockSelectionbooleanMouse drag on the data cells selects both rows and columnsjs-api/src/interfaces/d4.ts:3758
allowChangeCurrentObjectbooleanWhether the current object (shown in the context panel) is changed when you click on a column header.js-api/src/interfaces/d4.ts:3809
allowColHeaderResizingbooleanResizing column header by dragging the border between the header and the first rowjs-api/src/interfaces/d4.ts:3857
allowColReorderingbooleanReordering columns by dragging the headerjs-api/src/interfaces/d4.ts:3805
allowColResizingbooleanResizing columns by dragging the border between column headersjs-api/src/interfaces/d4.ts:3860
allowColSelectionbooleanShift+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 deselectjs-api/src/interfaces/d4.ts:3764
allowColumnMenubooleanWhether the "hamburger" menu should be shown for a column when the mouse is over its headerjs-api/src/interfaces/d4.ts:3790
allowContentPanningbooleanRight-click and drag to pan contentjs-api/src/interfaces/d4.ts:3780
allowDynamicMenusboolean-js-api/src/interfaces/d4.ts:3959
allowEditbooleanIndicates whether the grid is editable. See also Show Add New Row Iconjs-api/src/interfaces/d4.ts:3697
allowRowDraggingbooleanWhether row (rows) can be dragged out of the grid.js-api/src/interfaces/d4.ts:3812
allowRowReorderingbooleanDrag any cell (except the row number) to reorder rows Drag the row number column to select rowsjs-api/src/interfaces/d4.ts:3768
allowRowResizingbooleanResize rows by dragging the border between rows on a row header. Applicable only to grid.js-api/src/interfaces/d4.ts:3818
allowRowSelectionbooleanMouse drag on the rows headers selects rows Ctrl+click to invert selection Shift+mouse drag to select multiple rows Ctrl+Shift+mouse drag to unselectjs-api/src/interfaces/d4.ts:3777
allowSortingbooleanWhether to sort when user double-clicks on the column headerjs-api/src/interfaces/d4.ts:3771
allowStickyMeta"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:3921
autoResizeColumnWidthsbooleanAutomatically resize column widths when row height is resizedjs-api/src/interfaces/d4.ts:3800
autoScrollColumnIntoViewbooleanAutomatically scroll column into view when this column becomes currentjs-api/src/interfaces/d4.ts:3793
autoScrollRowIntoViewbooleanAutomatically 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:3797
backColornumber-js-api/src/interfaces/d4.ts:3874
categoricalColorSchemenumber[]Applies only to columns with 100+ categories; below that, the column's color coding is used.js-api/src/interfaces/d4.ts:3935
cellStyleany-js-api/src/interfaces/d4.ts:3939
cellTextColornumber-js-api/src/interfaces/d4.ts:3882
colHeaderBackColornumber-js-api/src/interfaces/d4.ts:3878
colHeaderFontstring-js-api/src/interfaces/d4.ts:3849
colHeaderHeightnumberColumn header height. If not specified, it is calculated automatically. See also Col Labels Orientation, Horz Col Labels Heightjs-api/src/interfaces/d4.ts:3719
colHeaderMouseOverTextColornumber-js-api/src/interfaces/d4.ts:3880
colHeaderTextColornumber-js-api/src/interfaces/d4.ts:3876
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:3854
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:3843
columnHeaderTypesstring[]-js-api/src/interfaces/d4.ts:3937
columnsany[]-js-api/src/interfaces/d4.ts:3943
controlsFontstring-js-api/src/interfaces/d4.ts:3693
currentCellTextColornumber-js-api/src/interfaces/d4.ts:3884
currentRowCellStyleany-js-api/src/interfaces/d4.ts:3941
currentRowColornumber-js-api/src/interfaces/d4.ts:3868
defaultCellFontstring-js-api/src/interfaces/d4.ts:3845
descriptionstringViewer description that gets shown at the Descriptor Position. Markup is supported.js-api/src/interfaces/d4.ts:3969
descriptionPosition"Left" | "Right" | "Top" | "Bottom"-js-api/src/interfaces/d4.ts:3981
descriptionVisibilityMode"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:3983
drawEveryRowbooleanIndicates 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:3825
extendLastColumnboolean-js-api/src/interfaces/d4.ts:3814
filterstringFormula that filters out rows to show. Examples: ${AGE} > 20 or ${WEIGHT / 2)} > 100, ${SEVERITY} == 'Medium', ${RACE}.endsWith('sian')js-api/src/interfaces/d4.ts:3957
frozenColumnsnumber-js-api/src/interfaces/d4.ts:3837
globalColorScalingbooleantrue: 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:3891
heatmapColorsbooleanWhether the heatmap should be color-coded (you might want to do it programmatically) See also [globalColorScaling]js-api/src/interfaces/d4.ts:3895
heatmapHorzScrollnumber[]Heatmap horizontal scroll positions (maxRangeValue, minValue, maxValue)js-api/src/interfaces/d4.ts:3924
heatmapVertScrollnumber[]Heatmap vertical scroll positions (maxRangeValue, minValue, maxValue)js-api/src/interfaces/d4.ts:3927
helpstringHelp 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:3973
horzColLabelsHeightnumberHeight of the column labels when the orientation is horizontal, and Col Header Height is not specified.js-api/src/interfaces/d4.ts:3727
initializationFunctionstringNamespace-qualified function that gets executed when a viewer is initializedjs-api/src/interfaces/d4.ts:3976
isGridbooleanIndicates 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:3748
isHeatmapboolean-js-api/src/interfaces/d4.ts:3945
linearColorSchemenumber[]-js-api/src/interfaces/d4.ts:3932
marginBottomnumber-js-api/src/interfaces/d4.ts:3919
marginLeftnumber-js-api/src/interfaces/d4.ts:3913
marginRightnumber-js-api/src/interfaces/d4.ts:3917
marginTopnumber-js-api/src/interfaces/d4.ts:3915
maxFontSizenumber-js-api/src/interfaces/d4.ts:3847
maxHeatmapColumnsnumber-js-api/src/interfaces/d4.ts:3947
missingValueColornumber-js-api/src/interfaces/d4.ts:3862
mouseOverRowColornumber-js-api/src/interfaces/d4.ts:3870
mouseOverRowStripeColornumber-js-api/src/interfaces/d4.ts:3872
onInitializedScriptstringJavaScript that gets executed after a viewer is initialized and added to the TableViewjs-api/src/interfaces/d4.ts:3979
pinnedRowColumnNamesstring[]-js-api/src/interfaces/d4.ts:3742
pinnedRowValuesstring[]-js-api/src/interfaces/d4.ts:3744
rowHeaderBackColornumber-js-api/src/interfaces/d4.ts:3886
rowHeightnumberApplicable only to gridjs-api/src/interfaces/d4.ts:3730
rowSource"All" | "Filtered" | "Selected" | "SelectedOrCurrent" | "FilteredSelected" | "MouseOverGroup" | "CurrentRow" | "MouseOverRow"Determines the rows shown on the plot.js-api/src/interfaces/d4.ts:3950
rowTooltipstringNewline-separated list of column names to be used in a tooltip. Requires showTooltip to be enabled.js-api/src/interfaces/d4.ts:3911
selectedColsColornumber-js-api/src/interfaces/d4.ts:3866
selectedRowsColornumber-js-api/src/interfaces/d4.ts:3864
showAddNewRowIconbooleanWhen [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 modejs-api/src/interfaces/d4.ts:3702
showCellTooltipboolean-js-api/src/interfaces/d4.ts:3902
showColumnGridlinesboolean-js-api/src/interfaces/d4.ts:3802
showColumnGroupsboolean-js-api/src/interfaces/d4.ts:3782
showColumnLabelsboolean-js-api/src/interfaces/d4.ts:3712
showColumnTooltipboolean-js-api/src/interfaces/d4.ts:3907
showContextMenubooleanWhether the context menu is shownjs-api/src/interfaces/d4.ts:3828
showCurrentCellOutlineboolean-js-api/src/interfaces/d4.ts:3839
showCurrentRowIndicatorbooleanIndicates current row with the Current Row Color.js-api/src/interfaces/d4.ts:3736
showDefaultPopupMenubooleanWhether 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:3755
showFriendlyNamebooleanWhen checked, friendly name gets shown underneath the column name.js-api/src/interfaces/d4.ts:3715
showHeatmapScrollbarsbooleanWhether 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:3835
showLabels"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:3900
showMouseOverRowIndicatorbooleanIndicates mouse-over row by drawing a vertical stripe on the row headerjs-api/src/interfaces/d4.ts:3733
showReadOnlyNotificationsbooleanWhether to show notifications when the user tries to edit a read-only tablejs-api/src/interfaces/d4.ts:3831
showRemoveRowIconbooleanWhen [allowEditable] is true, allows user to remove the mouse over row. The grid should also be in the editable modejs-api/src/interfaces/d4.ts:3710
showRowGridlinesboolean-js-api/src/interfaces/d4.ts:3786
showRowHeaderboolean-js-api/src/interfaces/d4.ts:3784
showTitleboolean-js-api/src/interfaces/d4.ts:3963
showTooltipstringControls grid tooltip visibilityjs-api/src/interfaces/d4.ts:3898
showVisibleColumnsInTooltipbooleanInclude currently visible columns in a tooltipjs-api/src/interfaces/d4.ts:3905
sortByColumnNamesstring[]-js-api/src/interfaces/d4.ts:3738
sortTypesboolean[]-js-api/src/interfaces/d4.ts:3740
syncNewColumnsbooleanDetermines whether newly added columns are added to the gridjs-api/src/interfaces/d4.ts:3930
tablestring-js-api/src/interfaces/d4.ts:3965
titlestring-js-api/src/interfaces/d4.ts:3961
topLevelDefaultMenubooleanWhen set to false, default menu appears under the 'Grid' submenu.js-api/src/interfaces/d4.ts:3751
vertColLabelsHeightnumberHeight of the column labels when the orientation is vertical, and Col Header Height is not specified.js-api/src/interfaces/d4.ts:3723