IScatterPlotSettings
Defined in: js-api/src/interfaces/d4.ts:388
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
allowDynamicMenus | boolean | - | js-api/src/interfaces/d4.ts:706 |
allowZoom | boolean | - | js-api/src/interfaces/d4.ts:618 |
annotationFont | string | - | js-api/src/interfaces/d4.ts:799 |
annotationRegions | string | - | js-api/src/interfaces/d4.ts:793 |
autoAxisSize | boolean | If 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:675 |
autoLayout | boolean | - | js-api/src/interfaces/d4.ts:620 |
axesFollowFilter | boolean | When 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:397 |
axesUseColumnFormat | boolean | Determines whether the axes should follow the non-precision-related format (such as "money") set for the corresponding column. | js-api/src/interfaces/d4.ts:649 |
axisFont | string | - | js-api/src/interfaces/d4.ts:683 |
axisLineColor | number | - | js-api/src/interfaces/d4.ts:634 |
axisTextColor | number | - | js-api/src/interfaces/d4.ts:636 |
backColor | number | - | js-api/src/interfaces/d4.ts:622 |
categoricalColorScheme | number[] | Applies only to columns with 100+ categories; below that, the column's color coding is used. | js-api/src/interfaces/d4.ts:645 |
color | string | A 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:487 |
colorAxisType | "linear" | "logarithmic" | - | js-api/src/interfaces/d4.ts:495 |
colorColumnName | string | - | js-api/src/interfaces/d4.ts:488 |
colorMap | string | Categorical coloring time unit map function (applicable to dates only). | js-api/src/interfaces/d4.ts:491 |
colorMax | number | - | js-api/src/interfaces/d4.ts:504 |
colorMin | number | - | js-api/src/interfaces/d4.ts:502 |
controlsFont | string | Viewer controls elements font. | js-api/src/interfaces/d4.ts:704 |
dataValues | string | Controls 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 behavior | js-api/src/interfaces/d4.ts:662 |
defaultRenderer | boolean | - | js-api/src/interfaces/d4.ts:687 |
description | string | Viewer description that gets shown at the Descriptor Position. Markup is supported. | js-api/src/interfaces/d4.ts:720 |
descriptionPosition | "Left" | "Right" | "Top" | "Bottom" | - | js-api/src/interfaces/d4.ts:732 |
descriptionVisibilityMode | "Auto" | "Always" | "Never" | - | js-api/src/interfaces/d4.ts:734 |
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:559 |
filter | string | Formula that filters out rows to show. Examples: ${AGE} > 20 or ${WEIGHT / 2)} > 100, ${SEVERITY} == 'Medium', ${RACE}.endsWith('sian') | js-api/src/interfaces/d4.ts:701 |
filteredOutRowsColor | number | - | js-api/src/interfaces/d4.ts:626 |
filteredRowsColor | number | - | js-api/src/interfaces/d4.ts:624 |
filterOutInvalid | boolean | Invalid are null values and not positive numbers if axis is logarithmic. | js-api/src/interfaces/d4.ts:390 |
formulaFont | string | - | js-api/src/interfaces/d4.ts:813 |
formulaLines | string | - | js-api/src/interfaces/d4.ts:801 |
gridLineColor | number | - | js-api/src/interfaces/d4.ts:638 |
help | string | 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:724 |
histogramBins | number | Number of bins for axis histograms | js-api/src/interfaces/d4.ts:452 |
initializationFunction | string | Namespace-qualified function that gets executed when a viewer is initialized | js-api/src/interfaces/d4.ts:727 |
invertColorScheme | boolean | Reverses 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:500 |
invertXAxis | boolean | - | js-api/src/interfaces/d4.ts:424 |
invertYAxis | boolean | - | js-api/src/interfaces/d4.ts:426 |
jitterSize | number | Randomly 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:536 |
jitterSizeY | number | Randomly shift y marker position up to the Jitter Size Y pixels. | js-api/src/interfaces/d4.ts:539 |
labelAsMarkerSize | number | Marker size in which label is inscribed. | js-api/src/interfaces/d4.ts:571 |
labelColor | number | - | js-api/src/interfaces/d4.ts:632 |
labelColorAsMarker | boolean | To display labels separately or as markers (works for non-text labels). | js-api/src/interfaces/d4.ts:568 |
labelColumnNames | string[] | Label columns to show next to the markers. | js-api/src/interfaces/d4.ts:550 |
labelContentSize | number | Label inner content size. | js-api/src/interfaces/d4.ts:574 |
labelFont | string | - | js-api/src/interfaces/d4.ts:685 |
lassoTool | boolean | When true, lasso area selector is used instead of the rectangular one. Toggle this option by pressing L. | js-api/src/interfaces/d4.ts:616 |
legendPosition | "Auto" | "Left" | "Right" | "Top" | "Bottom" | "RightTop" | "RightBottom" | "LeftTop" | "LeftBottom" | - | js-api/src/interfaces/d4.ts:691 |
legendVisibility | "Auto" | "Always" | "Never" | - | js-api/src/interfaces/d4.ts:689 |
linearColorScheme | number[] | - | js-api/src/interfaces/d4.ts:642 |
linesBy | string | When defined, lines are split into separate series by this categorical column instead of the color column. | js-api/src/interfaces/d4.ts:582 |
linesByColumnName | string | - | js-api/src/interfaces/d4.ts:583 |
linesOrder | string | When 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:578 |
linesOrderColumnName | string | - | js-api/src/interfaces/d4.ts:579 |
linesWidth | number | Defines the width of the lines connecting the markers. See Lines Width. | js-api/src/interfaces/d4.ts:586 |
markerBorderWidth | number | - | js-api/src/interfaces/d4.ts:543 |
markerDefaultSize | number | By default - automatic sizing based on current dataframe | js-api/src/interfaces/d4.ts:529 |
markerDrawBorder | boolean | - | js-api/src/interfaces/d4.ts:541 |
markerMaxSize | number | - | js-api/src/interfaces/d4.ts:547 |
markerMinSize | number | - | js-api/src/interfaces/d4.ts:545 |
markerOpacity | number | - | js-api/src/interfaces/d4.ts:531 |
markers | string | A categorical column that determines the shape of the markers. | js-api/src/interfaces/d4.ts:520 |
markersColumnName | string | - | js-api/src/interfaces/d4.ts:521 |
markerSizeScaling | "linear" | "logarithmic" | Linear or logarithmic scale for the Size column. | js-api/src/interfaces/d4.ts:517 |
markersMap | string | Marker category time unit map function (applicable to dates only). | js-api/src/interfaces/d4.ts:524 |
markerType | string | - | js-api/src/interfaces/d4.ts:526 |
missingValueColor | number | - | js-api/src/interfaces/d4.ts:630 |
mouseDrag | string | - | js-api/src/interfaces/d4.ts:612 |
movingAverageLineColor | number | - | js-api/src/interfaces/d4.ts:789 |
movingAverageLineTransparency | number | - | js-api/src/interfaces/d4.ts:791 |
movingAveragePerCategory | boolean | Splits 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:787 |
movingAverageWindow | number | Trailing 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:775 |
movingAverageWindowUnit | string | Window 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:781 |
onInitializedScript | string | JavaScript that gets executed after a viewer is initialized and added to the TableView | js-api/src/interfaces/d4.ts:730 |
regressionCommonSlope | boolean | Gives all category lines the same slope, with a confidence band. Fitted by ANCOVA. Needs numerical X and Y. | js-api/src/interfaces/d4.ts:765 |
regressionConfidenceLevel | number | Confidence level (%) of the band around each common-slope line. | js-api/src/interfaces/d4.ts:768 |
regressionLineColor | number | - | js-api/src/interfaces/d4.ts:760 |
regressionLineTransparency | number | - | js-api/src/interfaces/d4.ts:762 |
regressionPerCategory | boolean | Splits the regression by category. Supports up to 20 categories; otherwise, a common regression line is shown. | js-api/src/interfaces/d4.ts:754 |
regressionZeroIntercept | boolean | Forces 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:758 |
resetSelectionOnBackgroundClick | boolean | When 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:604 |
rowGroupTooltip | string | - | js-api/src/interfaces/d4.ts:671 |
rowSource | "All" | "Filtered" | "Selected" | "SelectedOrCurrent" | "FilteredSelected" | "MouseOverGroup" | "CurrentRow" | "MouseOverRow" | Determines the rows shown on the plot. | js-api/src/interfaces/d4.ts:694 |
rowTooltip | string | Newline-separated list of column names to be used in a tooltip. Requires showTooltip to be enabled. | js-api/src/interfaces/d4.ts:666 |
selectedRowsColor | number | - | js-api/src/interfaces/d4.ts:628 |
showColorSelector | boolean | - | js-api/src/interfaces/d4.ts:493 |
showContextMenu | boolean | Properties common for all viewers todo: use code generation | js-api/src/interfaces/d4.ts:710 |
showCurrentPoint | boolean | Controls the indication of the current row | js-api/src/interfaces/d4.ts:589 |
showDataframeAnnotationRegions | boolean | - | js-api/src/interfaces/d4.ts:797 |
showDataframeFormulaLines | boolean | Control the visibility of dataframe-originated formula lines. Edit formula lines by right-clicking and selecting "Tools | Formula Lines" from the popup menu. Requires the PowerPack plugin. |
showDeterminationCoefficient | boolean | Coefficient of determination (r²) of the fit. | js-api/src/interfaces/d4.ts:742 |
showDropLines | boolean | Shows exact X and Y coordinates for the mouse cursor. | js-api/src/interfaces/d4.ts:610 |
showFilteredOutPoints | boolean | When true, filtered out points are rendered using Filtered Out Rows Color. | js-api/src/interfaces/d4.ts:393 |
showHorizontalGridLines | boolean | - | js-api/src/interfaces/d4.ts:438 |
showLabelNamedColumns | "Auto" | "Always" | "Never" | Determines whether to show column names next to label values. | js-api/src/interfaces/d4.ts:562 |
showLabels | "Auto" | "Always" | "Never" | - | js-api/src/interfaces/d4.ts:656 |
showLabelsFor | "All" | "Filtered" | "Selected" | "SelectedOrCurrent" | "FilteredSelected" | "MouseOverGroup" | "CurrentRow" | "MouseOverRow" | Determines the rows shown on the scatter plot. | js-api/src/interfaces/d4.ts:553 |
showMarkersWithEmptySize | boolean | When a Size column is set, show rows with empty values instead of hiding them. | js-api/src/interfaces/d4.ts:514 |
showMeanAbsoluteError | boolean | - | js-api/src/interfaces/d4.ts:748 |
showMinMaxTickmarks | boolean | Shows tickmarks and labels for minimum and maximum value on each axis. | js-api/src/interfaces/d4.ts:607 |
showMouseOverPoint | boolean | Controls the indication of the mouse-over row | js-api/src/interfaces/d4.ts:592 |
showMouseOverRowGroup | boolean | Highlight '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:596 |
showMovingAverageDeviation | boolean | Shades a ±1 standard deviation band around the line. | js-api/src/interfaces/d4.ts:784 |
showMovingAverageLine | boolean | Moving (rolling) average line visibility. | js-api/src/interfaces/d4.ts:771 |
showPearsonCorrelation | boolean | - | js-api/src/interfaces/d4.ts:746 |
showRegressionLine | boolean | Regression line visibility (toggle by pressing R). | js-api/src/interfaces/d4.ts:737 |
showRegressionLineEquation | boolean | - | js-api/src/interfaces/d4.ts:739 |
showRootMeanSquareError | boolean | - | js-api/src/interfaces/d4.ts:750 |
showSelectedRows | boolean | When 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:600 |
showSizeSelector | boolean | - | js-api/src/interfaces/d4.ts:511 |
showSpearmanCorrelation | boolean | - | js-api/src/interfaces/d4.ts:744 |
showTitle | boolean | - | js-api/src/interfaces/d4.ts:714 |
showTooltip | string | Controls scatter plot tooltip visibility | js-api/src/interfaces/d4.ts:654 |
showVerticalGridLines | boolean | - | js-api/src/interfaces/d4.ts:436 |
showViewerAnnotationRegions | boolean | - | js-api/src/interfaces/d4.ts:795 |
showViewerFormulaLines | boolean | Control the visibility of viewer-level formula lines. Edit formula lines by right-clicking and selecting "Tools | Formula Lines" from the popup menu. Requires the PowerPack plugin. |
showXAxis | boolean | - | js-api/src/interfaces/d4.ts:440 |
showXHistogram | boolean | Shows a distribution histogram along the X axis (at the top) | js-api/src/interfaces/d4.ts:449 |
showXSelector | boolean | - | js-api/src/interfaces/d4.ts:444 |
showYAxis | boolean | - | js-api/src/interfaces/d4.ts:442 |
showYHistogram | boolean | Shows a distribution histogram along the Y axis (on the right) | js-api/src/interfaces/d4.ts:455 |
showYSelector | boolean | - | js-api/src/interfaces/d4.ts:446 |
size | string | A numerical column to use for size-coding markers. See also Marker Min Size and Marker Max Size. | js-api/src/interfaces/d4.ts:508 |
sizeColumnName | string | - | js-api/src/interfaces/d4.ts:509 |
table | string | - | js-api/src/interfaces/d4.ts:716 |
title | string | - | js-api/src/interfaces/d4.ts:712 |
tooltipDelay | number | Delay in milliseconds before showing row tooltip | js-api/src/interfaces/d4.ts:669 |
useLabelAsMarker | boolean | If checked, display a label content as marker. | js-api/src/interfaces/d4.ts:565 |
viewport | string | - | js-api/src/interfaces/d4.ts:651 |
whiskerColor | number | - | js-api/src/interfaces/d4.ts:640 |
x | string | A column to use on the X axis. Could be numerical or categorical. | js-api/src/interfaces/d4.ts:407 |
xAxisHeight | number | Requires Auto Axis Size to be turned off. | js-api/src/interfaces/d4.ts:678 |
xAxisLabelOrientation | string | - | js-api/src/interfaces/d4.ts:481 |
xAxisType | "linear" | "logarithmic" | - | js-api/src/interfaces/d4.ts:420 |
xColumnName | string | - | js-api/src/interfaces/d4.ts:408 |
xMap | string | Time unit map function for x column (applicable to dates only). | js-api/src/interfaces/d4.ts:411 |
xMax | number | - | js-api/src/interfaces/d4.ts:432 |
xMin | number | - | js-api/src/interfaces/d4.ts:428 |
xWhiskerMax | string | Point upper bound for x axis whiskers. Selecting it disables X Whisker Range. | js-api/src/interfaces/d4.ts:462 |
xWhiskerMaxColumnName | string | - | js-api/src/interfaces/d4.ts:463 |
xWhiskerMin | string | Point lower bound for x axis whiskers. Selecting it disables X Whisker Range. | js-api/src/interfaces/d4.ts:458 |
xWhiskerMinColumnName | string | - | js-api/src/interfaces/d4.ts:459 |
xWhiskerRange | string | Point range for x axis whiskers. Applied only if X Whisker Min and X Whisker Max are not set. | js-api/src/interfaces/d4.ts:466 |
xWhiskerRangeColumnName | string | - | js-api/src/interfaces/d4.ts:467 |
y | string | A column to use on the Y axis. Could be numerical or categorical. | js-api/src/interfaces/d4.ts:414 |
yAxisType | "linear" | "logarithmic" | - | js-api/src/interfaces/d4.ts:422 |
yAxisWidth | number | Requires Auto Axis Size to be turned off. | js-api/src/interfaces/d4.ts:681 |
yColumnName | string | - | js-api/src/interfaces/d4.ts:415 |
yMap | string | Time unit map function for y column (applicable to dates only). | js-api/src/interfaces/d4.ts:418 |
yMax | number | - | js-api/src/interfaces/d4.ts:434 |
yMin | number | - | js-api/src/interfaces/d4.ts:430 |
yWhiskerMax | string | Point upper bound for y axis whiskers. Selecting it disables Y Whisker Range. | js-api/src/interfaces/d4.ts:474 |
yWhiskerMaxColumnName | string | - | js-api/src/interfaces/d4.ts:475 |
yWhiskerMin | string | Point lower bound for y axis whiskers. Selecting it disables Y Whisker Range. | js-api/src/interfaces/d4.ts:470 |
yWhiskerMinColumnName | string | - | js-api/src/interfaces/d4.ts:471 |
yWhiskerRange | string | Point range for y axis whiskers. Applied only if Y Whisker Min and Y Whisker Max are not set. | js-api/src/interfaces/d4.ts:478 |
yWhiskerRangeColumnName | string | - | js-api/src/interfaces/d4.ts:479 |
zoomAndFilter | string | Determines 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:404 |