Skip to main content

IBarChartSettings

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

Properties​

PropertyTypeDescriptionDefined in
allowDynamicMenusboolean-js-api/src/interfaces/d4.ts:1004
annotationFontstring-js-api/src/interfaces/d4.ts:1040
annotationRegionsstring-js-api/src/interfaces/d4.ts:1034
autoLayoutboolean-js-api/src/interfaces/d4.ts:927
axisColornumber-js-api/src/interfaces/d4.ts:959
axisFontstring-js-api/src/interfaces/d4.ts:949
axisType"linear" | "logarithmic"-js-api/src/interfaces/d4.ts:877
backColornumber-js-api/src/interfaces/d4.ts:957
barBorderLineColornumber-js-api/src/interfaces/d4.ts:971
barBorderLineFilteredColornumber-js-api/src/interfaces/d4.ts:969
barBorderLineMouseOverColornumber-js-api/src/interfaces/d4.ts:967
barBorderLineMouseOverWidthnumber-js-api/src/interfaces/d4.ts:937
barBorderLineWidthnumber-js-api/src/interfaces/d4.ts:939
barColornumber-js-api/src/interfaces/d4.ts:961
barCornerRadiusnumber-js-api/src/interfaces/d4.ts:943
barSortOrderstringWhether the bars should be sorted in ascending or descending order. See also Bar Sort Type.js-api/src/interfaces/d4.ts:875
barSortTypestringWhether to sort bars by category or by value. See also Bar Sort Orderjs-api/src/interfaces/d4.ts:871
categoryColornumber-js-api/src/interfaces/d4.ts:963
categoryValueWidthnumber-js-api/src/interfaces/d4.ts:931
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:891
colorAggrTypestringColor aggregation type.js-api/src/interfaces/d4.ts:895
colorColumnNamestring-js-api/src/interfaces/d4.ts:892
controlsFontstringViewer controls elements font.js-api/src/interfaces/d4.ts:1002
descriptionstringViewer description that gets shown at the Descriptor Position. Markup is supported.js-api/src/interfaces/d4.ts:1018
descriptionPosition"Left" | "Right" | "Top" | "Bottom"-js-api/src/interfaces/d4.ts:1030
descriptionVisibilityMode"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:1032
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:999
fontstring-js-api/src/interfaces/d4.ts:947
formulaFontstring-js-api/src/interfaces/d4.ts:1054
formulaLinesstring-js-api/src/interfaces/d4.ts:1042
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:1022
includeNullsbooleanIndicates whether the "no data" bar should appear when the Split value is not present.js-api/src/interfaces/d4.ts:867
initializationFunctionstringNamespace-qualified function that gets executed when a viewer is initializedjs-api/src/interfaces/d4.ts:1025
invertColorSchemeboolean-js-api/src/interfaces/d4.ts:897
legendPosition"Auto" | "Left" | "Right" | "Top" | "Bottom" | "RightTop" | "RightBottom" | "LeftTop" | "LeftBottom"-js-api/src/interfaces/d4.ts:992
legendVisibility"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:990
linearColorSchemenumber[]-js-api/src/interfaces/d4.ts:899
maxBarHeightnumber-js-api/src/interfaces/d4.ts:941
maxCategoryWidthnumber-js-api/src/interfaces/d4.ts:929
minTextHeightnumber-js-api/src/interfaces/d4.ts:951
onClick"Select" | "None" | "Filter"Determines what happens when you click on a bar.js-api/src/interfaces/d4.ts:839
onInitializedScriptstringJavaScript that gets executed after a viewer is initialized and added to the TableViewjs-api/src/interfaces/d4.ts:1028
orientationstring-js-api/src/interfaces/d4.ts:887
outerMarginBottomnumber-js-api/src/interfaces/d4.ts:979
outerMarginLeftnumber-js-api/src/interfaces/d4.ts:973
outerMarginRightnumber-js-api/src/interfaces/d4.ts:975
outerMarginTopnumber-js-api/src/interfaces/d4.ts:977
relativeValuesbooleanWhen true, each outermost bar is of the same width. This mode is useful for comparing relative value frequency when the Stack column is specified.js-api/src/interfaces/d4.ts:863
rowSource"All" | "Filtered" | "Selected" | "SelectedOrCurrent" | "FilteredSelected" | "MouseOverGroup" | "CurrentRow" | "MouseOverRow"Determines the rows shown on the scatter plot.js-api/src/interfaces/d4.ts:836
showAllCatsboolean-js-api/src/interfaces/d4.ts:981
showCategorySelectorboolean-js-api/src/interfaces/d4.ts:852
showCategoryValuesboolean-js-api/src/interfaces/d4.ts:848
showCategoryZeroBaselineboolean-js-api/src/interfaces/d4.ts:935
showClippedBarIndicatorsbooleanWhen enabled, shows hatched areas and arrows on bars that are clipped by the value axis range.js-api/src/interfaces/d4.ts:955
showContextMenubooleanProperties common for all viewers todo: use code generationjs-api/src/interfaces/d4.ts:1008
showDataframeAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:1038
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.
showEmptyBarsbooleanIndicates whether categories with no matching rows should appear as zero-height bars.js-api/src/interfaces/d4.ts:986
showFilteredRowsbooleanShow which part is filtered Only works with RowSource = Alljs-api/src/interfaces/d4.ts:923
showLabelsstring-js-api/src/interfaces/d4.ts:988
showMouseOverRectboolean-js-api/src/interfaces/d4.ts:919
showMouseOverRowsboolean-js-api/src/interfaces/d4.ts:925
showSelectedRowsbooleanWhether the selected rows are indicated. Only works for cumulative aggregations such as count.js-api/src/interfaces/d4.ts:917
showStackPercentagebooleanShows the share of each stack segment in its bar, in percent, when the segment fits the label.js-api/src/interfaces/d4.ts:913
showStackSelectorboolean-js-api/src/interfaces/d4.ts:910
showTitleboolean-js-api/src/interfaces/d4.ts:1012
showValueAxisboolean-js-api/src/interfaces/d4.ts:883
showValueAxisLineboolean-js-api/src/interfaces/d4.ts:933
showValueSelectorboolean-js-api/src/interfaces/d4.ts:885
showValuesInsteadOfCategoriesboolean-js-api/src/interfaces/d4.ts:850
showViewerAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:1036
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.
splitstringA categorical column to split data on (each bar represents a category)js-api/src/interfaces/d4.ts:842
splitColumnNamestring-js-api/src/interfaces/d4.ts:843
splitMapstringTime unit map function for Split (applicable to dates only).js-api/src/interfaces/d4.ts:846
stackstringA categorical column to further split data on. Each category would become a part of the bar resulting from Split. Shows stacked bars only when Value Aggr Type is additive.js-api/src/interfaces/d4.ts:904
stackColumnNamestring-js-api/src/interfaces/d4.ts:905
stackMapstringTime unit map function for Stack (applicable to dates only).js-api/src/interfaces/d4.ts:908
tablestring-js-api/src/interfaces/d4.ts:1014
titlestring-js-api/src/interfaces/d4.ts:1010
useSplitColorsboolean-js-api/src/interfaces/d4.ts:983
valuestringValue column. See Value Aggr Type for aggregation options.js-api/src/interfaces/d4.ts:855
valueAggrTypestringValue aggregation.js-api/src/interfaces/d4.ts:859
valueColumnNamestring-js-api/src/interfaces/d4.ts:856
valueMaxnumber-js-api/src/interfaces/d4.ts:881
valueMinnumber-js-api/src/interfaces/d4.ts:879
valueTextColornumber-js-api/src/interfaces/d4.ts:965
verticalAlign"Top" | "Bottom" | "Center"-js-api/src/interfaces/d4.ts:945