Skip to main content

IBarChartSettings

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

Properties

PropertyTypeDescriptionDefined in
allowDynamicMenusboolean-js-api/src/interfaces/d4.ts:171
annotationFontstring-js-api/src/interfaces/d4.ts:207
annotationRegionsstring-js-api/src/interfaces/d4.ts:201
autoLayoutboolean-js-api/src/interfaces/d4.ts:94
axisColornumber-js-api/src/interfaces/d4.ts:126
axisFontstring-js-api/src/interfaces/d4.ts:116
axisType"linear" | "logarithmic"-js-api/src/interfaces/d4.ts:47
backColornumber-js-api/src/interfaces/d4.ts:124
barBorderLineColornumber-js-api/src/interfaces/d4.ts:138
barBorderLineFilteredColornumber-js-api/src/interfaces/d4.ts:136
barBorderLineMouseOverColornumber-js-api/src/interfaces/d4.ts:134
barBorderLineMouseOverWidthnumber-js-api/src/interfaces/d4.ts:104
barBorderLineWidthnumber-js-api/src/interfaces/d4.ts:106
barColornumber-js-api/src/interfaces/d4.ts:128
barCornerRadiusnumber-js-api/src/interfaces/d4.ts:110
barSortOrderstringWhether the bars should be sorted in ascending or descending order. See also Bar Sort Type.js-api/src/interfaces/d4.ts:45
barSortTypestringWhether to sort bars by category or by value. See also Bar Sort Orderjs-api/src/interfaces/d4.ts:41
categoryColornumber-js-api/src/interfaces/d4.ts:130
categoryValueWidthnumber-js-api/src/interfaces/d4.ts:98
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:61
colorAggrTypestringColor aggregation type.js-api/src/interfaces/d4.ts:65
colorColumnNamestring-js-api/src/interfaces/d4.ts:62
controlsFontstringViewer controls elements font.js-api/src/interfaces/d4.ts:169
descriptionstringViewer description that gets shown at the Descriptor Position. Markup is supported.js-api/src/interfaces/d4.ts:185
descriptionPosition"Top" | "Bottom" | "Left" | "Right"-js-api/src/interfaces/d4.ts:197
descriptionVisibilityMode"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:199
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:166
fontstring-js-api/src/interfaces/d4.ts:114
formulaFontstring-js-api/src/interfaces/d4.ts:221
formulaLinesstring-js-api/src/interfaces/d4.ts:209
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:189
includeNullsbooleanIndicates whether the "no data" bar should appear when the Split value is not present.js-api/src/interfaces/d4.ts:37
initializationFunctionstringNamespace-qualified function that gets executed when a viewer is initializedjs-api/src/interfaces/d4.ts:192
invertColorSchemeboolean-js-api/src/interfaces/d4.ts:67
legendPosition"Top" | "Bottom" | "Auto" | "Left" | "Right" | "RightTop" | "RightBottom" | "LeftTop" | "LeftBottom"-js-api/src/interfaces/d4.ts:159
legendVisibility"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:157
linearColorSchemenumber[]-js-api/src/interfaces/d4.ts:69
maxBarHeightnumber-js-api/src/interfaces/d4.ts:108
maxCategoryWidthnumber-js-api/src/interfaces/d4.ts:96
minTextHeightnumber-js-api/src/interfaces/d4.ts:118
onClick"Select" | "Filter" | "None"Determines what happens when you click on a bar.js-api/src/interfaces/d4.ts:9
onInitializedScriptstringJavaScript that gets executed after a viewer is initialized and added to the TableViewjs-api/src/interfaces/d4.ts:195
orientationstring-js-api/src/interfaces/d4.ts:57
outerMarginBottomnumber-js-api/src/interfaces/d4.ts:146
outerMarginLeftnumber-js-api/src/interfaces/d4.ts:140
outerMarginRightnumber-js-api/src/interfaces/d4.ts:142
outerMarginTopnumber-js-api/src/interfaces/d4.ts:144
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:33
rowSource"All" | "Filtered" | "Selected" | "SelectedOrCurrent" | "FilteredSelected" | "MouseOverGroup" | "CurrentRow" | "MouseOverRow"Determines the rows shown on the scatter plot.js-api/src/interfaces/d4.ts:6
showAllCatsboolean-js-api/src/interfaces/d4.ts:148
showCategorySelectorboolean-js-api/src/interfaces/d4.ts:22
showCategoryValuesboolean-js-api/src/interfaces/d4.ts:18
showCategoryZeroBaselineboolean-js-api/src/interfaces/d4.ts:102
showClippedBarIndicatorsbooleanWhen enabled, shows hatched areas and arrows on bars that are clipped by the value axis range.js-api/src/interfaces/d4.ts:122
showContextMenubooleanProperties common for all viewers todo: use code generationjs-api/src/interfaces/d4.ts:175
showDataframeAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:205
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:153
showFilteredRowsbooleanShow which part is filtered Only works with RowSource = Alljs-api/src/interfaces/d4.ts:90
showLabelsstring-js-api/src/interfaces/d4.ts:155
showMouseOverRectboolean-js-api/src/interfaces/d4.ts:86
showMouseOverRowsboolean-js-api/src/interfaces/d4.ts:92
showSelectedRowsbooleanWhether the selected rows are indicated. Only works for cumulative aggregations such as count.js-api/src/interfaces/d4.ts:84
showStackSelectorboolean-js-api/src/interfaces/d4.ts:80
showTitleboolean-js-api/src/interfaces/d4.ts:179
showValueAxisboolean-js-api/src/interfaces/d4.ts:53
showValueAxisLineboolean-js-api/src/interfaces/d4.ts:100
showValueSelectorboolean-js-api/src/interfaces/d4.ts:55
showValuesInsteadOfCategoriesboolean-js-api/src/interfaces/d4.ts:20
showViewerAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:203
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:12
splitColumnNamestring-js-api/src/interfaces/d4.ts:13
splitMapstringTime unit map function for Split (applicable to dates only).js-api/src/interfaces/d4.ts:16
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:74
stackColumnNamestring-js-api/src/interfaces/d4.ts:75
stackMapstringTime unit map function for Stack (applicable to dates only).js-api/src/interfaces/d4.ts:78
tablestring-js-api/src/interfaces/d4.ts:181
titlestring-js-api/src/interfaces/d4.ts:177
useSplitColorsboolean-js-api/src/interfaces/d4.ts:150
valuestringValue column. See Value Aggr Type for aggregation options.js-api/src/interfaces/d4.ts:25
valueAggrTypestringValue aggregation.js-api/src/interfaces/d4.ts:29
valueColumnNamestring-js-api/src/interfaces/d4.ts:26
valueMaxnumber-js-api/src/interfaces/d4.ts:51
valueMinnumber-js-api/src/interfaces/d4.ts:49
valueTextColornumber-js-api/src/interfaces/d4.ts:132
verticalAlign"Center" | "Top" | "Bottom"-js-api/src/interfaces/d4.ts:112