Skip to main content

IBarChartSettings

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

Properties​

PropertyTypeDescriptionDefined in
allowDynamicMenusboolean-js-api/src/interfaces/d4.ts:951
annotationFontstring-js-api/src/interfaces/d4.ts:986
annotationRegionsstring-js-api/src/interfaces/d4.ts:980
autoLayoutboolean-js-api/src/interfaces/d4.ts:874
axisColornumber-js-api/src/interfaces/d4.ts:906
axisFontstring-js-api/src/interfaces/d4.ts:896
axisType"linear" | "logarithmic"-js-api/src/interfaces/d4.ts:817
backColornumber-js-api/src/interfaces/d4.ts:904
barBorderLineColornumber-js-api/src/interfaces/d4.ts:918
barBorderLineFilteredColornumber-js-api/src/interfaces/d4.ts:916
barBorderLineMouseOverColornumber-js-api/src/interfaces/d4.ts:914
barBorderLineMouseOverWidthnumber-js-api/src/interfaces/d4.ts:884
barBorderLineWidthnumber-js-api/src/interfaces/d4.ts:886
barColornumber-js-api/src/interfaces/d4.ts:908
barCornerRadiusnumber-js-api/src/interfaces/d4.ts:890
barSortOrderstringWhether the bars should be sorted in ascending or descending order. See also Bar Sort Type.js-api/src/interfaces/d4.ts:811
barSortTypestringWhether to sort bars by category, by value, or in a custom order (see Category Order). See also Bar Sort Orderjs-api/src/interfaces/d4.ts:807
categoryColornumber-js-api/src/interfaces/d4.ts:910
categoryOrderstringHow the categories are ordered under the custom sort type: by name, row count, an aggregated value, or manually; by default, in the column's own order.js-api/src/interfaces/d4.ts:815
categoryValueWidthnumber-js-api/src/interfaces/d4.ts:878
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:831
colorAggrTypestringColor aggregation type.js-api/src/interfaces/d4.ts:835
colorColumnNamestring-js-api/src/interfaces/d4.ts:832
controlsFontstringViewer controls elements font.js-api/src/interfaces/d4.ts:949
descriptionstringViewer description that gets shown at the Descriptor Position. Markup is supported.js-api/src/interfaces/d4.ts:964
descriptionPosition"Left" | "Right" | "Top" | "Bottom"-js-api/src/interfaces/d4.ts:976
descriptionVisibilityMode"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:978
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:946
fontstring-js-api/src/interfaces/d4.ts:894
formulaFontstring-js-api/src/interfaces/d4.ts:1000
formulaLinesstring-js-api/src/interfaces/d4.ts:988
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:968
includeNullsbooleanIndicates whether the "no data" bar should appear when the Split value is not present.js-api/src/interfaces/d4.ts:803
initializationFunctionstringNamespace-qualified function that gets executed when a viewer is initializedjs-api/src/interfaces/d4.ts:971
invertColorSchemeboolean-js-api/src/interfaces/d4.ts:837
legendPosition"Left" | "Right" | "Top" | "Bottom" | "Auto" | "RightTop" | "RightBottom" | "LeftTop" | "LeftBottom"-js-api/src/interfaces/d4.ts:939
legendVisibility"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:937
linearColorSchemenumber[]-js-api/src/interfaces/d4.ts:839
maxBarHeightnumber-js-api/src/interfaces/d4.ts:888
maxCategoryWidthnumber-js-api/src/interfaces/d4.ts:876
minTextHeightnumber-js-api/src/interfaces/d4.ts:898
onClick"Select" | "Filter" | "None"Determines what happens when you click on a bar.js-api/src/interfaces/d4.ts:775
onInitializedScriptstringJavaScript that gets executed after a viewer is initialized and added to the TableViewjs-api/src/interfaces/d4.ts:974
orientationstring-js-api/src/interfaces/d4.ts:827
outerMarginBottomnumber-js-api/src/interfaces/d4.ts:926
outerMarginLeftnumber-js-api/src/interfaces/d4.ts:920
outerMarginRightnumber-js-api/src/interfaces/d4.ts:922
outerMarginTopnumber-js-api/src/interfaces/d4.ts:924
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:799
rowSource"All" | "Filtered" | "Selected" | "SelectedOrCurrent" | "FilteredSelected" | "MouseOverGroup" | "CurrentRow" | "MouseOverRow"Determines the rows shown on the scatter plot.js-api/src/interfaces/d4.ts:772
showAllCatsboolean-js-api/src/interfaces/d4.ts:928
showCategorySelectorboolean-js-api/src/interfaces/d4.ts:788
showCategoryValuesboolean-js-api/src/interfaces/d4.ts:784
showCategoryZeroBaselineboolean-js-api/src/interfaces/d4.ts:882
showClippedBarIndicatorsbooleanWhen enabled, shows hatched areas and arrows on bars that are clipped by the value axis range.js-api/src/interfaces/d4.ts:902
showContextMenubooleanWhether the context menu is shownjs-api/src/interfaces/d4.ts:954
showDataframeAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:984
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:933
showFilteredRowsbooleanShow which part is filtered Only works with RowSource = Alljs-api/src/interfaces/d4.ts:868
showLabelsstring-js-api/src/interfaces/d4.ts:935
showMouseOverRectboolean-js-api/src/interfaces/d4.ts:864
showMouseOverRowsboolean-js-api/src/interfaces/d4.ts:870
showSelectedRowsbooleanWhether the selected rows are indicated. Only works for cumulative aggregations such as count.js-api/src/interfaces/d4.ts:862
showStackSelectorboolean-js-api/src/interfaces/d4.ts:850
showStackValuestringShows, inside each stack segment that fits the label, its share of the bar in percent or its aggregated value. See Stack Value Format.js-api/src/interfaces/d4.ts:854
showTitleboolean-js-api/src/interfaces/d4.ts:958
showValueAxisboolean-js-api/src/interfaces/d4.ts:823
showValueAxisLineboolean-js-api/src/interfaces/d4.ts:880
showValueSelectorboolean-js-api/src/interfaces/d4.ts:825
showValuesInsteadOfCategoriesboolean-js-api/src/interfaces/d4.ts:786
showViewerAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:982
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:778
splitColumnNamestring-js-api/src/interfaces/d4.ts:779
splitMapstringTime unit map function for Split (applicable to dates only).js-api/src/interfaces/d4.ts:782
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:844
stackColumnNamestring-js-api/src/interfaces/d4.ts:845
stackMapstringTime unit map function for Stack (applicable to dates only).js-api/src/interfaces/d4.ts:848
stackValueFormatstringNumber format for the stack values. Auto keeps two significant digits, so large numbers read as whole (60%) and only small ones get the digits that tell them apart (0.00011%).js-api/src/interfaces/d4.ts:858
tablestring-js-api/src/interfaces/d4.ts:960
titlestring-js-api/src/interfaces/d4.ts:956
useSplitColorsboolean-js-api/src/interfaces/d4.ts:930
valuestringValue column. See Value Aggr Type for aggregation options.js-api/src/interfaces/d4.ts:791
valueAggrTypestringValue aggregation.js-api/src/interfaces/d4.ts:795
valueColumnNamestring-js-api/src/interfaces/d4.ts:792
valueMaxnumber-js-api/src/interfaces/d4.ts:821
valueMinnumber-js-api/src/interfaces/d4.ts:819
valueTextColornumber-js-api/src/interfaces/d4.ts:912
verticalAlign"Top" | "Bottom" | "Center"-js-api/src/interfaces/d4.ts:892
viewportstring-js-api/src/interfaces/d4.ts:872