Skip to main content

ILineChartSettings

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

Properties

PropertyTypeDescriptionDefined in
addYColumnsToLegendbooleanWhen selected, column names are added to the legend. Requires Multi Axis to be enabled.js-api/src/interfaces/d4.ts:2007
aggrTypestring-js-api/src/interfaces/d4.ts:1982
aggTooltipColumnsstring-js-api/src/interfaces/d4.ts:2034
allowDynamicMenusboolean-js-api/src/interfaces/d4.ts:2053
annotationFontstring-js-api/src/interfaces/d4.ts:2141
annotationRegionsstring-js-api/src/interfaces/d4.ts:2135
autoAdjustMultiAxisLegendPositionboolean-js-api/src/interfaces/d4.ts:2009
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:1941
autoLayoutboolean-js-api/src/interfaces/d4.ts:1928
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:1744
axesUseColumnFormatbooleanUse column format for axis labels, where possiblejs-api/src/interfaces/d4.ts:1912
axisFontstring-js-api/src/interfaces/d4.ts:1956
axisLineColornumber-js-api/src/interfaces/d4.ts:1952
axisTextColornumber-js-api/src/interfaces/d4.ts:1954
backColornumber-js-api/src/interfaces/d4.ts:1950
categoryCustomColorIndicesnumber[]-js-api/src/interfaces/d4.ts:2016
categoryCustomColorsnumber[]-js-api/src/interfaces/d4.ts:2018
chartTypesstring[]-js-api/src/interfaces/d4.ts:1946
controlsFontstringViewer controls elements font.js-api/src/interfaces/d4.ts:2051
currentLineColornumber-js-api/src/interfaces/d4.ts:1962
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:2071
descriptionPosition"Top" | "Bottom" | "Left" | "Right"-js-api/src/interfaces/d4.ts:2087
descriptionVisibilityMode"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:2089
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:2048
formulaFontstring-js-api/src/interfaces/d4.ts:2155
formulaLinesstring-js-api/src/interfaces/d4.ts:2143
gridLineColornumber-js-api/src/interfaces/d4.ts:1964
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:2077
histogramWidthnumber-js-api/src/interfaces/d4.ts:1937
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:2081
innerChartMarginBottomnumber-js-api/src/interfaces/d4.ts:2022
innerChartMarginTopnumber-js-api/src/interfaces/d4.ts:2020
interpolation"None" | "Spline"-js-api/src/interfaces/d4.ts:1812
invertXAxisboolean-js-api/src/interfaces/d4.ts:1766
lassoToolbooleanEnables lasso region drawing mode (instead of polygon drawing default one).js-api/src/interfaces/d4.ts:2014
leftPanelstringShow additional chart on the leftjs-api/src/interfaces/d4.ts:1926
legendPosition"Top" | "Bottom" | "Auto" | "Left" | "Right" | "RightTop" | "RightBottom" | "LeftTop" | "LeftBottom"-js-api/src/interfaces/d4.ts:2038
legendVisibility"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:2036
lineColornumber-js-api/src/interfaces/d4.ts:1948
lineColoringTypestring-js-api/src/interfaces/d4.ts:1847
lineTransparencynumber-js-api/src/interfaces/d4.ts:1845
lineWidthnumber-js-api/src/interfaces/d4.ts:1843
lowerControlLimitnumber-js-api/src/interfaces/d4.ts:1863
markerColornumber-js-api/src/interfaces/d4.ts:1958
markerOpacitynumber-js-api/src/interfaces/d4.ts:1835
markersstringA categorical column that determines the shape of the markers.js-api/src/interfaces/d4.ts:1825
markersColumnNamestring-js-api/src/interfaces/d4.ts:1826
markerSizenumber-js-api/src/interfaces/d4.ts:1833
markerSizeScaling"linear" | "logarithmic"Linear or logarithmic scale for the marker Size column.js-api/src/interfaces/d4.ts:1822
markersMapstringMarker category time unit map function (applicable to dates only).js-api/src/interfaces/d4.ts:1829
markersSizestring-js-api/src/interfaces/d4.ts:1816
markersSizeAggrTypestring-js-api/src/interfaces/d4.ts:1819
markersSizeColumnNamestring-js-api/src/interfaces/d4.ts:1817
markersVisibilitystring-js-api/src/interfaces/d4.ts:1840
markersVisibilityColumnNamestring-js-api/src/interfaces/d4.ts:1841
markerTypestring-js-api/src/interfaces/d4.ts:1831
mouseOverLineColornumber-js-api/src/interfaces/d4.ts:1960
movingAverageLineColornumber-js-api/src/interfaces/d4.ts:2131
movingAverageLineTransparencynumber-js-api/src/interfaces/d4.ts:2133
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:2129
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:2117
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:2123
multiAxisbooleanWhen true, multiple Y Columns charts get rendered on top of each other, otherwise they are stackedjs-api/src/interfaces/d4.ts:1750
multiAxisLegendPosition"RightTop" | "RightBottom" | "LeftTop" | "LeftBottom" | "LeftCenter" | "CenterTop" | "CenterCenter" | "CenterBottom" | "RightCenter"-js-api/src/interfaces/d4.ts:2011
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:2085
outerChartMarginBottomnumber-js-api/src/interfaces/d4.ts:2030
outerChartMarginLeftnumber-js-api/src/interfaces/d4.ts:2024
outerChartMarginRightnumber-js-api/src/interfaces/d4.ts:2028
outerChartMarginTopnumber-js-api/src/interfaces/d4.ts:2026
overviewstringDefines a Y column for the chart on the bottom used for zoomingjs-api/src/interfaces/d4.ts:1736
overviewAggrTypestring-js-api/src/interfaces/d4.ts:1849
overviewColumnNamestring-js-api/src/interfaces/d4.ts:1737
overviewHeightnumberHeight of the overview chartjs-api/src/interfaces/d4.ts:1935
overviewTypestring-js-api/src/interfaces/d4.ts:1923
packCategoriesboolean-js-api/src/interfaces/d4.ts:1746
regressionLineColornumber-js-api/src/interfaces/d4.ts:2108
regressionLineTransparencynumber-js-api/src/interfaces/d4.ts:2110
regressionPerCategorybooleanSplits the regression by category. Supports up to 20 categories; otherwise, a common regression line is shown.js-api/src/interfaces/d4.ts:2106
rowGroupTooltipstring-js-api/src/interfaces/d4.ts:2003
rowSource"All" | "Filtered" | "Selected" | "SelectedOrCurrent" | "FilteredSelected" | "MouseOverGroup" | "CurrentRow" | "MouseOverRow"Determines the rows shown on the plot.js-api/src/interfaces/d4.ts:2041
rowTooltipstringNewline-separated list of column names to be used in a tooltip. Requires showTooltip to be enabled.js-api/src/interfaces/d4.ts:2001
segmentstringWhen defined, background is colored according to the segment column. Example: time series data with the "stimuli" columnjs-api/src/interfaces/d4.ts:1763
segmentColumnNamestring-js-api/src/interfaces/d4.ts:1764
segmentsFontstring-js-api/src/interfaces/d4.ts:1930
selectedRowsColornumber-js-api/src/interfaces/d4.ts:1966
showAggrSelectorsboolean-js-api/src/interfaces/d4.ts:1808
showAggrTypeSelectorboolean-js-api/src/interfaces/d4.ts:1914
showAverageboolean-js-api/src/interfaces/d4.ts:1861
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:1871
showCloseLinkbooleanShow the "x" close icon for each chartjs-api/src/interfaces/d4.ts:1988
showConsistentTrendbooleanRule 3: Six (or more) points in a row are continually increasing (or decreasing). When a "trend" exists.js-api/src/interfaces/d4.ts:1874
showContextMenubooleanProperties common for all viewers todo: use code generation Properties common for all viewers todo: use code generationjs-api/src/interfaces/d4.ts:2059
showControlLimitsbooleanShows/hides upper and lower control limits.js-api/src/interfaces/d4.ts:1855
showCurrentRowLinebooleanShow vertical line reflecting the position of the current row See also Current Line Colorjs-api/src/interfaces/d4.ts:1897
showDataframeAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:2139
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.
showHorizontalGridLinesboolean-js-api/src/interfaces/d4.ts:1796
showLabels"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:1997
showMarkers"Auto" | "Always" | "Never"A boolean column that determines whether to show markers.js-api/src/interfaces/d4.ts:1838
showMeanAbsoluteErrorboolean-js-api/src/interfaces/d4.ts:2100
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:1884
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:1901
showMouseOverRowGroupbooleanDetermines whether the points and lines are highlighted when you hover over a row group in another viewer.js-api/src/interfaces/d4.ts:1917
showMouseOverRowLinebooleanShow vertical line reflecting the position of the mouse-over row See also Mouse Over Line Colorjs-api/src/interfaces/d4.ts:1909
showMovingAverageDeviationbooleanShades a ±1 standard deviation band around the line.js-api/src/interfaces/d4.ts:2126
showMovingAverageLinebooleanMoving (rolling) average line visibility.js-api/src/interfaces/d4.ts:2113
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:1879
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:1868
showPearsonCorrelationboolean-js-api/src/interfaces/d4.ts:2098
showRegressionLinebooleanRegression line visibility (toggle by pressing R).js-api/src/interfaces/d4.ts:2092
showRegressionLineEquationboolean-js-api/src/interfaces/d4.ts:2094
showRootMeanSquareErrorboolean-js-api/src/interfaces/d4.ts:2102
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:1905
showSigma1boolean-js-api/src/interfaces/d4.ts:1857
showSigma2boolean-js-api/src/interfaces/d4.ts:1859
showSpearmanCorrelationboolean-js-api/src/interfaces/d4.ts:2096
showSplitSelectorboolean-js-api/src/interfaces/d4.ts:1810
showStatisticalProcessControlbooleanShows/hides upper and lower control limits, and Western Electric rules.js-api/src/interfaces/d4.ts:1852
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:1893
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:1889
showTitleboolean-js-api/src/interfaces/d4.ts:2063
showTooltipstringControls scatter plot tooltip visibilityjs-api/src/interfaces/d4.ts:1995
showTopPanelbooleanShows top panel with the "Split by" selectorjs-api/src/interfaces/d4.ts:1985
showVerticalGridLinesboolean-js-api/src/interfaces/d4.ts:1772
showViewerAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:2137
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:1768
showXSelectorboolean-js-api/src/interfaces/d4.ts:1770
showYAxisboolean-js-api/src/interfaces/d4.ts:1792
showYSelectorsboolean-js-api/src/interfaces/d4.ts:1806
splineTensionnumber-js-api/src/interfaces/d4.ts:1814
splitstringDeprecated, use splitColumnNames insteadjs-api/src/interfaces/d4.ts:1729
splitColumnNamestring-js-api/src/interfaces/d4.ts:1730
splitColumnNamesstring[]A categorical column by which lines are splitjs-api/src/interfaces/d4.ts:1733
statisticalProcessAreaColornumber-js-api/src/interfaces/d4.ts:1970
statisticalProcessLineColornumber-js-api/src/interfaces/d4.ts:1968
statisticalProcessRuleColornumber-js-api/src/interfaces/d4.ts:1972
tablestring-js-api/src/interfaces/d4.ts:2065
titlestring-js-api/src/interfaces/d4.ts:2061
upperControlLimitnumber-js-api/src/interfaces/d4.ts:1865
viewportstring-js-api/src/interfaces/d4.ts:2032
whiskersTypestringMarker type for showing the distribution of the aggregated values when multiple values have the same X valuejs-api/src/interfaces/d4.ts:1921
whiskerWidthnumber-js-api/src/interfaces/d4.ts:1932
xstringColumn to be used on the X axisjs-api/src/interfaces/d4.ts:1753
xAxisCustomTickmarksnumber[]-js-api/src/interfaces/d4.ts:1990
xAxisHeightnumberRequires Auto Axis Size to be turned off.js-api/src/interfaces/d4.ts:1944
xAxisLabelOrientationstring-js-api/src/interfaces/d4.ts:1774
xAxisMaxnumber-js-api/src/interfaces/d4.ts:1976
xAxisMinnumber-js-api/src/interfaces/d4.ts:1974
xAxisTickmarksMode"Auto" | "MinMax" | "Custom" | "AutoAndCustom"-js-api/src/interfaces/d4.ts:1776
xAxisType"linear" | "logarithmic"-js-api/src/interfaces/d4.ts:1759
xColumnNamestring-js-api/src/interfaces/d4.ts:1754
xMapstringTime unit map function for x column (applicable to dates only).js-api/src/interfaces/d4.ts:1757
xMaxnumber-js-api/src/interfaces/d4.ts:1780
xMinnumber-js-api/src/interfaces/d4.ts:1778
y2AxisTitlestringAxis title to be shown on the left axis in multi-axis modejs-api/src/interfaces/d4.ts:1802
yAggrTypesstring[]Aggregation types for all columnsjs-api/src/interfaces/d4.ts:1740
yAxisCustomTickmarksnumber[]-js-api/src/interfaces/d4.ts:1992
yAxisMaxnumber-js-api/src/interfaces/d4.ts:1980
yAxisMinnumber-js-api/src/interfaces/d4.ts:1978
yAxisTickmarksMode"Auto" | "MinMax" | "Custom" | "AutoAndCustom"-js-api/src/interfaces/d4.ts:1804
yAxisTitlestringAxis title to be shown on the left axis in multi-axis modejs-api/src/interfaces/d4.ts:1799
yAxisType"linear" | "logarithmic"-js-api/src/interfaces/d4.ts:1790
yColumnNamesstring[]Numerical columns to be used on Y axes. Depending on the *js-api/src/interfaces/d4.ts:1788
yGlobalScaleboolean-js-api/src/interfaces/d4.ts:1794
yMaxnumber-js-api/src/interfaces/d4.ts:1784
yMinnumber-js-api/src/interfaces/d4.ts:1782