Skip to main content

ILineChartSettings

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

Properties​

PropertyTypeDescriptionDefined in
addYColumnsToLegendbooleanWhen selected, column names are added to the legend. Requires Multi Axis to be enabled.js-api/src/interfaces/d4.ts:3170
aggrTypestring-js-api/src/interfaces/d4.ts:3145
aggTooltipColumnsstring-js-api/src/interfaces/d4.ts:3197
allowDynamicMenusboolean-js-api/src/interfaces/d4.ts:3216
annotationFontstring-js-api/src/interfaces/d4.ts:3298
annotationRegionsstring-js-api/src/interfaces/d4.ts:3292
autoAdjustMultiAxisLegendPositionboolean-js-api/src/interfaces/d4.ts:3172
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:3104
autoLayoutboolean-js-api/src/interfaces/d4.ts:3091
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:2908
axesUseColumnFormatbooleanUse column format for axis labels, where possiblejs-api/src/interfaces/d4.ts:3075
axisFontstring-js-api/src/interfaces/d4.ts:3119
axisLineColornumber-js-api/src/interfaces/d4.ts:3115
axisTextColornumber-js-api/src/interfaces/d4.ts:3117
backColornumber-js-api/src/interfaces/d4.ts:3113
categoryCustomColorIndicesnumber[]-js-api/src/interfaces/d4.ts:3179
categoryCustomColorsnumber[]-js-api/src/interfaces/d4.ts:3181
chartTypesstring[]-js-api/src/interfaces/d4.ts:3109
controlsFontstringViewer controls elements font.js-api/src/interfaces/d4.ts:3214
currentLineColornumber-js-api/src/interfaces/d4.ts:3125
descriptionstringViewer description that gets shown at the Descriptor Position. Markup is supported.js-api/src/interfaces/d4.ts:3229
descriptionPosition"Left" | "Right" | "Top" | "Bottom"-js-api/src/interfaces/d4.ts:3241
descriptionVisibilityMode"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:3243
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:3211
formulaFontstring-js-api/src/interfaces/d4.ts:3312
formulaLinesstring-js-api/src/interfaces/d4.ts:3300
gridLineColornumber-js-api/src/interfaces/d4.ts:3127
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:3233
histogramWidthnumber-js-api/src/interfaces/d4.ts:3100
initializationFunctionstringNamespace-qualified function that gets executed when a viewer is initializedjs-api/src/interfaces/d4.ts:3236
innerChartMarginBottomnumber-js-api/src/interfaces/d4.ts:3185
innerChartMarginTopnumber-js-api/src/interfaces/d4.ts:3183
interpolation"None" | "Spline"-js-api/src/interfaces/d4.ts:3008
invertXAxisboolean-js-api/src/interfaces/d4.ts:2933
lassoToolbooleanEnables lasso region drawing mode (instead of polygon drawing default one).js-api/src/interfaces/d4.ts:3177
leftPanelstringShow additional chart on the leftjs-api/src/interfaces/d4.ts:3089
legendPosition"Left" | "Right" | "Top" | "Bottom" | "Auto" | "RightTop" | "RightBottom" | "LeftTop" | "LeftBottom"-js-api/src/interfaces/d4.ts:3201
legendVisibility"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:3199
lineColornumber-js-api/src/interfaces/d4.ts:3111
lineColoringTypestring-js-api/src/interfaces/d4.ts:3006
lineWidthnumber-js-api/src/interfaces/d4.ts:3004
lowerControlLimitnumber-js-api/src/interfaces/d4.ts:3026
markerColornumber-js-api/src/interfaces/d4.ts:3121
markersstringA categorical column that determines the shape of the markers.js-api/src/interfaces/d4.ts:2988
markersColumnNamestring-js-api/src/interfaces/d4.ts:2989
markerSizenumber-js-api/src/interfaces/d4.ts:2996
markerSizeScaling"linear" | "logarithmic"Linear or logarithmic scale for the marker Size column.js-api/src/interfaces/d4.ts:2985
markersMapstringMarker category time unit map function (applicable to dates only).js-api/src/interfaces/d4.ts:2992
markersSizestring-js-api/src/interfaces/d4.ts:2979
markersSizeAggrTypestring-js-api/src/interfaces/d4.ts:2982
markersSizeColumnNamestring-js-api/src/interfaces/d4.ts:2980
markersVisibilitystring-js-api/src/interfaces/d4.ts:3001
markersVisibilityColumnNamestring-js-api/src/interfaces/d4.ts:3002
markerTypestring-js-api/src/interfaces/d4.ts:2994
mouseOverLineColornumber-js-api/src/interfaces/d4.ts:3123
movingAverageLineColornumber-js-api/src/interfaces/d4.ts:3290
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:3288
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:3276
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:3282
multiAxisbooleanWhen true, multiple Y Columns charts get rendered on top of each other, otherwise they are stackedjs-api/src/interfaces/d4.ts:2914
multiAxisLegendPosition"RightTop" | "RightBottom" | "LeftTop" | "LeftBottom" | "LeftCenter" | "CenterTop" | "CenterCenter" | "CenterBottom" | "RightCenter"-js-api/src/interfaces/d4.ts:3174
onInitializedScriptstringJavaScript that gets executed after a viewer is initialized and added to the TableViewjs-api/src/interfaces/d4.ts:3239
outerChartMarginBottomnumber-js-api/src/interfaces/d4.ts:3193
outerChartMarginLeftnumber-js-api/src/interfaces/d4.ts:3187
outerChartMarginRightnumber-js-api/src/interfaces/d4.ts:3191
outerChartMarginTopnumber-js-api/src/interfaces/d4.ts:3189
overviewstringDefines a Y column for the chart on the bottom used for zoomingjs-api/src/interfaces/d4.ts:2900
overviewAggrTypestring-js-api/src/interfaces/d4.ts:3012
overviewColumnNamestring-js-api/src/interfaces/d4.ts:2901
overviewHeightnumberHeight of the overview chartjs-api/src/interfaces/d4.ts:3098
overviewTypestring-js-api/src/interfaces/d4.ts:3086
packCategoriesboolean-js-api/src/interfaces/d4.ts:2910
regressionLineColornumber-js-api/src/interfaces/d4.ts:3269
regressionPerCategorybooleanSplits the regression by category. Supports up to 20 categories; otherwise, a common regression line is shown.js-api/src/interfaces/d4.ts:3263
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:3267
rowGroupTooltipstring-js-api/src/interfaces/d4.ts:3166
rowSource"All" | "Filtered" | "Selected" | "SelectedOrCurrent" | "FilteredSelected" | "MouseOverGroup" | "CurrentRow" | "MouseOverRow"Determines the rows shown on the plot.js-api/src/interfaces/d4.ts:3204
rowTooltipstringNewline-separated list of column names to be used in a tooltip. Requires showTooltip to be enabled.js-api/src/interfaces/d4.ts:3164
segmentstringWhen defined, background is colored according to the segment column. Example: time series data with the "stimuli" columnjs-api/src/interfaces/d4.ts:2927
segmentColumnNamestring-js-api/src/interfaces/d4.ts:2928
segmentsFontstring-js-api/src/interfaces/d4.ts:3093
selectedRowsColornumber-js-api/src/interfaces/d4.ts:3129
showAggrSelectorsboolean-js-api/src/interfaces/d4.ts:2975
showAggrTypeSelectorboolean-js-api/src/interfaces/d4.ts:3077
showAverageboolean-js-api/src/interfaces/d4.ts:3024
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:3034
showCloseLinkbooleanShow the "x" close icon for each chartjs-api/src/interfaces/d4.ts:3151
showConsistentTrendbooleanRule 3: Six (or more) points in a row are continually increasing (or decreasing). When a "trend" exists.js-api/src/interfaces/d4.ts:3037
showContextMenubooleanWhether the context menu is shownjs-api/src/interfaces/d4.ts:3219
showControlLimitsbooleanShows/hides upper and lower control limits.js-api/src/interfaces/d4.ts:3018
showCurrentRowLinebooleanShow vertical line reflecting the position of the current row See also Current Line Colorjs-api/src/interfaces/d4.ts:3060
showDataframeAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:3296
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:3251
showHorizontalGridLinesboolean-js-api/src/interfaces/d4.ts:2963
showLabels"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:3160
showMarkers"Auto" | "Always" | "Never"A boolean column that determines whether to show markers.js-api/src/interfaces/d4.ts:2999
showMeanAbsoluteErrorboolean-js-api/src/interfaces/d4.ts:3257
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:3047
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:3064
showMouseOverRowGroupbooleanDetermines whether the points and lines are highlighted when you hover over a row group in another viewer.js-api/src/interfaces/d4.ts:3080
showMouseOverRowLinebooleanShow vertical line reflecting the position of the mouse-over row See also Mouse Over Line Colorjs-api/src/interfaces/d4.ts:3072
showMovingAverageDeviationbooleanShades a ±1 standard deviation band around the line.js-api/src/interfaces/d4.ts:3285
showMovingAverageLinebooleanMoving (rolling) average line visibility.js-api/src/interfaces/d4.ts:3272
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:3042
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:3031
showPearsonCorrelationboolean-js-api/src/interfaces/d4.ts:3255
showRegressionLinebooleanRegression line visibility (toggle by pressing R).js-api/src/interfaces/d4.ts:3246
showRegressionLineEquationboolean-js-api/src/interfaces/d4.ts:3248
showRootMeanSquareErrorboolean-js-api/src/interfaces/d4.ts:3259
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:3068
showSigma1boolean-js-api/src/interfaces/d4.ts:3020
showSigma2boolean-js-api/src/interfaces/d4.ts:3022
showSpearmanCorrelationboolean-js-api/src/interfaces/d4.ts:3253
showSplitSelectorboolean-js-api/src/interfaces/d4.ts:2977
showStatisticalProcessControlbooleanShows/hides upper and lower control limits, and Western Electric rules.js-api/src/interfaces/d4.ts:3015
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:3056
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:3052
showTitleboolean-js-api/src/interfaces/d4.ts:3223
showTooltipstringControls scatter plot tooltip visibilityjs-api/src/interfaces/d4.ts:3158
showTopPanelbooleanShows top panel with the "Split by" selectorjs-api/src/interfaces/d4.ts:3148
showVerticalGridLinesboolean-js-api/src/interfaces/d4.ts:2939
showViewerAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:3294
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:2935
showXSelectorboolean-js-api/src/interfaces/d4.ts:2937
showYAxisboolean-js-api/src/interfaces/d4.ts:2959
showYSelectorsboolean-js-api/src/interfaces/d4.ts:2973
splineTensionnumber-js-api/src/interfaces/d4.ts:3010
splitstringDeprecated, use splitColumnNames insteadjs-api/src/interfaces/d4.ts:2893
splitColumnNamestring-js-api/src/interfaces/d4.ts:2894
splitColumnNamesstring[]A categorical column by which lines are splitjs-api/src/interfaces/d4.ts:2897
statisticalProcessAreaColornumber-js-api/src/interfaces/d4.ts:3133
statisticalProcessLineColornumber-js-api/src/interfaces/d4.ts:3131
statisticalProcessRuleColornumber-js-api/src/interfaces/d4.ts:3135
tablestring-js-api/src/interfaces/d4.ts:3225
titlestring-js-api/src/interfaces/d4.ts:3221
upperControlLimitnumber-js-api/src/interfaces/d4.ts:3028
viewportstring-js-api/src/interfaces/d4.ts:3195
whiskersTypestringMarker type for showing the distribution of the aggregated values when multiple values have the same X valuejs-api/src/interfaces/d4.ts:3084
whiskerWidthnumber-js-api/src/interfaces/d4.ts:3095
xstringColumn to be used on the X axisjs-api/src/interfaces/d4.ts:2917
xAxisCustomTickmarksnumber[]-js-api/src/interfaces/d4.ts:3153
xAxisHeightnumberRequires Auto Axis Size to be turned off.js-api/src/interfaces/d4.ts:3107
xAxisLabelOrientationstring-js-api/src/interfaces/d4.ts:2941
xAxisMaxnumber-js-api/src/interfaces/d4.ts:3139
xAxisMinnumber-js-api/src/interfaces/d4.ts:3137
xAxisTickmarksMode"Auto" | "MinMax" | "Custom" | "AutoAndCustom"-js-api/src/interfaces/d4.ts:2943
xAxisType"linear" | "logarithmic"-js-api/src/interfaces/d4.ts:2923
xCategoryOrderstringHow the X axis categories are ordered: by name, row count, an aggregated value, or manually.js-api/src/interfaces/d4.ts:2931
xColumnNamestring-js-api/src/interfaces/d4.ts:2918
xMapstringTime unit map function for x column (applicable to dates only).js-api/src/interfaces/d4.ts:2921
xMaxnumber-js-api/src/interfaces/d4.ts:2947
xMinnumber-js-api/src/interfaces/d4.ts:2945
y2AxisTitlestringAxis title to be shown on the left axis in multi-axis modejs-api/src/interfaces/d4.ts:2969
yAggrTypesstring[]Aggregation types for all columnsjs-api/src/interfaces/d4.ts:2904
yAxisCustomTickmarksnumber[]-js-api/src/interfaces/d4.ts:3155
yAxisMaxnumber-js-api/src/interfaces/d4.ts:3143
yAxisMinnumber-js-api/src/interfaces/d4.ts:3141
yAxisTickmarksMode"Auto" | "MinMax" | "Custom" | "AutoAndCustom"-js-api/src/interfaces/d4.ts:2971
yAxisTitlestringAxis title to be shown on the left axis in multi-axis modejs-api/src/interfaces/d4.ts:2966
yAxisType"linear" | "logarithmic"-js-api/src/interfaces/d4.ts:2957
yColumnNamesstring[]Numerical columns to be used on Y axes. Depending on the *js-api/src/interfaces/d4.ts:2955
yGlobalScaleboolean-js-api/src/interfaces/d4.ts:2961
yMaxnumber-js-api/src/interfaces/d4.ts:2951
yMinnumber-js-api/src/interfaces/d4.ts:2949