Skip to main content

IBoxPlotSettings

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

Properties​

PropertyTypeDescriptionDefined in
adjustmentModestringHow 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:2698
allowColorSynchronizationboolean-js-api/src/interfaces/d4.ts:2747
allowDynamicMenusboolean-js-api/src/interfaces/d4.ts:2831
alphanumberSignificance level for the group comparison (0 < alpha < 1).js-api/src/interfaces/d4.ts:2674
annotationFontstring-js-api/src/interfaces/d4.ts:2873
annotationRegionsstring-js-api/src/interfaces/d4.ts:2867
autoLayoutboolean-js-api/src/interfaces/d4.ts:2749
axisFontstring-js-api/src/interfaces/d4.ts:2756
axisType"linear" | "logarithmic"-js-api/src/interfaces/d4.ts:2556
axisUseColumnFormatboolean-js-api/src/interfaces/d4.ts:2769
backColornumber-js-api/src/interfaces/d4.ts:2785
baselineModestringControl 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:2704
binColorstringColumn to color-code boxes (Q2-Q3 region) or inner violin shapes. See also Bin Color Aggr Type.js-api/src/interfaces/d4.ts:2577
binColorAggrTypestringAggregation function for color-coding. See also Bin Color.js-api/src/interfaces/d4.ts:2582
binColorColumnNamestring-js-api/src/interfaces/d4.ts:2578
binsnumberNumber of KDE bins to display a violin plot.js-api/src/interfaces/d4.ts:2772
categoricalColorSchemenumber[]Applies only to columns with 100+ categories; below that, the column's color coding is used.js-api/src/interfaces/d4.ts:2803
category1stringIf Category 2 is not defined, sets Markers Color the same as the currently selected column.js-api/src/interfaces/d4.ts:2528
category1ColumnNamestring-js-api/src/interfaces/d4.ts:2529
category1MapstringTime unit map function for Category 1 Column Names (applicable to dates only).js-api/src/interfaces/d4.ts:2532
category2stringIf defined, sets Markers Color the same as the currently selected column.js-api/src/interfaces/d4.ts:2535
category2ColumnNamestring-js-api/src/interfaces/d4.ts:2536
category2MapstringTime unit map function for Category 2 Column Names (applicable to dates only).js-api/src/interfaces/d4.ts:2539
categoryColumnNamesstring[]-js-api/src/interfaces/d4.ts:2525
categoryFontstring-js-api/src/interfaces/d4.ts:2758
categoryOrderstringHow the categories are ordered: by name, row count, an aggregated value, or manually.js-api/src/interfaces/d4.ts:2551
colorAxisType"linear" | "logarithmic"-js-api/src/interfaces/d4.ts:2594
colorMaxnumber-js-api/src/interfaces/d4.ts:2603
colorMinnumber-js-api/src/interfaces/d4.ts:2601
controlBandColornumberColor of the band highlighting the control group in control comparisons mode.js-api/src/interfaces/d4.ts:2798
controlComparisonsbooleanCompare 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:2689
controlGroupstringCategory used as the control group for control comparisons.js-api/src/interfaces/d4.ts:2692
controlsFontstringViewer controls elements font.js-api/src/interfaces/d4.ts:2829
covariatestringNumeric 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:2678
covariateColumnNamestring-js-api/src/interfaces/d4.ts:2679
defaultBoxColornumber-js-api/src/interfaces/d4.ts:2795
descriptionstringViewer description that gets shown at the Descriptor Position. Markup is supported. Viewer description that gets shown at the Descriptor Position. Markup is supported.js-api/src/interfaces/d4.ts:2847
descriptionPosition"Left" | "Right" | "Top" | "Bottom"-js-api/src/interfaces/d4.ts:2863
descriptionVisibilityMode"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:2865
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:2826
filteredOutRowsColornumber-js-api/src/interfaces/d4.ts:2789
filteredRowsColornumber-js-api/src/interfaces/d4.ts:2787
formulaFontstring-js-api/src/interfaces/d4.ts:2887
formulaLinesstring-js-api/src/interfaces/d4.ts:2875
helpstringHelp to be shown when user clicks on the '?' icon on top. Could either be in markdown, or a URL (starting with '/' or 'http'). 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:2853
initializationFunctionstringNamespace-qualified function that gets executed when a viewer is initialized Namespace-qualified function that gets executed when a viewer is initializedjs-api/src/interfaces/d4.ts:2857
interquartileLineWidthnumberWidth of interquartile line, if Auto Layout is enabled, it will be scaled when violins are too narrow.js-api/src/interfaces/d4.ts:2765
invertColorSchemebooleanReverses 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:2599
invertYAxisboolean-js-api/src/interfaces/d4.ts:2562
labelOrientation"Auto" | "Horz" | "Vert"-js-api/src/interfaces/d4.ts:2545
legendPosition"Left" | "Right" | "Top" | "Bottom" | "Auto" | "RightTop" | "RightBottom" | "LeftTop" | "LeftBottom"-js-api/src/interfaces/d4.ts:2816
legendVisibility"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:2814
linearColorSchemenumber[]-js-api/src/interfaces/d4.ts:2800
markerColorstringColumn 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:2588
markerColorColumnNamestring-js-api/src/interfaces/d4.ts:2589
markerColorMapstringCategorical coloring time unit map function (applicable to dates only).js-api/src/interfaces/d4.ts:2592
markerMaxSizenumber-js-api/src/interfaces/d4.ts:2623
markerMinSizenumber-js-api/src/interfaces/d4.ts:2621
markerOpacitynumber-js-api/src/interfaces/d4.ts:2629
markersstring-js-api/src/interfaces/d4.ts:2615
markersColumnNamestring-js-api/src/interfaces/d4.ts:2616
markerSizenumber-js-api/src/interfaces/d4.ts:2627
markerSizeColumnNamestring-js-api/src/interfaces/d4.ts:2607
markerSizeScaling"linear" | "logarithmic"Linear or logarithmic scale for the Marker Size Column.js-api/src/interfaces/d4.ts:2610
markersMapstringMarker category time unit map function (applicable to dates only).js-api/src/interfaces/d4.ts:2619
markerTypestring-js-api/src/interfaces/d4.ts:2625
methodstringTest method (empty = auto-selected by category count): 2 categories — Welch / Student 3+ categories — Welch / Fisher ANOVA control comparisons — Dunnett / Holm-Welchjs-api/src/interfaces/d4.ts:2685
missingValueColornumber-js-api/src/interfaces/d4.ts:2793
onInitializedScriptstringJavaScript that gets executed after a viewer is initialized and added to the TableView JavaScript that gets executed after a viewer is initialized and added to the TableViewjs-api/src/interfaces/d4.ts:2861
plotStylestring-js-api/src/interfaces/d4.ts:2754
rowSource"All" | "Filtered" | "Selected" | "SelectedOrCurrent" | "FilteredSelected" | "MouseOverGroup" | "CurrentRow" | "MouseOverRow"Determines the rows shown on the plot.js-api/src/interfaces/d4.ts:2819
rowTooltipstringNewline-separated list of column names to be used in a tooltip. Requires showTooltip to be enabled.js-api/src/interfaces/d4.ts:2812
selectedRowsColornumber-js-api/src/interfaces/d4.ts:2791
showAllCategoriesbooleanWhen checked, both categories from Category 1 and Category 2 columns are shown ignoring axis size adjustments.js-api/src/interfaces/d4.ts:2752
showAssumptionChecksbooleanShow 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:2671
showAvgboolean-js-api/src/interfaces/d4.ts:2735
showCategoryAxisboolean-js-api/src/interfaces/d4.ts:2541
showCategorySelectorboolean-js-api/src/interfaces/d4.ts:2543
showColorSelectorboolean-js-api/src/interfaces/d4.ts:2584
showComparisonControlsbooleanShow 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:2666
showContextMenubooleanWhether the context menu is shown Whether the context menu is shownjs-api/src/interfaces/d4.ts:2835
showDataframeAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:2871
showDataframeFormulaLinesbooleanControl the visibility of dataframe-originated formula lines. Edit formula lines by right-clicking and selecting "ToolsFormula Lines" from the popup menu. Requires the PowerPack plugin.
showEmptyCategoriesbooleanInclude plots, which are empty or have null values.js-api/src/interfaces/d4.ts:2573
showGroupComparisonbooleanCompare 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:2662
showInliersCountbooleanShown 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:2723
showInsideValuesbooleanShow points inside the interquartile range (Q3 - Q1).js-api/src/interfaces/d4.ts:2643
showLabels"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:2808
showLowerDashboolean-js-api/src/interfaces/d4.ts:2633
showMarkersbooleanShow individual data point markers. When off, only the box / violin shapes are drawn.js-api/src/interfaces/d4.ts:2613
showMaxboolean-js-api/src/interfaces/d4.ts:2733
showMeanCrossboolean-js-api/src/interfaces/d4.ts:2631
showMedboolean-js-api/src/interfaces/d4.ts:2737
showMedianDashboolean-js-api/src/interfaces/d4.ts:2637
showMinboolean-js-api/src/interfaces/d4.ts:2731
showMinorCategoriesbooleanDisplay subcategories - category combinations in the x axis table.js-api/src/interfaces/d4.ts:2548
showMouseOverPointboolean-js-api/src/interfaces/d4.ts:2652
showMouseOverRowGroupboolean-js-api/src/interfaces/d4.ts:2654
showOutliersCountbooleanShown 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:2729
showOutsideValuesbooleanShow points outside the interquartile range (Q3 - Q1).js-api/src/interfaces/d4.ts:2646
showPValuebooleanShow 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:2650
showQ1boolean-js-api/src/interfaces/d4.ts:2741
showQ3boolean-js-api/src/interfaces/d4.ts:2743
showSelectedRowsbooleanWhen 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:2710
showSizeSelectorboolean-js-api/src/interfaces/d4.ts:2605
showStatisticsboolean-js-api/src/interfaces/d4.ts:2706
showStdevboolean-js-api/src/interfaces/d4.ts:2739
showTitleboolean-js-api/src/interfaces/d4.ts:2839
showTooltipstringControls box plot tooltip visibilityjs-api/src/interfaces/d4.ts:2806
showTotalCountboolean-js-api/src/interfaces/d4.ts:2717
showUpperDashboolean-js-api/src/interfaces/d4.ts:2635
showValueAxisboolean-js-api/src/interfaces/d4.ts:2564
showValueSelectorboolean-js-api/src/interfaces/d4.ts:2566
showValuesLimitnumberPoints are not shown if the number of rows is greater than Show Values Limit.js-api/src/interfaces/d4.ts:2640
showViewerAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:2869
showViewerFormulaLinesbooleanControl the visibility of viewer-level formula lines. Edit formula lines by right-clicking and selecting "ToolsFormula Lines" from the popup menu. Requires the PowerPack plugin.
statisticsstring[]-js-api/src/interfaces/d4.ts:2712
statisticsFontstring-js-api/src/interfaces/d4.ts:2760
statisticsFormatstringFormat for the statistics table values (p-values and comparison statistics use fixed formats).js-api/src/interfaces/d4.ts:2715
tablestring-js-api/src/interfaces/d4.ts:2841
titlestring-js-api/src/interfaces/d4.ts:2837
valuestring-js-api/src/interfaces/d4.ts:2553
valueColumnNamestring-js-api/src/interfaces/d4.ts:2554
valueMaxnumber-js-api/src/interfaces/d4.ts:2560
valueMinnumber-js-api/src/interfaces/d4.ts:2558
viewportstring-js-api/src/interfaces/d4.ts:2745
violinLineWidthnumberWidth of the violin outline; drawn on top of the points.js-api/src/interfaces/d4.ts:2783
violinWhiskerColornumberColor of violin whiskers and interquartile range line.js-api/src/interfaces/d4.ts:2780
whiskerColornumberColor 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:2777
whiskerLineWidthnumber-js-api/src/interfaces/d4.ts:2762
whiskerWidthRationumber-js-api/src/interfaces/d4.ts:2767
zoomValuesByFilterbooleanIf 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:2570