IHistogramSettings
Defined in: js-api/src/interfaces/d4.ts:1930
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
aggTooltipColumns | string | - | js-api/src/interfaces/d4.ts:2096 |
allowColumnSelection | boolean | - | js-api/src/interfaces/d4.ts:1944 |
allowDynamicMenus | boolean | - | js-api/src/interfaces/d4.ts:2115 |
annotationFont | string | - | js-api/src/interfaces/d4.ts:2147 |
annotationRegions | string | - | js-api/src/interfaces/d4.ts:2141 |
autoLayout | boolean | style | js-api/src/interfaces/d4.ts:2058 |
axisFont | string | - | js-api/src/interfaces/d4.ts:2070 |
backColor | number | - | js-api/src/interfaces/d4.ts:2068 |
bins | number | Number of bins on the histogram | js-api/src/interfaces/d4.ts:1953 |
binToRange | boolean | Bin the values that are in the filter range. | js-api/src/interfaces/d4.ts:2014 |
binWidthRatio | number | How much space does bin occupy (1 = no margins, 0 = no bin) | js-api/src/interfaces/d4.ts:2050 |
color | string | Numerical 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:1982 |
colorAggrType | string | - | js-api/src/interfaces/d4.ts:1985 |
colorColumnName | string | - | js-api/src/interfaces/d4.ts:1983 |
controlsFont | string | Viewer controls elements font. | js-api/src/interfaces/d4.ts:2113 |
description | string | Viewer description that gets shown at the Descriptor Position. Markup is supported. | js-api/src/interfaces/d4.ts:2125 |
descriptionPosition | "Left" | "Right" | "Top" | "Bottom" | - | js-api/src/interfaces/d4.ts:2137 |
descriptionVisibilityMode | "Auto" | "Always" | "Never" | - | js-api/src/interfaces/d4.ts:2139 |
fillSpline | boolean | Whether the area below the spline should be filled with the corresponding color. Only applicable when spline is true and split is empty | js-api/src/interfaces/d4.ts:2035 |
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:2110 |
filteredBinsColor | number | - | js-api/src/interfaces/d4.ts:2072 |
filteredOutColor | number | - | js-api/src/interfaces/d4.ts:2078 |
filterHeight | number | - | js-api/src/interfaces/d4.ts:2064 |
filteringEnabled | boolean | Allows to filter table using the range slider on the bottom. | js-api/src/interfaces/d4.ts:1936 |
filterMarginBottom | number | - | js-api/src/interfaces/d4.ts:2094 |
filterMarginTop | number | - | js-api/src/interfaces/d4.ts:2092 |
formulaFont | string | - | js-api/src/interfaces/d4.ts:2161 |
formulaLines | string | - | js-api/src/interfaces/d4.ts:2149 |
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:2129 |
initializationFunction | string | Namespace-qualified function that gets executed when a viewer is initialized | js-api/src/interfaces/d4.ts:2132 |
invertColorScheme | boolean | - | js-api/src/interfaces/d4.ts:1987 |
legendPosition | "Auto" | "Left" | "Right" | "Top" | "Bottom" | "RightTop" | "RightBottom" | "LeftTop" | "LeftBottom" | - | js-api/src/interfaces/d4.ts:2100 |
legendVisibility | "Auto" | "Always" | "Never" | - | js-api/src/interfaces/d4.ts:2098 |
linearColorScheme | number[] | - | js-api/src/interfaces/d4.ts:1989 |
marginBottom | number | - | js-api/src/interfaces/d4.ts:2090 |
marginLeft | number | - | js-api/src/interfaces/d4.ts:2084 |
marginRight | number | - | js-api/src/interfaces/d4.ts:2088 |
marginTop | number | - | js-api/src/interfaces/d4.ts:2086 |
normalizeToFilter | boolean | Whether the values should be normalized to the filter or globally. | js-api/src/interfaces/d4.ts:2011 |
normalizeValues | boolean | Whether 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:1998 |
onInitializedScript | string | JavaScript that gets executed after a viewer is initialized and added to the TableView | js-api/src/interfaces/d4.ts:2135 |
rowIndicatorSize | number | - | js-api/src/interfaces/d4.ts:2066 |
rowSource | "All" | "Filtered" | "Selected" | "SelectedOrCurrent" | "FilteredSelected" | "MouseOverGroup" | "CurrentRow" | "MouseOverRow" | Determines the rows shown on the plot. | js-api/src/interfaces/d4.ts:2103 |
selectedBinsColor | number | - | js-api/src/interfaces/d4.ts:2074 |
showBinSelector | boolean | Show bin selector in the left top panel when the mouse is over the histogram | js-api/src/interfaces/d4.ts:1947 |
showCharts | boolean | - | js-api/src/interfaces/d4.ts:2080 |
showClippedBinIndicators | boolean | When enabled, shows wavy breaks and arrows on the bins that are clipped by the vertical axis range. | js-api/src/interfaces/d4.ts:1978 |
showColumnSelector | boolean | - | js-api/src/interfaces/d4.ts:2040 |
showContextMenu | boolean | Shows the context menu. | js-api/src/interfaces/d4.ts:2055 |
showCurrentRow | boolean | Indicates current row as a dot on the horizontal axis | js-api/src/interfaces/d4.ts:2021 |
showDataframeAnnotationRegions | boolean | - | js-api/src/interfaces/d4.ts:2145 |
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. |
showDistributionLines | boolean | Shows distribution lines for each stack or spline category in the histogram (see also Split and Split Stack). | js-api/src/interfaces/d4.ts:2038 |
showFilteredOutRows | boolean | Whether the filtered out rows should be shown with the semi-transparent color See also Filtered Out Color | js-api/src/interfaces/d4.ts:1933 |
showHistogram | boolean | - | js-api/src/interfaces/d4.ts:2052 |
showMarkers | boolean | Whether markers should be drown when multiple histograms are shown. Requires Split Column Name to be set. | js-api/src/interfaces/d4.ts:2018 |
showMouseOverRow | boolean | Indicates current row as a dot on the horizontal axis | js-api/src/interfaces/d4.ts:2024 |
showMouseOverRowGroup | boolean | Show the distribution of the values that the mouse is currently over in another viewer. | js-api/src/interfaces/d4.ts:2027 |
showRangeInputs | boolean | Visibility of the free-text inputs for the filter range | js-api/src/interfaces/d4.ts:2047 |
showRangeSlider | boolean | - | js-api/src/interfaces/d4.ts:2044 |
showSplitSelector | boolean | - | js-api/src/interfaces/d4.ts:2042 |
showTitle | boolean | - | js-api/src/interfaces/d4.ts:2119 |
showValues | boolean | Show bin values on top of the bars | js-api/src/interfaces/d4.ts:1950 |
showViewerAnnotationRegions | boolean | - | js-api/src/interfaces/d4.ts:2143 |
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. |
showXAxis | boolean | - | js-api/src/interfaces/d4.ts:1942 |
showYAxis | boolean | - | js-api/src/interfaces/d4.ts:1962 |
spline | boolean | Whether 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:2031 |
splineTension | number | Spline tension in case multiple histograms are shown. Requires Split Column Name to be set. | js-api/src/interfaces/d4.ts:2005 |
split | string | A categorical column to split data on (each bar represents a category) | js-api/src/interfaces/d4.ts:1992 |
splitColumnName | string | - | js-api/src/interfaces/d4.ts:1993 |
splitStack | boolean | If true, split are shown as stacked bins | js-api/src/interfaces/d4.ts:2001 |
table | string | - | js-api/src/interfaces/d4.ts:2121 |
title | string | - | js-api/src/interfaces/d4.ts:2117 |
value | string | A numerical column used to calculate the distribution of values. | js-api/src/interfaces/d4.ts:1939 |
valueColumnName | string | - | js-api/src/interfaces/d4.ts:1940 |
valueMax | number | - | js-api/src/interfaces/d4.ts:1960 |
valueMin | number | - | js-api/src/interfaces/d4.ts:1958 |
valuesColor | number | - | js-api/src/interfaces/d4.ts:2076 |
viewport | string | - | js-api/src/interfaces/d4.ts:2082 |
xAxisHeight | number | - | js-api/src/interfaces/d4.ts:2060 |
xAxisType | "linear" | "logarithmic" | Spreads the bins evenly on the logarithmic scale. | js-api/src/interfaces/d4.ts:1956 |
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:1966 |
yAxisWidth | number | - | js-api/src/interfaces/d4.ts:2062 |
yMax | number | Upper bound of the vertical axis. Empty means the biggest bin count. Bins that do not fit are clipped. | js-api/src/interfaces/d4.ts:1974 |
yMin | number | Lower 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:1970 |
zoomToRange | boolean | Whether the horizontal axis should be zoomed to the range of the visible bins. | js-api/src/interfaces/d4.ts:2008 |