# scatterplot properties Information noteSTABLE. This API is reliable and breaking changes are unlikely. scatterplot() These are the properties used by Qlik Sense scatter plot charts. ## Version history Version history | Version state | Details | | --- | --- | | Introduced | 2.2 | ## Properties ### showTitles Type: Boolean Show title for the visualization. Default: true. ### showDetails Type: Boolean Sets if visualization details should be shown. Default: false ### title Type: String | qStringExpression Visualization title shown if "showTitles": true. ### subtitle Type: String | qStringExpression Visualization subtitle shown if "showTitles": true. ### footnote Type: String | qStringExpression Visualization footnote shown if "showTitles": true. ### disableNavMenu Type: Boolean Disables the hover menu in the visualization. Default: false ### showDisclaimer Type: Boolean Set to false to hide visualization disclaimers that appear at the bottom of the chart, such as limited data or the chart has negative values. Default: true ### qHyperCubeDef Type: Object The hypercube definition used by most visualizations. A subset of the properties available in the qHyperCubeDef is presented here. For complete documentation of all available properties, see [Engine API: HyperCubeDef](https://help.qlik.com/en-US/sense-developer/May2025/Subsystems/EngineJSONAPI/Content/models-hypercubedef.htm). Additional properties: #### qDimensions Type: Array Description: Extends NxDimension, see [Engine API: NxDimension](https://help.qlik.com/en-US/sense-developer/May2025/Subsystems/EngineJSONAPI/Content/models-nxdimension.htm). Additional properties: * **qDef** Type: Object Description: Extends NxInlineDimensionDef, see [Engine API: NxInlineDimensionDef](https://help.qlik.com/en-US/sense-developer/May2025/Subsystems/EngineJSONAPI/Content/models-nxinlinedimensiondef.htm). qDef properties | Name | Type | Description | | --- | --- | --- | | autoSort | Boolean | Set to automatically sort the dimension.

