Skip to main content

ILineChartSettings

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

Properties​

PropertyTypeDescriptionDefined in
addYColumnsToLegendbooleanWhen selected, column names are added to the legend. Requires Multi Axis to be enabled.js-api/src/interfaces/d4.ts:2441
aggrTypestring-js-api/src/interfaces/d4.ts:2416
aggTooltipColumnsstring-js-api/src/interfaces/d4.ts:2468
allowDynamicMenusboolean-js-api/src/interfaces/d4.ts:2487
annotationFontstring-js-api/src/interfaces/d4.ts:2582
annotationRegionsstring-js-api/src/interfaces/d4.ts:2576
autoAdjustMultiAxisLegendPositionboolean-js-api/src/interfaces/d4.ts:2443
autoAxisSizebooleanIf true, X Axis Height is calculated automatically to fit the required precision. If false, the specified X Axis Heightjs-api/src/interfaces/d4.ts:2375
autoLayoutboolean-js-api/src/interfaces/d4.ts:2362
axesFollowFilterbooleanWhen true, X axis is synchronized with the corresponding filter's range values. Otherwise, when the filter is changed points are filtered out on a chart but the min-max stays.js-api/src/interfaces/d4.ts:2178
axesUseColumnFormatbooleanUse column format for axis labels, where possiblejs-api/src/interfaces/d4.ts:2346
axisFontstring-js-api/src/interfaces/d4.ts:2390
axisLineColornumber-js-api/src/interfaces/d4.ts:2386
axisTextColornumber-js-api/src/interfaces/d4.ts:2388
backColornumber-js-api/src/interfaces/d4.ts:2384
categoryCustomColorIndicesnumber[]-js-api/src/interfaces/d4.ts:2450
categoryCustomColorsnumber[]-js-api/src/interfaces/d4.ts:2452
chartTypesstring[]-js-api/src/interfaces/d4.ts:2380
controlsFontstringViewer controls elements font.js-api/src/interfaces/d4.ts:2485
currentLineColornumber-js-api/src/interfaces/d4.ts:2396
descriptionstringViewer description that gets shown at the Descriptor Position. Markup is supported. Viewer description that gets shown at the Descriptor Position. Markup is supported.js-api/src/interfaces/d4.ts:2505
descriptionPosition"Left" | "Right" | "Top" | "Bottom"-js-api/src/interfaces/d4.ts:2521
descriptionVisibilityMode"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:2523
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:2482
formulaFontstring-js-api/src/interfaces/d4.ts:2596
formulaLinesstring-js-api/src/interfaces/d4.ts:2584
gridLineColornumber-js-api/src/interfaces/d4.ts:2398
helpstringHelp to be shown when user clicks on the '?' icon on top. Could either be in markdown, or a URL (starting with '/' or 'http'). 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:2511
histogramWidthnumber-js-api/src/interfaces/d4.ts:2371
initializationFunctionstringNamespace-qualified function that gets executed when a viewer is initialized Namespace-qualified function that gets executed when a viewer is initializedjs-api/src/interfaces/d4.ts:2515
innerChartMarginBottomnumber-js-api/src/interfaces/d4.ts:2456
innerChartMarginTopnumber-js-api/src/interfaces/d4.ts:2454
interpolation"None" | "Spline"-js-api/src/interfaces/d4.ts:2279
invertXAxisboolean-js-api/src/interfaces/d4.ts:2200
lassoToolbooleanEnables lasso region drawing mode (instead of polygon drawing default one).js-api/src/interfaces/d4.ts:2448
leftPanelstringShow additional chart on the leftjs-api/src/interfaces/d4.ts:2360
legendPosition"Auto" | "Left" | "Right" | "Top" | "Bottom" | "RightTop" | "RightBottom" | "LeftTop" | "LeftBottom"-js-api/src/interfaces/d4.ts:2472
legendVisibility"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:2470
lineColornumber-js-api/src/interfaces/d4.ts:2382
lineColoringTypestring-js-api/src/interfaces/d4.ts:2277
lineTransparencynumber-js-api/src/interfaces/d4.ts:2275
lineWidthnumber-js-api/src/interfaces/d4.ts:2273
lowerControlLimitnumber-js-api/src/interfaces/d4.ts:2297
markerColornumber-js-api/src/interfaces/d4.ts:2392
markerOpacitynumber-js-api/src/interfaces/d4.ts:2265
markersstringA categorical column that determines the shape of the markers.js-api/src/interfaces/d4.ts:2255
markersColumnNamestring-js-api/src/interfaces/d4.ts:2256
markerSizenumber-js-api/src/interfaces/d4.ts:2263
markerSizeScaling"linear" | "logarithmic"Linear or logarithmic scale for the marker Size column.js-api/src/interfaces/d4.ts:2252
markersMapstringMarker category time unit map function (applicable to dates only).js-api/src/interfaces/d4.ts:2259
markersSizestring-js-api/src/interfaces/d4.ts:2246
markersSizeAggrTypestring-js-api/src/interfaces/d4.ts:2249
markersSizeColumnNamestring-js-api/src/interfaces/d4.ts:2247
markersVisibilitystring-js-api/src/interfaces/d4.ts:2270
markersVisibilityColumnNamestring-js-api/src/interfaces/d4.ts:2271
markerTypestring-js-api/src/interfaces/d4.ts:2261
mouseOverLineColornumber-js-api/src/interfaces/d4.ts:2394
movingAverageLineColornumber-js-api/src/interfaces/d4.ts:2572
movingAverageLineTransparencynumber-js-api/src/interfaces/d4.ts:2574
movingAveragePerCategorybooleanSplits the average by category (color column on the scatter plot, Split column on the line chart), up to 20.js-api/src/interfaces/d4.ts:2570
movingAverageWindownumberTrailing window size, interpreted per Moving Average Window Unit: a count of Points, an Absolute* width in X-axis units, or that many time periods (e.g. 30 Days, 3 Months).js-api/src/interfaces/d4.ts:2558
movingAverageWindowUnitstringWindow unit (Points, a row count, by default): Absolute — a width in X-axis units, for a numeric X axis. Days, Weeks, Months, Quarters, Years — a fixed time period, for a datetime X axis (falls back to Points when X is not datetime).js-api/src/interfaces/d4.ts:2564
multiAxisbooleanWhen true, multiple Y Columns charts get rendered on top of each other, otherwise they are stackedjs-api/src/interfaces/d4.ts:2184
multiAxisLegendPosition"RightTop" | "RightBottom" | "LeftTop" | "LeftBottom" | "LeftCenter" | "CenterTop" | "CenterCenter" | "CenterBottom" | "RightCenter"-js-api/src/interfaces/d4.ts:2445
onInitializedScriptstringJavaScript that gets executed after a viewer is initialized and added to the TableView JavaScript that gets executed after a viewer is initialized and added to the TableViewjs-api/src/interfaces/d4.ts:2519
outerChartMarginBottomnumber-js-api/src/interfaces/d4.ts:2464
outerChartMarginLeftnumber-js-api/src/interfaces/d4.ts:2458
outerChartMarginRightnumber-js-api/src/interfaces/d4.ts:2462
outerChartMarginTopnumber-js-api/src/interfaces/d4.ts:2460
overviewstringDefines a Y column for the chart on the bottom used for zoomingjs-api/src/interfaces/d4.ts:2170
overviewAggrTypestring-js-api/src/interfaces/d4.ts:2283
overviewColumnNamestring-js-api/src/interfaces/d4.ts:2171
overviewHeightnumberHeight of the overview chartjs-api/src/interfaces/d4.ts:2369
overviewTypestring-js-api/src/interfaces/d4.ts:2357
packCategoriesboolean-js-api/src/interfaces/d4.ts:2180
regressionLineColornumber-js-api/src/interfaces/d4.ts:2549
regressionLineTransparencynumber-js-api/src/interfaces/d4.ts:2551
regressionPerCategorybooleanSplits the regression by category. Supports up to 20 categories; otherwise, a common regression line is shown.js-api/src/interfaces/d4.ts:2543
regressionZeroInterceptbooleanForces the line through the origin (y = a·x). r² is then computed against the uncentered total sum of squares (Σy²) and is not comparable with the free-intercept r².js-api/src/interfaces/d4.ts:2547
rowGroupTooltipstring-js-api/src/interfaces/d4.ts:2437
rowSource"All" | "Filtered" | "Selected" | "SelectedOrCurrent" | "FilteredSelected" | "MouseOverGroup" | "CurrentRow" | "MouseOverRow"Determines the rows shown on the plot.js-api/src/interfaces/d4.ts:2475
rowTooltipstringNewline-separated list of column names to be used in a tooltip. Requires showTooltip to be enabled.js-api/src/interfaces/d4.ts:2435
segmentstringWhen defined, background is colored according to the segment column. Example: time series data with the "stimuli" columnjs-api/src/interfaces/d4.ts:2197
segmentColumnNamestring-js-api/src/interfaces/d4.ts:2198
segmentsFontstring-js-api/src/interfaces/d4.ts:2364
selectedRowsColornumber-js-api/src/interfaces/d4.ts:2400
showAggrSelectorsboolean-js-api/src/interfaces/d4.ts:2242
showAggrTypeSelectorboolean-js-api/src/interfaces/d4.ts:2348
showAverageboolean-js-api/src/interfaces/d4.ts:2295
showBiasbooleanRule 2: Nine (or more) points in a row are on the same side of the mean. Some prolonged "bias" exists.js-api/src/interfaces/d4.ts:2305
showCloseLinkbooleanShow the "x" close icon for each chartjs-api/src/interfaces/d4.ts:2422
showConsistentTrendbooleanRule 3: Six (or more) points in a row are continually increasing (or decreasing). When a "trend" exists.js-api/src/interfaces/d4.ts:2308
showContextMenubooleanProperties common for all viewers todo: use code generation Properties common for all viewers todo: use code generationjs-api/src/interfaces/d4.ts:2493
showControlLimitsbooleanShows/hides upper and lower control limits.js-api/src/interfaces/d4.ts:2289
showCurrentRowLinebooleanShow vertical line reflecting the position of the current row See also Current Line Colorjs-api/src/interfaces/d4.ts:2331
showDataframeAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:2580
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.
showDeterminationCoefficientbooleanCoefficient of determination (r²) of the fit.js-api/src/interfaces/d4.ts:2531
showHorizontalGridLinesboolean-js-api/src/interfaces/d4.ts:2230
showLabels"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:2431
showMarkers"Auto" | "Always" | "Never"A boolean column that determines whether to show markers.js-api/src/interfaces/d4.ts:2268
showMeanAbsoluteErrorboolean-js-api/src/interfaces/d4.ts:2537
showMediumShiftbooleanRule 5:Two (or three) out of the three points in a row are more than 2 standard deviations from the mean in the same direction. There is a medium tendency for samples to be mediumly out of control. The side of the mean for the third point is unspecified.js-api/src/interfaces/d4.ts:2318
showMouseOverCategorybooleanDetermines whether the line is highlighted when you hover over the corresponding category. Example: "Split by" = "SEX" and you hover over the "Male" category in the filter.js-api/src/interfaces/d4.ts:2335
showMouseOverRowGroupbooleanDetermines whether the points and lines are highlighted when you hover over a row group in another viewer.js-api/src/interfaces/d4.ts:2351
showMouseOverRowLinebooleanShow vertical line reflecting the position of the mouse-over row See also Mouse Over Line Colorjs-api/src/interfaces/d4.ts:2343
showMovingAverageDeviationbooleanShades a ±1 standard deviation band around the line.js-api/src/interfaces/d4.ts:2567
showMovingAverageLinebooleanMoving (rolling) average line visibility.js-api/src/interfaces/d4.ts:2554
showOscillationbooleanRule 4: Fourteen (or more) points in a row alternate in direction, increasing then decreasing. This much "oscillation" is beyond noise. Note that the rule is considered with directionality only. The position of the mean and the size of the standard deviation have no bearing.js-api/src/interfaces/d4.ts:2313
showOutlierbooleanRile 1: One point is more than 3 standard deviations from the mean. When sample(s) is grossly out of control.js-api/src/interfaces/d4.ts:2302
showPearsonCorrelationboolean-js-api/src/interfaces/d4.ts:2535
showRegressionLinebooleanRegression line visibility (toggle by pressing R).js-api/src/interfaces/d4.ts:2526
showRegressionLineEquationboolean-js-api/src/interfaces/d4.ts:2528
showRootMeanSquareErrorboolean-js-api/src/interfaces/d4.ts:2539
showSelectedRowsbooleanWhen checked, selected points and line segments are highlighted using the selected rows color. When unchecked, they keep their regular color coding.js-api/src/interfaces/d4.ts:2339
showSigma1boolean-js-api/src/interfaces/d4.ts:2291
showSigma2boolean-js-api/src/interfaces/d4.ts:2293
showSpearmanCorrelationboolean-js-api/src/interfaces/d4.ts:2533
showSplitSelectorboolean-js-api/src/interfaces/d4.ts:2244
showStatisticalProcessControlbooleanShows/hides upper and lower control limits, and Western Electric rules.js-api/src/interfaces/d4.ts:2286
showSuppressedVariationbooleanRule 7: Fifteen points in a row are all within 1 standard deviation of the mean on either side of the mean. With 1 standard deviation, greater variation would be expected.js-api/src/interfaces/d4.ts:2327
showSustainedShiftbooleanRule 6: Four (or five) out of five points in a row are more than 1 standard deviation from the mean in the same direction. There is strong tendency for samples to be slightly out of control. The side of the mean for the fifth point is unspecified.js-api/src/interfaces/d4.ts:2323
showTitleboolean-js-api/src/interfaces/d4.ts:2497
showTooltipstringControls scatter plot tooltip visibilityjs-api/src/interfaces/d4.ts:2429
showTopPanelbooleanShows top panel with the "Split by" selectorjs-api/src/interfaces/d4.ts:2419
showVerticalGridLinesboolean-js-api/src/interfaces/d4.ts:2206
showViewerAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:2578
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:2202
showXSelectorboolean-js-api/src/interfaces/d4.ts:2204
showYAxisboolean-js-api/src/interfaces/d4.ts:2226
showYSelectorsboolean-js-api/src/interfaces/d4.ts:2240
splineTensionnumber-js-api/src/interfaces/d4.ts:2281
splitstringDeprecated, use splitColumnNames insteadjs-api/src/interfaces/d4.ts:2163
splitColumnNamestring-js-api/src/interfaces/d4.ts:2164
splitColumnNamesstring[]A categorical column by which lines are splitjs-api/src/interfaces/d4.ts:2167
statisticalProcessAreaColornumber-js-api/src/interfaces/d4.ts:2404
statisticalProcessLineColornumber-js-api/src/interfaces/d4.ts:2402
statisticalProcessRuleColornumber-js-api/src/interfaces/d4.ts:2406
tablestring-js-api/src/interfaces/d4.ts:2499
titlestring-js-api/src/interfaces/d4.ts:2495
upperControlLimitnumber-js-api/src/interfaces/d4.ts:2299
viewportstring-js-api/src/interfaces/d4.ts:2466
whiskersTypestringMarker type for showing the distribution of the aggregated values when multiple values have the same X valuejs-api/src/interfaces/d4.ts:2355
whiskerWidthnumber-js-api/src/interfaces/d4.ts:2366
xstringColumn to be used on the X axisjs-api/src/interfaces/d4.ts:2187
xAxisCustomTickmarksnumber[]-js-api/src/interfaces/d4.ts:2424
xAxisHeightnumberRequires Auto Axis Size to be turned off.js-api/src/interfaces/d4.ts:2378
xAxisLabelOrientationstring-js-api/src/interfaces/d4.ts:2208
xAxisMaxnumber-js-api/src/interfaces/d4.ts:2410
xAxisMinnumber-js-api/src/interfaces/d4.ts:2408
xAxisTickmarksMode"Auto" | "MinMax" | "Custom" | "AutoAndCustom"-js-api/src/interfaces/d4.ts:2210
xAxisType"linear" | "logarithmic"-js-api/src/interfaces/d4.ts:2193
xColumnNamestring-js-api/src/interfaces/d4.ts:2188
xMapstringTime unit map function for x column (applicable to dates only).js-api/src/interfaces/d4.ts:2191
xMaxnumber-js-api/src/interfaces/d4.ts:2214
xMinnumber-js-api/src/interfaces/d4.ts:2212
y2AxisTitlestringAxis title to be shown on the left axis in multi-axis modejs-api/src/interfaces/d4.ts:2236
yAggrTypesstring[]Aggregation types for all columnsjs-api/src/interfaces/d4.ts:2174
yAxisCustomTickmarksnumber[]-js-api/src/interfaces/d4.ts:2426
yAxisMaxnumber-js-api/src/interfaces/d4.ts:2414
yAxisMinnumber-js-api/src/interfaces/d4.ts:2412
yAxisTickmarksMode"Auto" | "MinMax" | "Custom" | "AutoAndCustom"-js-api/src/interfaces/d4.ts:2238
yAxisTitlestringAxis title to be shown on the left axis in multi-axis modejs-api/src/interfaces/d4.ts:2233
yAxisType"linear" | "logarithmic"-js-api/src/interfaces/d4.ts:2224
yColumnNamesstring[]Numerical columns to be used on Y axes. Depending on the *js-api/src/interfaces/d4.ts:2222
yGlobalScaleboolean-js-api/src/interfaces/d4.ts:2228
yMaxnumber-js-api/src/interfaces/d4.ts:2218
yMinnumber-js-api/src/interfaces/d4.ts:2216