Skip to main content

IScatterPlotSettings

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

Properties​

PropertyTypeDescriptionDefined in
allowDynamicMenusboolean-js-api/src/interfaces/d4.ts:2343
allowZoomboolean-js-api/src/interfaces/d4.ts:2254
annotationFontstring-js-api/src/interfaces/d4.ts:2431
annotationRegionsstring-js-api/src/interfaces/d4.ts:2425
autoAxisSizebooleanIf true, X Axis Height and Y Axis Width are calculated automatically to fit the required precision. If false, the specified X Axis Height and Y Axis Width properties are used.js-api/src/interfaces/d4.ts:2312
autoLayoutboolean-js-api/src/interfaces/d4.ts:2256
axesFollowFilterbooleanWhen true, scatter plot will zoom to an area defined by the range filters for X and Y columns, even if Zoom And Filter property is not set to "Zoom by Filter".js-api/src/interfaces/d4.ts:2025
axesUseColumnFormatbooleanDetermines whether the axes should follow the non-precision-related format (such as "money") set for the corresponding column.js-api/src/interfaces/d4.ts:2286
axisFontstring-js-api/src/interfaces/d4.ts:2320
axisLineColornumber-js-api/src/interfaces/d4.ts:2271
axisTextColornumber-js-api/src/interfaces/d4.ts:2273
backColornumber-js-api/src/interfaces/d4.ts:2258
categoricalColorSchemenumber[]Applies only to columns with 100+ categories; below that, the column's color coding is used.js-api/src/interfaces/d4.ts:2282
colorstringA column to be used for color-coding. Could be numerical or categorical. If not set, Filtered Rows Color is used for markers that pass the filter. Color palettes could defined either for columns in the column context panel, or via Linear Color Scheme and Categorical Color Scheme properties.js-api/src/interfaces/d4.ts:2122
colorAxisType"linear" | "logarithmic"-js-api/src/interfaces/d4.ts:2130
colorColumnNamestring-js-api/src/interfaces/d4.ts:2123
colorMapstringCategorical coloring time unit map function (applicable to dates only).js-api/src/interfaces/d4.ts:2126
colorMaxnumber-js-api/src/interfaces/d4.ts:2139
colorMinnumber-js-api/src/interfaces/d4.ts:2137
controlsFontstringViewer controls elements font.js-api/src/interfaces/d4.ts:2341
dataValuesstringControls whether columns on X and Y axes are displayed in tooltip Do not add: they are not shown Data values only: only they are shown Merge: standard behaviorjs-api/src/interfaces/d4.ts:2299
defaultRendererboolean-js-api/src/interfaces/d4.ts:2324
descriptionstringViewer description that gets shown at the Descriptor Position. Markup is supported.js-api/src/interfaces/d4.ts:2356
descriptionPosition"Left" | "Right" | "Top" | "Bottom"-js-api/src/interfaces/d4.ts:2368
descriptionVisibilityMode"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:2370
displayLabels"Auto" | "Always" | "Never"Determines how to show marker label: Always - show labels for all visible markers Auto - show labels only for markers where enough space is available Never - show no labels.js-api/src/interfaces/d4.ts:2195
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:2338
filteredOutRowsColornumber-js-api/src/interfaces/d4.ts:2263
filteredRowsColornumberIts alpha is the opacity of all markers colored by the Color column too; a missing value keeps the Missing Value Color alpha.js-api/src/interfaces/d4.ts:2261
filterOutInvalidbooleanInvalid are null values and not positive numbers if axis is logarithmic.js-api/src/interfaces/d4.ts:2018
formulaFontstring-js-api/src/interfaces/d4.ts:2445
formulaLinesstring-js-api/src/interfaces/d4.ts:2433
gridLineColornumber-js-api/src/interfaces/d4.ts:2275
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:2360
histogramBinsnumberNumber of bins for axis histogramsjs-api/src/interfaces/d4.ts:2086
initializationFunctionstringNamespace-qualified function that gets executed when a viewer is initializedjs-api/src/interfaces/d4.ts:2363
invertColorSchemebooleanReverses the viewer's color scheme and the column's linear color-coding. Does not apply to the column's conditional or categorical color-coding. Affects this viewer only: the grid and other viewers keep their colors.js-api/src/interfaces/d4.ts:2135
invertXAxisboolean-js-api/src/interfaces/d4.ts:2052
invertYAxisboolean-js-api/src/interfaces/d4.ts:2054
jitterSizenumberRandomly shift (x, y) marker position up to the Jitter Size pixels. Useful when multiple points fall on the same exact position. If Jitter Size Y is defined, then Jitter Size shifts x only.js-api/src/interfaces/d4.ts:2172
jitterSizeYnumberRandomly shift y marker position up to the Jitter Size Y pixels.js-api/src/interfaces/d4.ts:2175
labelAsMarkerSizenumberMarker size in which label is inscribed.js-api/src/interfaces/d4.ts:2207
labelColornumber-js-api/src/interfaces/d4.ts:2269
labelColorAsMarkerbooleanTo display labels separately or as markers (works for non-text labels).js-api/src/interfaces/d4.ts:2204
labelColumnNamesstring[]Label columns to show next to the markers.js-api/src/interfaces/d4.ts:2186
labelContentSizenumberLabel inner content size.js-api/src/interfaces/d4.ts:2210
labelFontstring-js-api/src/interfaces/d4.ts:2322
lassoToolbooleanWhen true, lasso area selector is used instead of the rectangular one. Toggle this option by pressing L.js-api/src/interfaces/d4.ts:2252
legendPosition"Left" | "Right" | "Top" | "Bottom" | "Auto" | "RightTop" | "RightBottom" | "LeftTop" | "LeftBottom"-js-api/src/interfaces/d4.ts:2328
legendVisibility"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:2326
linearColorSchemenumber[]-js-api/src/interfaces/d4.ts:2279
linesBystringWhen defined, lines are split into separate series by this categorical column instead of the color column.js-api/src/interfaces/d4.ts:2218
linesByColumnNamestring-js-api/src/interfaces/d4.ts:2219
linesOrderstringWhen defined, a line would be drawn for each series (defined by the categorical color column) using the order specified by "Lines Order"js-api/src/interfaces/d4.ts:2214
linesOrderColumnNamestring-js-api/src/interfaces/d4.ts:2215
linesWidthnumberDefines the width of the lines connecting the markers. See Lines Width.js-api/src/interfaces/d4.ts:2222
markerBorderWidthnumber-js-api/src/interfaces/d4.ts:2179
markerDefaultSizenumberBy default - automatic sizing based on current dataframejs-api/src/interfaces/d4.ts:2164
markerDrawBorderboolean-js-api/src/interfaces/d4.ts:2177
markerMaxSizenumber-js-api/src/interfaces/d4.ts:2183
markerMinSizenumber-js-api/src/interfaces/d4.ts:2181
markerOpacitynumberDeprecated Kept for plugins built before the color alpha: the alpha of the marker colors.js-api/src/interfaces/d4.ts:2167
markersstringA categorical column that determines the shape of the markers.js-api/src/interfaces/d4.ts:2155
markersColumnNamestring-js-api/src/interfaces/d4.ts:2156
markerSizeScaling"linear" | "logarithmic"Linear or logarithmic scale for the Size column.js-api/src/interfaces/d4.ts:2152
markersMapstringMarker category time unit map function (applicable to dates only).js-api/src/interfaces/d4.ts:2159
markerTypestring-js-api/src/interfaces/d4.ts:2161
missingValueColornumber-js-api/src/interfaces/d4.ts:2267
mouseDragstring-js-api/src/interfaces/d4.ts:2248
movingAverageLineColornumber-js-api/src/interfaces/d4.ts:2423
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:2421
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:2409
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:2415
onInitializedScriptstringJavaScript that gets executed after a viewer is initialized and added to the TableViewjs-api/src/interfaces/d4.ts:2366
regressionCommonSlopebooleanGives all category lines the same slope, with a confidence band. Fitted by ANCOVA. Needs numerical X and Y.js-api/src/interfaces/d4.ts:2399
regressionConfidenceLevelnumberConfidence level (%) of the band around each common-slope line.js-api/src/interfaces/d4.ts:2402
regressionLineColornumber-js-api/src/interfaces/d4.ts:2396
regressionPerCategorybooleanSplits the regression by category. Supports up to 20 categories; otherwise, a common regression line is shown.js-api/src/interfaces/d4.ts:2390
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:2394
resetSelectionOnBackgroundClickbooleanWhen true, clicking on the background (no point hit) clears the current selection. Set to false to preserve the selection when accidentally clicking outside of the markers.js-api/src/interfaces/d4.ts:2240
rowGroupTooltipstring-js-api/src/interfaces/d4.ts:2308
rowSource"All" | "Filtered" | "Selected" | "SelectedOrCurrent" | "FilteredSelected" | "MouseOverGroup" | "CurrentRow" | "MouseOverRow"Determines the rows shown on the plot.js-api/src/interfaces/d4.ts:2331
rowTooltipstringNewline-separated list of column names to be used in a tooltip. Requires showTooltip to be enabled.js-api/src/interfaces/d4.ts:2303
selectedRowsColornumber-js-api/src/interfaces/d4.ts:2265
showColorSelectorboolean-js-api/src/interfaces/d4.ts:2128
showContextMenubooleanWhether the context menu is shownjs-api/src/interfaces/d4.ts:2346
showCurrentPointbooleanControls the indication of the current rowjs-api/src/interfaces/d4.ts:2225
showDataframeAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:2429
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:2378
showDropLinesbooleanShows exact X and Y coordinates for the mouse cursor.js-api/src/interfaces/d4.ts:2246
showFilteredOutPointsbooleanWhen true, filtered out points are rendered using Filtered Out Rows Color.js-api/src/interfaces/d4.ts:2021
showHorizontalGridLinesboolean-js-api/src/interfaces/d4.ts:2066
showLabelNamedColumns"Auto" | "Always" | "Never"Determines whether to show column names next to label values.js-api/src/interfaces/d4.ts:2198
showLabels"Auto" | "Always" | "Never"-js-api/src/interfaces/d4.ts:2293
showLabelsFor"All" | "Filtered" | "Selected" | "SelectedOrCurrent" | "FilteredSelected" | "MouseOverGroup" | "CurrentRow" | "MouseOverRow"Determines the rows shown on the scatter plot.js-api/src/interfaces/d4.ts:2189
showMarkersWithEmptySizebooleanWhen a Size column is set, show rows with empty values instead of hiding them.js-api/src/interfaces/d4.ts:2149
showMeanAbsoluteErrorboolean-js-api/src/interfaces/d4.ts:2384
showMinMaxTickmarksbooleanShows tickmarks and labels for minimum and maximum value on each axis.js-api/src/interfaces/d4.ts:2243
showMouseOverPointbooleanControls the indication of the mouse-over rowjs-api/src/interfaces/d4.ts:2228
showMouseOverRowGroupbooleanHighlight 'mouse-over' rows (such as the ones that fall into a histogram bin that the mouse is currently hovering over).js-api/src/interfaces/d4.ts:2232
showMovingAverageDeviationbooleanShades a ±1 standard deviation band around the line.js-api/src/interfaces/d4.ts:2418
showMovingAverageLinebooleanMoving (rolling) average line visibility.js-api/src/interfaces/d4.ts:2405
showPearsonCorrelationboolean-js-api/src/interfaces/d4.ts:2382
showRegressionLinebooleanRegression line visibility (toggle by pressing R).js-api/src/interfaces/d4.ts:2373
showRegressionLineEquationboolean-js-api/src/interfaces/d4.ts:2375
showRootMeanSquareErrorboolean-js-api/src/interfaces/d4.ts:2386
showSelectedRowsbooleanWhen checked, selected markers are highlighted using the selected rows color. When unchecked, selected markers use their regular color coding.js-api/src/interfaces/d4.ts:2236
showSizeSelectorboolean-js-api/src/interfaces/d4.ts:2146
showSpearmanCorrelationboolean-js-api/src/interfaces/d4.ts:2380
showTitleboolean-js-api/src/interfaces/d4.ts:2350
showTooltipstringControls scatter plot tooltip visibilityjs-api/src/interfaces/d4.ts:2291
showVerticalGridLinesboolean-js-api/src/interfaces/d4.ts:2064
showViewerAnnotationRegionsboolean-js-api/src/interfaces/d4.ts:2427
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:2068
showXHistogrambooleanShows a distribution histogram along the X axis (at the top)js-api/src/interfaces/d4.ts:2083
showXSelectorboolean-js-api/src/interfaces/d4.ts:2072
showYAxisboolean-js-api/src/interfaces/d4.ts:2070
showYHistogrambooleanShows a distribution histogram along the Y axis (on the right)js-api/src/interfaces/d4.ts:2089
showYSelectorboolean-js-api/src/interfaces/d4.ts:2074
sizestringA numerical column to use for size-coding markers. See also Marker Min Size and Marker Max Size.js-api/src/interfaces/d4.ts:2143
sizeColumnNamestring-js-api/src/interfaces/d4.ts:2144
tablestring-js-api/src/interfaces/d4.ts:2352
titlestring-js-api/src/interfaces/d4.ts:2348
tooltipDelaynumberDelay in milliseconds before showing row tooltipjs-api/src/interfaces/d4.ts:2306
useLabelAsMarkerbooleanIf checked, display a label content as marker.js-api/src/interfaces/d4.ts:2201
viewportstring-js-api/src/interfaces/d4.ts:2288
whiskerColornumber-js-api/src/interfaces/d4.ts:2277
xstringA column to use on the X axis. Could be numerical or categorical.js-api/src/interfaces/d4.ts:2035
xAxisHeightnumberRequires Auto Axis Size to be turned off.js-api/src/interfaces/d4.ts:2315
xAxisLabelOrientationstring45 degrees* applies only to plain-text labels; molecules and other rendered labels are not rotated.js-api/src/interfaces/d4.ts:2116
xAxisType"linear" | "logarithmic"-js-api/src/interfaces/d4.ts:2048
xCategoryOrderstringHow the X axis categories are ordered: by name, row count, an aggregated value, or manually.js-api/src/interfaces/d4.ts:2077
xColumnNamestring-js-api/src/interfaces/d4.ts:2036
xMapstringTime unit map function for x column (applicable to dates only).js-api/src/interfaces/d4.ts:2039
xMaxnumber-js-api/src/interfaces/d4.ts:2060
xMinnumber-js-api/src/interfaces/d4.ts:2056
xWhiskerMaxstringPoint upper bound for x axis whiskers. Selecting it disables X Whisker Range.js-api/src/interfaces/d4.ts:2096
xWhiskerMaxColumnNamestring-js-api/src/interfaces/d4.ts:2097
xWhiskerMinstringPoint lower bound for x axis whiskers. Selecting it disables X Whisker Range.js-api/src/interfaces/d4.ts:2092
xWhiskerMinColumnNamestring-js-api/src/interfaces/d4.ts:2093
xWhiskerRangestringPoint range for x axis whiskers. Applied only if X Whisker Min and X Whisker Max are not set.js-api/src/interfaces/d4.ts:2100
xWhiskerRangeColumnNamestring-js-api/src/interfaces/d4.ts:2101
ystringA column to use on the Y axis. Could be numerical or categorical.js-api/src/interfaces/d4.ts:2042
yAxisType"linear" | "logarithmic"-js-api/src/interfaces/d4.ts:2050
yAxisWidthnumberRequires Auto Axis Size to be turned off.js-api/src/interfaces/d4.ts:2318
yCategoryOrderstringHow the Y axis categories are ordered: by name, row count, an aggregated value, or manually.js-api/src/interfaces/d4.ts:2080
yColumnNamestring-js-api/src/interfaces/d4.ts:2043
yMapstringTime unit map function for y column (applicable to dates only).js-api/src/interfaces/d4.ts:2046
yMaxnumber-js-api/src/interfaces/d4.ts:2062
yMinnumber-js-api/src/interfaces/d4.ts:2058
yWhiskerMaxstringPoint upper bound for y axis whiskers. Selecting it disables Y Whisker Range.js-api/src/interfaces/d4.ts:2108
yWhiskerMaxColumnNamestring-js-api/src/interfaces/d4.ts:2109
yWhiskerMinstringPoint lower bound for y axis whiskers. Selecting it disables Y Whisker Range.js-api/src/interfaces/d4.ts:2104
yWhiskerMinColumnNamestring-js-api/src/interfaces/d4.ts:2105
yWhiskerRangestringPoint range for y axis whiskers. Applied only if Y Whisker Min and Y Whisker Max are not set.js-api/src/interfaces/d4.ts:2112
yWhiskerRangeColumnNamestring-js-api/src/interfaces/d4.ts:2113
zoomAndFilterstringDetermines the relationship between table filter and scatter plot area: No action: they are disconnected Filter by zoom: scatter plot acts as a filter; as you zoom in, points get filtered out Zoom by filter: scatter plot focuses on the filtered points as the filter changes Pack and zoom by filter: removes filtered out categories and focuses on the filtered points as the filter changes.js-api/src/interfaces/d4.ts:2032