Default: true | | cId | String | ID used by the client. Must be unique within the current chart. | | othersLabel | StringExpressionContainer | String expression container. | * **qAttributeDimensions** Type: Array Description: Extends NxAttrDimDef, see [Engine API: NxAttrDimDef](https://help.qlik.com/en-US/sense-developer/May2025/Subsystems/EngineJSONAPI/Content/models-nxattrdimdef.htm). * id Type: String One of: * colorByAlternative: colors the chart using different dimensions. Can be used together with color.mode="byDimension" for attribute dimensions. * colorByExpression: used together with color.mode="byExpression". * **qAttributeExpressions** Type: Array Description: Extends NxAttrExprDef, see [Engine API: NxAttrExprDef](https://help.qlik.com/en-US/sense-developer/May2025/Subsystems/EngineJSONAPI/Content/models-nxattrexprdef.htm). * **id** Type: String Description: All qAttributeExpressions IDs are specifically for use with custom tooltips. * customTooltipExpression: An AttributeExpression with this ID sets the extra tooltip measure. * customTooltipTitle: An AttributeExpression with this ID sets the tooltip title. * customTooltipDescription: An AttributeExpression with this ID sets the tooltip description. * customTooltipImages: An AttributeExpression with this ID sets the tooltip image. #### qMeasures Type: Array Description: Extends NxMeasure, see [Engine API: NxMeasure](https://help.qlik.com/en-US/sense-developer/May2025/Subsystems/EngineJSONAPI/Content/models-nxmeasure.htm). Additional properties * **qDef** Type: Object Description: Extends NxInlineMeasureDef, see [Engine API: NxInlineMeasureDef](https://help.qlik.com/en-US/sense-developer/May2025/Subsystems/EngineJSONAPI/Content/models-nxinlinemeasuredef.htm). qDef Properties | Name | Type | Description | | --- | --- | --- | | autoSort | Boolean | Set to automatically sort the measure.

Default: true | | cId | String | ID used by the client. Must be unique within the current chart. | | numFormatFromTemplate | Boolean | When enabled, the number format to use can be selected from multiple predefined formats based on the desired type: number or date.

Default: true | | isCustomFormatted | Boolean | Set to true to toggle off the default client formatting. | | othersLabel | StringExpressionContainer | String expression container for labels. | * **qAttributeExpressions** Type: Array Extends NxAttrExprDef, see [Engine API: NxAttrExprDef](https://help.qlik.com/en-US/sense-developer/May2025/Subsystems/EngineJSONAPI/Content/models-nxattrexprdef.htm). id Type: String One of: * colorByAlternative: colors the chart using different dimensions. Can be used together with color.mode="byDimension" for attribute dimensions. * colorByExpression: used together with color.mode="byExpression". #### qLayoutExclude Type: Object #### customErrorMessage Type: Object Set to define custom error messages. * **calcCondition** Type: String Description: Deprecated. Use qCalcCondition.qMsg instead. Set to customize the calculation condition unfilled message. ### tooltip Type: Object Description: Custom tooltip settings. * auto Type: Boolean Description: Determines if the custom tooltip is displayed or not. If set to false, custom tooltip is displayed. Default: true * data * hideBasic Type: Boolean Description: Hides all the basic tooltip content except the dimension and the custom tooltip content. If set to true, basic tooltip content is hidden. Default: false * chart Type: Object Description: The chart objects are used to define the chart that is displayed by the custom tooltip. * object Type: MasterVisualizationChartObject Description: Contains the master visualizations available to add to the tooltip. * refId Type: String Description: Input field containing the qExtendsId of the visualization, where qExtendsId is the unique id of the master visualization. * style Type: MasterVisualizationChartStyle Description: Determines the styling available for the chart in the tooltip. * size Type: String Description: Size of the chart when it is displayed. One of: * small * medium * large The small, medium, and large settings yield fixed pixel sizes for the chart container. The chart is scaled to fit the tooltip. * imageComponents Type: Array Description: The imageComponents objects are used to define the images displayed by the custom tooltip. * type Type: String Description: Type of the image for the current selection. One of: * media library * url * size Type: String Description: Size of the image when it is displayed. One of: * small * medium * large * original The small, medium, and large settings yield fixed pixel sizes for the image container. Setting the value to original maintains the size unless it exceeds the limit of the tooltip max size. The image is scaled to fit the tooltip if it exceeds the limit. * ref Type: String, StringExpression, or MediaLibraryRef Description: The reference value of the image. * MediaLibraryRef Type: Object Description: Media Library Reference structure. * qStaticContentUrlDef Object Description: Media Library structure that is evaluated by the engine. * qUrl Type: String Description: Media library path for the image in the app. Used only when type is set to media library. ### refLine Type: Object Reference line settings for scatter charts. Can be set on X-axis and Y-axis separately. #### refLinesX Type: Array refLinesX properties | Name | Type | Description | | --- | --- | --- | | show | Boolean | Set to true to display this reference line.

Default: true | | label | String | Reference line label. | | color | Integer | Deprecated. Use paletteColor instead.

Color.

Default: 3 | | paletteColor | Object | Color information structure. Holds the actual color and index in palette.

| | refLineExpr | String | Reference line expression settings.

| #### refLinesY Type: Array refLinesY properties | Name | Type | Description | | --- | --- | --- | | show | Boolean | Set to true to display this reference line.

Default: true | | label | String | Reference line label. | | color | Integer | Deprecated. Use paletteColor instead.

Color.

Default: 3 | | paletteColor | Object | Color information structure. Holds the actual color and index in palette.

| | refLineExpr | String | Reference line expression settings.

| ### dataPoint Type: Object Data point settings for scatter plots. dataPoint object properties | Name | Type | Description | | --- | --- | --- | | bubbleSizes | Integer | Bubble size.

Min: 1, Max: 20, Default: 5 | | rangeBubbleSizes | Array | Bubble sizes. Represented as an array of two integers where the first index is the from-size, and the second is the to-size. From-size should always be smaller than the to-size. | ### labels Type: Object Label settings. Additional properties: #### mode Type: Integer Set to display labels. Can be one of: * 0: show labels * 1: auto * 2: hide labels Default: 1 ### gridLine Type: Object Grid line settings. gridLine properties | Name | Type | Description | | --- | --- | --- | | auto | Boolean | Set to use automatic grid line spacing.

Default: true | | spacing | Integer | Grid line spacing. Used only when "auto": false. One of:



Default: 2 | ### compressionResolution Type: Integer Scatter plot resolution settings for compressed data. Default: 5 ### color Type: Object Most color options for visualizations are set in the color object in the options. You activate custom coloring by setting "auto": false which turns off auto-coloring. If "auto": true, no other properties need to be defined in the color object. The following parameters can be set in the color object: #### auto Type: Boolean Set to use automatic coloring. When "auto": true, color settings are based on the visualization used and the number of dimensions and measures, that is, the settings are not fixed, but are dependent on the data input. Default: true #### mode Type: String Sets the coloring mode for the visualization when auto-coloring has been switched off ("auto": false). Can be one of: * primary: a single color (by default blue) is used for all items in the chart. In visualizations that do not benefit from multiple colors (bar charts with one dimension and scatter plots), single color is the default setting. * byDimension: coloring is based upon the amount of dimension values. Details are set in the byDimensionDef property. Information notebyDimension can only be used in conjunction with an attribute dimension on the dimension to color by, as shown in the example below. ``` { "qDef": { "qFieldDefs": [ "NetScoreName" ] }, "qAttributeDimensions": [ { "qDef": "NetScoreName", "id": "colorByAlternative", "label": "Year" } ] } ``` * byExpression: coloring is based on an expression, which in most cases is a color code. Details are set in the expressionIsColor, expressionLabel and colorExpression properties. * byMeasure: coloring is based on the measure value. Details are set in the byMeasureDef property. * byMultiple: can be used when more than one measure is used. By default, 12 colors are used for the dimensions. The colors are reused when there are more than 12 dimension values. #### useBaseColors Type: String Only applicable when "mode": "primary" or "mode": "byMultiple" has been defined. Use colors encoded in master items. Should only be defined when a master dimension or master measure used in the visualization has a color assigned to it. One of: * off * measure: use colors encoded in master measure. * dimension: use colors encoded in master dimension. Default: off #### singleColor Type: Integer Deprecated. Use paletteColor instead. Set to use single color. Default: 3 #### paletteColor Type: Object The paletteColor object is used to define the color when you color by single color ("mode": "primary"). It has the following properties: paletteColor properties | Name | Type | Description | | --- | --- | --- | | index | Integer | Index in the palette.

The default Qlik Sense color palette:



Default: 6 | | color | String | Color as HEX string.

Mandatory if "index": "-1". | #### persistent Type: Boolean Set to true to use persistent colors on data points between selection states. Only applicable when using one dimension and when "mode": "byDimension" or when "mode": "byMultiple". Default: false #### expressionIsColor Type: Boolean Set to true to define whether the result of the expression is a valid CSS3 color. Only applicable when "mode": "byExpression". Default: true #### expressionLabel Type: String Defines the label on tool tips when using a coloring expression. Only applicable when "mode": "byExpression" and only used if "expressionIsColor": false #### colorExpression Type: Value Expression Container Sets the color expression to be used when "mode": "byExpression" is defined. Supported formats: * RGB * ARGB * HSL Example: ``` "colorExpression": "=if(sum(Sales)
Default: true | | dock | String | Sets the legend position. Can be one of:



Default: auto | | showTitle | Boolean | Show the legend title.

Default: true | ### xAxis Type: Object X axis settings. xAxis properties | Name | Type | Description | | --- | --- | --- | | show | String | Set to display the labels and titles. Can be one of:



Default: all | | dock | String | Sets the axis docking position. Can be one of:



Default: near | | spacing | Number | Set the axis scale:

Default: 1 | | autoMinMax | Boolean | Set to use automatic min/max for measure color.

Default: true | | minMax | String | Set custom max/min. Can be one of:



Default: min | | min | ValueExpressionContainer | Set the min value for the range. | | max | ValueExpressionContainer | Set the max value for the range. | ### yAxis Type: Object Y axis settings. yAxis properties | Name | Type | Description | | --- | --- | --- | | show | String | Set to display the labels and titles. Can be one of:



Default: all | | dock | String | Sets the axis docking position. Can be one of:



Default: near | | spacing | Number | Set the axis scale:

Default: 1 | | autoMinMax | Boolean | Set to use automatic min/max for measure color.

Default: true | | minMax | String | Set custom max/min. Can be one of:



Default: min | | min | ValueExpressionContainer | Set the min value for the range. | | max | ValueExpressionContainer | Set the max value for the range. | ### navigation Type: Boolean Set to true to display navigation UI. ## Example using Visualization API Tip noteFor more examples of how to create scatter plots on the fly, see [Mashups: Creating scatter plots](https://help.qlik.com/en-US/sense-developer/May2025/Subsystems/Mashups/Content/Sense_Mashups/Create/Visualizations/Scatterplot/create-scatterplot.htm). In this example we create a basic scatter plot, containing one dimension and two measures. The measures have basic number formatting applied and a title is added to the scatter plot. ``` app.visualization.create( 'scatterplot', [ { "qDef": { "qFieldDefs": [ "=[Date.autoCalendar.YearQuarter]" ], "qFieldLabels": [ "Year and Qtr" ] }, "qNullSuppression": true }, { "qDef": { "qLabel": "FIR%", "qDef": "Avg(FwHit)", "qNumFormat": { "qType": "F", "qnDec": 2, "qUseThou": 0, "qFmt": "0.0%", "qDec": ".", "qThou": "," } } }, { "qDef": { "qLabel": "GIR%", "qDef": "Avg(GIR)", "qNumFormat": { "qType": "F", "qnDec": 2, "qUseThou": 0, "qFmt": "0.0%", "qDec": ".", "qThou": "," } } } ], { "showTitles": true, "title": "Fairways hit vs. Greens hit relation" } ).then(function(vis){ vis.show("QV01"); }); ```