Skip to main content

IHistogramSettings

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

Properties​

PropertyTypeDescriptionDefined in
aggTooltipColumnsstring-js-api/src/interfaces/d4.ts:3623
allowColumnSelectionboolean-js-api/src/interfaces/d4.ts:3469
allowDynamicMenusboolean-js-api/src/interfaces/d4.ts:3642
annotationFontstring-js-api/src/interfaces/d4.ts:3674
annotationRegionsstring-js-api/src/interfaces/d4.ts:3668
autoLayoutbooleanSizes the axes automatically and hides the axes and controls that do not fit a small viewer.js-api/src/interfaces/d4.ts:3583
axisFontstring-js-api/src/interfaces/d4.ts:3597
backColornumber-js-api/src/interfaces/d4.ts:3595
binsnumberNumber of bins on the histogramjs-api/src/interfaces/d4.ts:3478
binToRangebooleanBin the values that are in the filter range.js-api/src/interfaces/d4.ts:3539
binWidthRationumberHow much space does bin occupy (1 = no margins, 0 = no bin)js-api/src/interfaces/d4.ts:3575
colorstringNumerical column to be used for color-coding. The values in the bin get aggregated using the Color Aggr Type property.js-api/src/interfaces/d4.ts:3507
colorAggrTypestring-js-api/src/interfaces/d4.ts:3510
colorColumnNamestring-js-api/src/interfaces/d4.ts:3508
controlsFontstringViewer controls elements font.js-api/src/interfaces/d4.ts:3640
descriptionstringViewer description that gets shown at the Descriptor Position. Markup is supported.js-api/src/interfaces/d4.ts:3652
descriptionPosition"Left" | "Right" | "Top" | "Bottom"-js-api/src/interfaces/d4.ts:3664
descriptionVisibilityMode"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:3666
fillSplinebooleanWhether the area below the spline should be filled with the corresponding color. Only applicable when spline is true and split is emptyjs-api/src/interfaces/d4.ts:3560
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:3637
filteredBinsColornumber-js-api/src/interfaces/d4.ts:3599
filteredOutColornumber-js-api/src/interfaces/d4.ts:3605
filterHeightnumber-js-api/src/interfaces/d4.ts:3591
filteringEnabledbooleanAllows to filter table using the range slider on the bottom.js-api/src/interfaces/d4.ts:3461
filterMarginBottomnumber-js-api/src/interfaces/d4.ts:3621
filterMarginTopnumber-js-api/src/interfaces/d4.ts:3619
formulaFontstring-js-api/src/interfaces/d4.ts:3688
formulaLinesstring-js-api/src/interfaces/d4.ts:3676
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:3656
initializationFunctionstringNamespace-qualified function that gets executed when a viewer is initializedjs-api/src/interfaces/d4.ts:3659
invertColorSchemeboolean-js-api/src/interfaces/d4.ts:3512
legendPosition"Left" | "Right" | "Top" | "Bottom" | "Auto" | "RightTop" | "RightBottom" | "LeftTop" | "LeftBottom"-js-api/src/interfaces/d4.ts:3627
legendVisibility"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:3625
linearColorSchemenumber[]-js-api/src/interfaces/d4.ts:3514
marginBottomnumber-js-api/src/interfaces/d4.ts:3617
marginLeftnumber-js-api/src/interfaces/d4.ts:3611
marginRightnumber-js-api/src/interfaces/d4.ts:3615
marginTopnumber-js-api/src/interfaces/d4.ts:3613
normalizeToFilterbooleanWhether the values should be normalized to the filter or globally.js-api/src/interfaces/d4.ts:3536
normalizeValuesbooleanWhether the values should be normalized when multiple histograms are shown. If true, you are comparing distributions; if false, you are comparing absolute values. Requires Split Column Name to be set.js-api/src/interfaces/d4.ts:3523
onInitializedScriptstringJavaScript that gets executed after a viewer is initialized and added to the TableViewjs-api/src/interfaces/d4.ts:3662
rowIndicatorSizenumber-js-api/src/interfaces/d4.ts:3593
rowSource"All" | "Filtered" | "Selected" | "SelectedOrCurrent" | "FilteredSelected" | "MouseOverGroup" | "CurrentRow" | "MouseOverRow"Determines the rows shown on the plot.js-api/src/interfaces/d4.ts:3630
selectedBinsColornumber-js-api/src/interfaces/d4.ts:3601
showBinSelectorbooleanShow bin selector in the left top panel when the mouse is over the histogramjs-api/src/interfaces/d4.ts:3472
showChartsboolean-js-api/src/interfaces/d4.ts:3607
showClippedBinIndicatorsbooleanWhen enabled, shows wavy breaks and arrows on the bins that are clipped by the vertical axis range.js-api/src/interfaces/d4.ts:3503
showColumnSelectorboolean-js-api/src/interfaces/d4.ts:3565
showContextMenubooleanShows the context menu.js-api/src/interfaces/d4.ts:3580
showCurrentRowbooleanIndicates current row as a dot on the horizontal axisjs-api/src/interfaces/d4.ts:3546
showDataframeAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:3672
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.
showDistributionLinesbooleanShows distribution lines for each stack or spline category in the histogram (see also Split and Split Stack).js-api/src/interfaces/d4.ts:3563
showFilteredOutRowsbooleanWhether the filtered out rows should be shown with the semi-transparent color See also Filtered Out Colorjs-api/src/interfaces/d4.ts:3458
showHistogramboolean-js-api/src/interfaces/d4.ts:3577
showMarkersbooleanWhether markers should be drown when multiple histograms are shown. Requires Split Column Name to be set.js-api/src/interfaces/d4.ts:3543
showMouseOverRowbooleanIndicates current row as a dot on the horizontal axisjs-api/src/interfaces/d4.ts:3549
showMouseOverRowGroupbooleanShow the distribution of the values that the mouse is currently over in another viewer.js-api/src/interfaces/d4.ts:3552
showRangeInputsbooleanVisibility of the free-text inputs for the filter rangejs-api/src/interfaces/d4.ts:3572
showRangeSliderboolean-js-api/src/interfaces/d4.ts:3569
showSplitSelectorboolean-js-api/src/interfaces/d4.ts:3567
showTitleboolean-js-api/src/interfaces/d4.ts:3646
showValuesbooleanShow bin values on top of the barsjs-api/src/interfaces/d4.ts:3475
showViewerAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:3670
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.
showXAxisboolean-js-api/src/interfaces/d4.ts:3467
showYAxisboolean-js-api/src/interfaces/d4.ts:3487
splinebooleanWhether the distribution should be rendered as bars or as a spline. When Split is defined, histogram always shows splines.js-api/src/interfaces/d4.ts:3556
splineTensionnumberSpline tension in case multiple histograms are shown. Requires Split Column Name to be set.js-api/src/interfaces/d4.ts:3530
splitstringA categorical column to split data on (each bar represents a category)js-api/src/interfaces/d4.ts:3517
splitColumnNamestring-js-api/src/interfaces/d4.ts:3518
splitStackbooleanIf true, split are shown as stacked binsjs-api/src/interfaces/d4.ts:3526
tablestring-js-api/src/interfaces/d4.ts:3648
titlestring-js-api/src/interfaces/d4.ts:3644
valuestringA numerical column used to calculate the distribution of values.js-api/src/interfaces/d4.ts:3464
valueColumnNamestring-js-api/src/interfaces/d4.ts:3465
valueMaxnumber-js-api/src/interfaces/d4.ts:3485
valueMinnumber-js-api/src/interfaces/d4.ts:3483
valuesColornumber-js-api/src/interfaces/d4.ts:3603
viewportstring-js-api/src/interfaces/d4.ts:3609
xAxisHeightnumberRequires Auto Layout to be turned off.js-api/src/interfaces/d4.ts:3586
xAxisType"linear" | "logarithmic"Spreads the bins evenly on the logarithmic scale.js-api/src/interfaces/d4.ts:3481
yAxisType"linear" | "logarithmic"Scale of the vertical (bin count) axis. On the logarithmic scale, bins with 0 and 1 rows are drawn at the baseline.js-api/src/interfaces/d4.ts:3491
yAxisWidthnumberRequires Auto Layout to be turned off.js-api/src/interfaces/d4.ts:3589
yMaxnumberUpper bound of the vertical axis. Empty means the biggest bin count. Bins that do not fit are clipped.js-api/src/interfaces/d4.ts:3499
yMinnumberLower bound of the vertical axis. Empty means zero. Set Y Min and Y Max to put different histograms on the same scale.js-api/src/interfaces/d4.ts:3495
zoomToRangebooleanWhether the horizontal axis should be zoomed to the range of the visible bins.js-api/src/interfaces/d4.ts:3533