Skip to main content

ILineChartSettings

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

Properties​

PropertyTypeDescriptionDefined in
addYColumnsToLegendbooleanWhen selected, column names are added to the legend. Requires Multi Axis to be enabled.js-api/src/interfaces/d4.ts:2445
aggrTypestring-js-api/src/interfaces/d4.ts:2420
aggTooltipColumnsstring-js-api/src/interfaces/d4.ts:2472
allowDynamicMenusboolean-js-api/src/interfaces/d4.ts:2491
annotationFontstring-js-api/src/interfaces/d4.ts:2586
annotationRegionsstring-js-api/src/interfaces/d4.ts:2580
autoAdjustMultiAxisLegendPositionboolean-js-api/src/interfaces/d4.ts:2447
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:2379
autoLayoutboolean-js-api/src/interfaces/d4.ts:2366
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:2182
axesUseColumnFormatbooleanUse column format for axis labels, where possiblejs-api/src/interfaces/d4.ts:2350
axisFontstring-js-api/src/interfaces/d4.ts:2394
axisLineColornumber-js-api/src/interfaces/d4.ts:2390
axisTextColornumber-js-api/src/interfaces/d4.ts:2392
backColornumber-js-api/src/interfaces/d4.ts:2388
categoryCustomColorIndicesnumber[]-js-api/src/interfaces/d4.ts:2454
categoryCustomColorsnumber[]-js-api/src/interfaces/d4.ts:2456
chartTypesstring[]-js-api/src/interfaces/d4.ts:2384
controlsFontstringViewer controls elements font.js-api/src/interfaces/d4.ts:2489
currentLineColornumber-js-api/src/interfaces/d4.ts:2400
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:2509
descriptionPosition"Left" | "Right" | "Top" | "Bottom"-js-api/src/interfaces/d4.ts:2525
descriptionVisibilityMode"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:2527
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:2486
formulaFontstring-js-api/src/interfaces/d4.ts:2600
formulaLinesstring-js-api/src/interfaces/d4.ts:2588
gridLineColornumber-js-api/src/interfaces/d4.ts:2402
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:2515
histogramWidthnumber-js-api/src/interfaces/d4.ts:2375
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:2519
innerChartMarginBottomnumber-js-api/src/interfaces/d4.ts:2460
innerChartMarginTopnumber-js-api/src/interfaces/d4.ts:2458
interpolation"None" | "Spline"-js-api/src/interfaces/d4.ts:2283
invertXAxisboolean-js-api/src/interfaces/d4.ts:2204
lassoToolbooleanEnables lasso region drawing mode (instead of polygon drawing default one).js-api/src/interfaces/d4.ts:2452
leftPanelstringShow additional chart on the leftjs-api/src/interfaces/d4.ts:2364
legendPosition"Auto" | "Left" | "Right" | "Top" | "Bottom" | "RightTop" | "RightBottom" | "LeftTop" | "LeftBottom"-js-api/src/interfaces/d4.ts:2476
legendVisibility"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:2474
lineColornumber-js-api/src/interfaces/d4.ts:2386
lineColoringTypestring-js-api/src/interfaces/d4.ts:2281
lineTransparencynumber-js-api/src/interfaces/d4.ts:2279
lineWidthnumber-js-api/src/interfaces/d4.ts:2277
lowerControlLimitnumber-js-api/src/interfaces/d4.ts:2301
markerColornumber-js-api/src/interfaces/d4.ts:2396
markerOpacitynumber-js-api/src/interfaces/d4.ts:2269
markersstringA categorical column that determines the shape of the markers.js-api/src/interfaces/d4.ts:2259
markersColumnNamestring-js-api/src/interfaces/d4.ts:2260
markerSizenumber-js-api/src/interfaces/d4.ts:2267
markerSizeScaling"linear" | "logarithmic"Linear or logarithmic scale for the marker Size column.js-api/src/interfaces/d4.ts:2256
markersMapstringMarker category time unit map function (applicable to dates only).js-api/src/interfaces/d4.ts:2263
markersSizestring-js-api/src/interfaces/d4.ts:2250
markersSizeAggrTypestring-js-api/src/interfaces/d4.ts:2253
markersSizeColumnNamestring-js-api/src/interfaces/d4.ts:2251
markersVisibilitystring-js-api/src/interfaces/d4.ts:2274
markersVisibilityColumnNamestring-js-api/src/interfaces/d4.ts:2275
markerTypestring-js-api/src/interfaces/d4.ts:2265
mouseOverLineColornumber-js-api/src/interfaces/d4.ts:2398
movingAverageLineColornumber-js-api/src/interfaces/d4.ts:2576
movingAverageLineTransparencynumber-js-api/src/interfaces/d4.ts:2578
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:2574
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:2562
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:2568
multiAxisbooleanWhen true, multiple Y Columns charts get rendered on top of each other, otherwise they are stackedjs-api/src/interfaces/d4.ts:2188
multiAxisLegendPosition"RightTop" | "RightBottom" | "LeftTop" | "LeftBottom" | "LeftCenter" | "CenterTop" | "CenterCenter" | "CenterBottom" | "RightCenter"-js-api/src/interfaces/d4.ts:2449
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:2523
outerChartMarginBottomnumber-js-api/src/interfaces/d4.ts:2468
outerChartMarginLeftnumber-js-api/src/interfaces/d4.ts:2462
outerChartMarginRightnumber-js-api/src/interfaces/d4.ts:2466
outerChartMarginTopnumber-js-api/src/interfaces/d4.ts:2464
overviewstringDefines a Y column for the chart on the bottom used for zoomingjs-api/src/interfaces/d4.ts:2174
overviewAggrTypestring-js-api/src/interfaces/d4.ts:2287
overviewColumnNamestring-js-api/src/interfaces/d4.ts:2175
overviewHeightnumberHeight of the overview chartjs-api/src/interfaces/d4.ts:2373
overviewTypestring-js-api/src/interfaces/d4.ts:2361
packCategoriesboolean-js-api/src/interfaces/d4.ts:2184
regressionLineColornumber-js-api/src/interfaces/d4.ts:2553
regressionLineTransparencynumber-js-api/src/interfaces/d4.ts:2555
regressionPerCategorybooleanSplits the regression by category. Supports up to 20 categories; otherwise, a common regression line is shown.js-api/src/interfaces/d4.ts:2547
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:2551
rowGroupTooltipstring-js-api/src/interfaces/d4.ts:2441
rowSource"All" | "Filtered" | "Selected" | "SelectedOrCurrent" | "FilteredSelected" | "MouseOverGroup" | "CurrentRow" | "MouseOverRow"Determines the rows shown on the plot.js-api/src/interfaces/d4.ts:2479
rowTooltipstringNewline-separated list of column names to be used in a tooltip. Requires showTooltip to be enabled.js-api/src/interfaces/d4.ts:2439
segmentstringWhen defined, background is colored according to the segment column. Example: time series data with the "stimuli" columnjs-api/src/interfaces/d4.ts:2201
segmentColumnNamestring-js-api/src/interfaces/d4.ts:2202
segmentsFontstring-js-api/src/interfaces/d4.ts:2368
selectedRowsColornumber-js-api/src/interfaces/d4.ts:2404
showAggrSelectorsboolean-js-api/src/interfaces/d4.ts:2246
showAggrTypeSelectorboolean-js-api/src/interfaces/d4.ts:2352
showAverageboolean-js-api/src/interfaces/d4.ts:2299
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:2309
showCloseLinkbooleanShow the "x" close icon for each chartjs-api/src/interfaces/d4.ts:2426
showConsistentTrendbooleanRule 3: Six (or more) points in a row are continually increasing (or decreasing). When a "trend" exists.js-api/src/interfaces/d4.ts:2312
showContextMenubooleanProperties common for all viewers todo: use code generation Properties common for all viewers todo: use code generationjs-api/src/interfaces/d4.ts:2497
showControlLimitsbooleanShows/hides upper and lower control limits.js-api/src/interfaces/d4.ts:2293
showCurrentRowLinebooleanShow vertical line reflecting the position of the current row See also Current Line Colorjs-api/src/interfaces/d4.ts:2335
showDataframeAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:2584
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:2535
showHorizontalGridLinesboolean-js-api/src/interfaces/d4.ts:2234
showLabels"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:2435
showMarkers"Auto" | "Always" | "Never"A boolean column that determines whether to show markers.js-api/src/interfaces/d4.ts:2272
showMeanAbsoluteErrorboolean-js-api/src/interfaces/d4.ts:2541
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:2322
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:2339
showMouseOverRowGroupbooleanDetermines whether the points and lines are highlighted when you hover over a row group in another viewer.js-api/src/interfaces/d4.ts:2355
showMouseOverRowLinebooleanShow vertical line reflecting the position of the mouse-over row See also Mouse Over Line Colorjs-api/src/interfaces/d4.ts:2347
showMovingAverageDeviationbooleanShades a ±1 standard deviation band around the line.js-api/src/interfaces/d4.ts:2571
showMovingAverageLinebooleanMoving (rolling) average line visibility.js-api/src/interfaces/d4.ts:2558
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:2317
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:2306
showPearsonCorrelationboolean-js-api/src/interfaces/d4.ts:2539
showRegressionLinebooleanRegression line visibility (toggle by pressing R).js-api/src/interfaces/d4.ts:2530
showRegressionLineEquationboolean-js-api/src/interfaces/d4.ts:2532
showRootMeanSquareErrorboolean-js-api/src/interfaces/d4.ts:2543
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:2343
showSigma1boolean-js-api/src/interfaces/d4.ts:2295
showSigma2boolean-js-api/src/interfaces/d4.ts:2297
showSpearmanCorrelationboolean-js-api/src/interfaces/d4.ts:2537
showSplitSelectorboolean-js-api/src/interfaces/d4.ts:2248
showStatisticalProcessControlbooleanShows/hides upper and lower control limits, and Western Electric rules.js-api/src/interfaces/d4.ts:2290
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:2331
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:2327
showTitleboolean-js-api/src/interfaces/d4.ts:2501
showTooltipstringControls scatter plot tooltip visibilityjs-api/src/interfaces/d4.ts:2433
showTopPanelbooleanShows top panel with the "Split by" selectorjs-api/src/interfaces/d4.ts:2423
showVerticalGridLinesboolean-js-api/src/interfaces/d4.ts:2210
showViewerAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:2582
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:2206
showXSelectorboolean-js-api/src/interfaces/d4.ts:2208
showYAxisboolean-js-api/src/interfaces/d4.ts:2230
showYSelectorsboolean-js-api/src/interfaces/d4.ts:2244
splineTensionnumber-js-api/src/interfaces/d4.ts:2285
splitstringDeprecated, use splitColumnNames insteadjs-api/src/interfaces/d4.ts:2167
splitColumnNamestring-js-api/src/interfaces/d4.ts:2168
splitColumnNamesstring[]A categorical column by which lines are splitjs-api/src/interfaces/d4.ts:2171
statisticalProcessAreaColornumber-js-api/src/interfaces/d4.ts:2408
statisticalProcessLineColornumber-js-api/src/interfaces/d4.ts:2406
statisticalProcessRuleColornumber-js-api/src/interfaces/d4.ts:2410
tablestring-js-api/src/interfaces/d4.ts:2503
titlestring-js-api/src/interfaces/d4.ts:2499
upperControlLimitnumber-js-api/src/interfaces/d4.ts:2303
viewportstring-js-api/src/interfaces/d4.ts:2470
whiskersTypestringMarker type for showing the distribution of the aggregated values when multiple values have the same X valuejs-api/src/interfaces/d4.ts:2359
whiskerWidthnumber-js-api/src/interfaces/d4.ts:2370
xstringColumn to be used on the X axisjs-api/src/interfaces/d4.ts:2191
xAxisCustomTickmarksnumber[]-js-api/src/interfaces/d4.ts:2428
xAxisHeightnumberRequires Auto Axis Size to be turned off.js-api/src/interfaces/d4.ts:2382
xAxisLabelOrientationstring-js-api/src/interfaces/d4.ts:2212
xAxisMaxnumber-js-api/src/interfaces/d4.ts:2414
xAxisMinnumber-js-api/src/interfaces/d4.ts:2412
xAxisTickmarksMode"Auto" | "MinMax" | "Custom" | "AutoAndCustom"-js-api/src/interfaces/d4.ts:2214
xAxisType"linear" | "logarithmic"-js-api/src/interfaces/d4.ts:2197
xColumnNamestring-js-api/src/interfaces/d4.ts:2192
xMapstringTime unit map function for x column (applicable to dates only).js-api/src/interfaces/d4.ts:2195
xMaxnumber-js-api/src/interfaces/d4.ts:2218
xMinnumber-js-api/src/interfaces/d4.ts:2216
y2AxisTitlestringAxis title to be shown on the left axis in multi-axis modejs-api/src/interfaces/d4.ts:2240
yAggrTypesstring[]Aggregation types for all columnsjs-api/src/interfaces/d4.ts:2178
yAxisCustomTickmarksnumber[]-js-api/src/interfaces/d4.ts:2430
yAxisMaxnumber-js-api/src/interfaces/d4.ts:2418
yAxisMinnumber-js-api/src/interfaces/d4.ts:2416
yAxisTickmarksMode"Auto" | "MinMax" | "Custom" | "AutoAndCustom"-js-api/src/interfaces/d4.ts:2242
yAxisTitlestringAxis title to be shown on the left axis in multi-axis modejs-api/src/interfaces/d4.ts:2237
yAxisType"linear" | "logarithmic"-js-api/src/interfaces/d4.ts:2228
yColumnNamesstring[]Numerical columns to be used on Y axes. Depending on the *js-api/src/interfaces/d4.ts:2226
yGlobalScaleboolean-js-api/src/interfaces/d4.ts:2232
yMaxnumber-js-api/src/interfaces/d4.ts:2222
yMinnumber-js-api/src/interfaces/d4.ts:2220