IBoxPlotSettings
Defined in: js-api/src/interfaces/d4.ts:1070
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
adjustmentMode | string | How the Adjust By covariate transforms the plotted value: ratio — plot value / covariate regressOut — plot the value residualized on the covariate ANCOVA (a method choice) handles the covariate inside the test instead. | js-api/src/interfaces/d4.ts:1241 |
allowColorSynchronization | boolean | - | js-api/src/interfaces/d4.ts:1290 |
allowDynamicMenus | boolean | - | js-api/src/interfaces/d4.ts:1374 |
alpha | number | Significance level for the group comparison (0 < alpha < 1). | js-api/src/interfaces/d4.ts:1217 |
annotationFont | string | - | js-api/src/interfaces/d4.ts:1410 |
annotationRegions | string | - | js-api/src/interfaces/d4.ts:1404 |
autoLayout | boolean | - | js-api/src/interfaces/d4.ts:1292 |
axisFont | string | - | js-api/src/interfaces/d4.ts:1299 |
axisType | "linear" | "logarithmic" | - | js-api/src/interfaces/d4.ts:1099 |
axisUseColumnFormat | boolean | - | js-api/src/interfaces/d4.ts:1312 |
backColor | number | - | js-api/src/interfaces/d4.ts:1328 |
baselineMode | string | Control baseline for control comparisons, driven by the on-chart toggle: Pooled control — one control group compared against across all data Matched · per stratum — each box vs the control within its own stratum (the 2nd split column) Matched needs a second category column; otherwise it behaves as pooled. | js-api/src/interfaces/d4.ts:1247 |
binColor | string | Column to color-code boxes (Q2-Q3 region) or inner violin shapes. See also Bin Color Aggr Type. | js-api/src/interfaces/d4.ts:1120 |
binColorAggrType | string | Aggregation function for color-coding. See also Bin Color. | js-api/src/interfaces/d4.ts:1125 |
binColorColumnName | string | - | js-api/src/interfaces/d4.ts:1121 |
bins | number | Number of KDE bins to display a violin plot. | js-api/src/interfaces/d4.ts:1315 |
categoricalColorScheme | number[] | Applies only to columns with 100+ categories; below that, the column's color coding is used. | js-api/src/interfaces/d4.ts:1346 |
category1 | string | If Category 2 is not defined, sets Markers Color the same as the currently selected column. | js-api/src/interfaces/d4.ts:1074 |
category1ColumnName | string | - | js-api/src/interfaces/d4.ts:1075 |
category1Map | string | Time unit map function for Category 1 Column Names (applicable to dates only). | js-api/src/interfaces/d4.ts:1078 |
category2 | string | If defined, sets Markers Color the same as the currently selected column. | js-api/src/interfaces/d4.ts:1081 |
category2ColumnName | string | - | js-api/src/interfaces/d4.ts:1082 |
category2Map | string | Time unit map function for Category 2 Column Names (applicable to dates only). | js-api/src/interfaces/d4.ts:1085 |
categoryColumnNames | string[] | - | js-api/src/interfaces/d4.ts:1071 |
categoryFont | string | - | js-api/src/interfaces/d4.ts:1301 |
colorAxisType | "linear" | "logarithmic" | - | js-api/src/interfaces/d4.ts:1137 |
colorMax | number | - | js-api/src/interfaces/d4.ts:1146 |
colorMin | number | - | js-api/src/interfaces/d4.ts:1144 |
controlBandColor | number | Color of the band highlighting the control group in control comparisons mode. | js-api/src/interfaces/d4.ts:1341 |
controlComparisons | boolean | Compare each group against the control group (3+ categories). Driven by the on-chart control selector: on when a group is picked, off when its blank row is picked. | js-api/src/interfaces/d4.ts:1232 |
controlGroup | string | Category used as the control group for control comparisons. | js-api/src/interfaces/d4.ts:1235 |
controlsFont | string | Viewer controls elements font. | js-api/src/interfaces/d4.ts:1372 |
covariate | string | Numeric covariate to adjust the value by before comparing groups (e.g. organ weight by body weight). See Adjustment for the transform. Single category column only. | js-api/src/interfaces/d4.ts:1221 |
covariateColumnName | string | - | js-api/src/interfaces/d4.ts:1222 |
defaultBoxColor | number | - | js-api/src/interfaces/d4.ts:1338 |
description | string | Viewer description that gets shown at the Descriptor Position. Markup is supported. | js-api/src/interfaces/d4.ts:1388 |
descriptionPosition | "Left" | "Right" | "Top" | "Bottom" | - | js-api/src/interfaces/d4.ts:1400 |
descriptionVisibilityMode | "Auto" | "Always" | "Never" | - | js-api/src/interfaces/d4.ts:1402 |
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:1369 |
filteredOutRowsColor | number | - | js-api/src/interfaces/d4.ts:1332 |
filteredRowsColor | number | - | js-api/src/interfaces/d4.ts:1330 |
formulaFont | string | - | js-api/src/interfaces/d4.ts:1424 |
formulaLines | string | - | js-api/src/interfaces/d4.ts:1412 |
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:1392 |
initializationFunction | string | Namespace-qualified function that gets executed when a viewer is initialized | js-api/src/interfaces/d4.ts:1395 |
interquartileLineWidth | number | Width of interquartile line, if Auto Layout is enabled, it will be scaled when violins are too narrow. | js-api/src/interfaces/d4.ts:1308 |
invertColorScheme | boolean | Reverses the viewer's color scheme and the column's linear color-coding. Does not apply to the column's conditional or categorical color-coding. Affects this viewer only: the grid and other viewers keep their colors. | js-api/src/interfaces/d4.ts:1142 |
invertYAxis | boolean | - | js-api/src/interfaces/d4.ts:1105 |
labelOrientation | "Auto" | "Horz" | "Vert" | - | js-api/src/interfaces/d4.ts:1091 |
legendPosition | "Auto" | "Left" | "Right" | "Top" | "Bottom" | "RightTop" | "RightBottom" | "LeftTop" | "LeftBottom" | - | js-api/src/interfaces/d4.ts:1359 |
legendVisibility | "Auto" | "Always" | "Never" | - | js-api/src/interfaces/d4.ts:1357 |
linearColorScheme | number[] | - | js-api/src/interfaces/d4.ts:1343 |
markerColor | string | Column to color-code markers. Changing Category 1 or Category 2 sets the color scheme to categorical (same as selected category column). | js-api/src/interfaces/d4.ts:1131 |
markerColorColumnName | string | - | js-api/src/interfaces/d4.ts:1132 |
markerColorMap | string | Categorical coloring time unit map function (applicable to dates only). | js-api/src/interfaces/d4.ts:1135 |
markerMaxSize | number | - | js-api/src/interfaces/d4.ts:1166 |
markerMinSize | number | - | js-api/src/interfaces/d4.ts:1164 |
markerOpacity | number | - | js-api/src/interfaces/d4.ts:1172 |
markers | string | - | js-api/src/interfaces/d4.ts:1158 |
markersColumnName | string | - | js-api/src/interfaces/d4.ts:1159 |
markerSize | number | - | js-api/src/interfaces/d4.ts:1170 |
markerSizeColumnName | string | - | js-api/src/interfaces/d4.ts:1150 |
markerSizeScaling | "linear" | "logarithmic" | Linear or logarithmic scale for the Marker Size Column. | js-api/src/interfaces/d4.ts:1153 |
markersMap | string | Marker category time unit map function (applicable to dates only). | js-api/src/interfaces/d4.ts:1162 |
markerType | string | - | js-api/src/interfaces/d4.ts:1168 |
method | string | Test method (empty = auto-selected by category count): 2 categories — Welch / Student 3+ categories — Welch / Fisher ANOVA control comparisons — Dunnett / Holm-Welch | js-api/src/interfaces/d4.ts:1228 |
missingValueColor | number | - | js-api/src/interfaces/d4.ts:1336 |
onInitializedScript | string | JavaScript that gets executed after a viewer is initialized and added to the TableView | js-api/src/interfaces/d4.ts:1398 |
plotStyle | string | - | js-api/src/interfaces/d4.ts:1297 |
rowSource | "All" | "Filtered" | "Selected" | "SelectedOrCurrent" | "FilteredSelected" | "MouseOverGroup" | "CurrentRow" | "MouseOverRow" | Determines the rows shown on the plot. | js-api/src/interfaces/d4.ts:1362 |
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:1355 |
selectedRowsColor | number | - | js-api/src/interfaces/d4.ts:1334 |
showAllCategories | boolean | When checked, both categories from Category 1 and Category 2 columns are shown ignoring axis size adjustments. | js-api/src/interfaces/d4.ts:1295 |
showAssumptionChecks | boolean | Show the ANOVA/t-test assumption checks under the p-value: per-group normality (Shapiro-Wilk) and equal variances (Brown-Forsythe). Diagnostics only — they never change the test. | js-api/src/interfaces/d4.ts:1214 |
showAvg | boolean | - | js-api/src/interfaces/d4.ts:1278 |
showCategoryAxis | boolean | - | js-api/src/interfaces/d4.ts:1087 |
showCategorySelector | boolean | - | js-api/src/interfaces/d4.ts:1089 |
showColorSelector | boolean | - | js-api/src/interfaces/d4.ts:1127 |
showComparisonControls | boolean | Show the on-chart group-comparison controls (method, control comparisons, control group); with Auto Layout they are also hidden when the viewer is small. | js-api/src/interfaces/d4.ts:1209 |
showContextMenu | boolean | Properties common for all viewers todo: use code generation | js-api/src/interfaces/d4.ts:1378 |
showDataframeAnnotationRegions | boolean | - | js-api/src/interfaces/d4.ts:1408 |
showDataframeFormulaLines | boolean | Control the visibility of dataframe-originated formula lines. Edit formula lines by right-clicking and selecting "Tools | Formula Lines" from the popup menu. Requires the PowerPack plugin. |
showEmptyCategories | boolean | Include plots, which are empty or have null values. | js-api/src/interfaces/d4.ts:1116 |
showGroupComparison | boolean | Compare group means with the test that fits the data: 2 groups — t-test 3+ groups — one-way ANOVA vs control — each group against a control two category columns — two-way ANOVA Method and control are set on-chart. Hidden above 30 group combinations. | js-api/src/interfaces/d4.ts:1205 |
showInliersCount | boolean | Shown values count inside lower and upper bounds, where: IQR = Q3 - Q1. Lower Bound = Q1 - (1.5 * IQR). Upper Bound = Q3 + (1.5 * IQR). | js-api/src/interfaces/d4.ts:1266 |
showInsideValues | boolean | Show points inside the interquartile range (Q3 - Q1). | js-api/src/interfaces/d4.ts:1186 |
showLabels | "Auto" | "Always" | "Never" | - | js-api/src/interfaces/d4.ts:1351 |
showLowerDash | boolean | - | js-api/src/interfaces/d4.ts:1176 |
showMarkers | boolean | Show individual data point markers. When off, only the box / violin shapes are drawn. | js-api/src/interfaces/d4.ts:1156 |
showMax | boolean | - | js-api/src/interfaces/d4.ts:1276 |
showMeanCross | boolean | - | js-api/src/interfaces/d4.ts:1174 |
showMed | boolean | - | js-api/src/interfaces/d4.ts:1280 |
showMedianDash | boolean | - | js-api/src/interfaces/d4.ts:1180 |
showMin | boolean | - | js-api/src/interfaces/d4.ts:1274 |
showMinorCategories | boolean | Display subcategories - category combinations in the x axis table. | js-api/src/interfaces/d4.ts:1094 |
showMouseOverPoint | boolean | - | js-api/src/interfaces/d4.ts:1195 |
showMouseOverRowGroup | boolean | - | js-api/src/interfaces/d4.ts:1197 |
showOutliersCount | boolean | Shown values count outside lower and upper bounds, where: IQR = Q3 - Q1. Lower Bound = Q1 - (1.5 * IQR). Upper Bound = Q3 + (1.5 * IQR). | js-api/src/interfaces/d4.ts:1272 |
showOutsideValues | boolean | Show points outside the interquartile range (Q3 - Q1). | js-api/src/interfaces/d4.ts:1189 |
showPValue | boolean | Show p-value. Press T to toggle. Welch's t-test for two categories, Alexander and Govern's test for three or more. | js-api/src/interfaces/d4.ts:1193 |
showQ1 | boolean | - | js-api/src/interfaces/d4.ts:1284 |
showQ3 | boolean | - | js-api/src/interfaces/d4.ts:1286 |
showSelectedRows | boolean | When checked, selected points are highlighted using the selected rows color. When unchecked, selected points use their regular color coding. | js-api/src/interfaces/d4.ts:1253 |
showSizeSelector | boolean | - | js-api/src/interfaces/d4.ts:1148 |
showStatistics | boolean | - | js-api/src/interfaces/d4.ts:1249 |
showStdev | boolean | - | js-api/src/interfaces/d4.ts:1282 |
showTitle | boolean | - | js-api/src/interfaces/d4.ts:1382 |
showTooltip | string | Controls box plot tooltip visibility | js-api/src/interfaces/d4.ts:1349 |
showTotalCount | boolean | - | js-api/src/interfaces/d4.ts:1260 |
showUpperDash | boolean | - | js-api/src/interfaces/d4.ts:1178 |
showValueAxis | boolean | - | js-api/src/interfaces/d4.ts:1107 |
showValueSelector | boolean | - | js-api/src/interfaces/d4.ts:1109 |
showValuesLimit | number | Points are not shown if the number of rows is greater than Show Values Limit. | js-api/src/interfaces/d4.ts:1183 |
showViewerAnnotationRegions | boolean | - | js-api/src/interfaces/d4.ts:1406 |
showViewerFormulaLines | boolean | Control the visibility of viewer-level formula lines. Edit formula lines by right-clicking and selecting "Tools | Formula Lines" from the popup menu. Requires the PowerPack plugin. |
statistics | string[] | - | js-api/src/interfaces/d4.ts:1255 |
statisticsFont | string | - | js-api/src/interfaces/d4.ts:1303 |
statisticsFormat | string | Format for the statistics table values (p-values and comparison statistics use fixed formats). | js-api/src/interfaces/d4.ts:1258 |
table | string | - | js-api/src/interfaces/d4.ts:1384 |
title | string | - | js-api/src/interfaces/d4.ts:1380 |
value | string | - | js-api/src/interfaces/d4.ts:1096 |
valueColumnName | string | - | js-api/src/interfaces/d4.ts:1097 |
valueMax | number | - | js-api/src/interfaces/d4.ts:1103 |
valueMin | number | - | js-api/src/interfaces/d4.ts:1101 |
viewport | string | - | js-api/src/interfaces/d4.ts:1288 |
violinLineWidth | number | Width of the violin outline; drawn on top of the points. | js-api/src/interfaces/d4.ts:1326 |
violinWhiskerColor | number | Color of violin whiskers and interquartile range line. | js-api/src/interfaces/d4.ts:1323 |
whiskerColor | number | Color of box-plot whiskers, box outline and the slightly transparent box fill. When empty, categories are colored sequentially with the Categorical Color Scheme (by inner subcategory when two category columns are selected). | js-api/src/interfaces/d4.ts:1320 |
whiskerLineWidth | number | - | js-api/src/interfaces/d4.ts:1305 |
whiskerWidthRatio | number | - | js-api/src/interfaces/d4.ts:1310 |
zoomValuesByFilter | boolean | If checked, focuses on filtered points (on value axis) as the filter changes. If current value column is filtered, zoom is not applied. | js-api/src/interfaces/d4.ts:1113 |