ScatterMatrix

Summary

The ScatterMatrix class creates scatter plot matrices. A scatter plot matrix is a grid (or matrix) of scatter plots used to visualize bivariate relationships between combinations of variables. Each scatter plot in the matrix visualizes the relationship between a pair of variables, allowing many relationships to be explored in one chart.

Learn more about scatter plot matrices in ArcGIS Pro

Discussion

When creating this object, optional arguments for the class constructor must be specified using the argument name; they cannot be specified by argument position. See the Code sample section for an example of how to specify arguments using keywords.

Syntax

ScatterMatrix(fields, {showTrendLine}, {trendLineType}, {trendOrder}, {lowerLeft}, {upperRight}, {diagonal}, {sort}, {sortBy}, {showPValue}, {title}, {description}, {dataSource}, {displaySize}, {theme})

Name	Explanation	Data type
fields	A list of field names to display in the matrix. A minimum of three fields is required.	List
showTrendLine (Optional)	Indicates whether trend lines are visible in the scatter plots. True—Display trend lines. False—Hide trend lines.	Boolean
trendLineType (Optional)	Specifies the type of trend line displayed in the scatter plots. LINEAR—Displays a linear trend line. EXPONENTIAL—Displays an exponential trend line. LOGARITHMIC—Displays a logarithmic trend line. POWER—Displays a power trend line. POLYNOMIAL—Displays a polynomial trend line.	String
trendOrder (Optional)	Specifies the order for a polynomial trend line.	Integer
lowerLeft (Optional)	Sets the display of the lower left half of the matrix. R_SQUARED—Display r-squared values. PEARSONS_R—Display Pearson's r values. SCATTERPLOTS—Display scatter plots.	String
upperRight (Optional)	Sets the display of the upper right half of the matrix. R_SQUARED—Display r-squared values. PEARSONS_R—Display Pearson's r values. SCATTERPLOTS—Display scatter plots. PREVIEW_PLOT—Display preview plot. NONE—Display nothing.	String
diagonal (Optional)	Sets the display of the diagonal view. FIELD_NAMES—Display the field names. HISTOGRAMS—Display histograms. NONE—Display nothing.	String
sort (Optional)	The sorting method that is applied to the matrix. ASC—Sort in ascending order when `sortBy` is set to `R_SQUARED` or `PEARSONS_R`. DESC—Sort in descending order when `sortBy` is set to `R_SQUARED` or `PEARSONS_R`. NONE—Sorted by the order of the `fields` list.	String
sortBy (Optional)	The method that is used to sort the matrix when you want to sort the rows according to the metric scores for a target field. R_SQUARED—Sort by r-squared values. PEARSONS_R—Sort by Pearson's r values.	String
showPValue (Optional)	Specifies whether p-value indicators are visible.	Boolean
title (Optional)	The title of the chart. The title text appears at the top of the chart view and is used as the label for the chart in the Contents pane.	String
description (Optional)	The description of the chart. The description text appears at the bottom of the chart view.	String
dataSource (Optional)	The data source of the chart. When a chart is exported using the `exportToSVG` method or displayed in ArcGIS Notebooks, the data source will be read and rendered on the chart. Valid data sources include the following: Paths to datasets, including local datasets, UNC paths, and service URLs Apache Arrow table objects `Layer` or `Table` objects	Object
displaySize (Optional)	The size of the chart when exported using the `exportToSVG` method or displayed in ArcGIS Notebooks. The value must be specified as a two-item list in which the first item is the width of the chart and the second item is the height of the chart.	List
theme (Optional)	Specifies the theme that will be applied to the chart. Light—The Light theme will be applied. Medium—The Medium theme will be applied. Dark—The Dark theme will be applied.	String

Properties

Name	Explanation	Data type
dataSource (Read and Write)	The data source of the chart. When a chart is exported using the `exportToSVG` method or displayed in an ArcGIS notebook, the data source will be read and rendered on the chart. Valid data sources include the following: Paths to datasets, including local datasets, UNC paths, and service URLs Apache Arrow table objects `Layer` or `Table` objects	Object
description (Read and Write)	The description of the chart. The description text appears at the bottom of the chart view.	String
diagonal (Read and Write)	Sets the display of the diagonal view. FIELD_NAMES—Display the field names. HISTOGRAMS—Display histograms. NONE—Display nothing.	String
displaySize (Read and Write)	The size of the chart when exported using the `exportToSVG` method or displayed in an ArcGIS notebook. The value must be specified as a two-item list in which the first item is the width of the chart and the second item is the height of the chart.	List
fields (Read and Write)	A list of field names to display in the matrix. A minimum of three fields is required.	List
lowerLeft (Read and Write)	Sets the display of the lower left half of the matrix. R_SQUARED—Display r-squared values. PEARSONS_R—Display Pearson's r values. SCATTERPLOTS—Display scatter plots.	String
showPValue (Read and Write)	Specifies whether p-value indicators are visible.	Boolean
showTrendLine (Read and Write)	Indicates whether trend lines are visible in the scatter plots. True—Display trend lines. False—Hide trend lines.	Boolean
sort (Read and Write)	The sorting method that is applied to the matrix. ASC—Sort in ascending order when `sortBy` is set to `R_SQUARED` or `PEARSONS_R`. DESC—Sort in descending order when `sortBy` is set to `R_SQUARED` or `PEARSONS_R`. NONE—Sorted by the order of the `fields` list.	String
sortBy (Read and Write)	The method that is used to sort the matrix when you want to sort the rows according to the metric scores for a target field. R_SQUARED—Sort by r-squared values. PEARSONS_R—Sort by Pearson's r values.	String
theme (Read and Write)	Specifies the theme that will be applied to the chart. Light—The Light theme will be applied. Medium—The Medium theme will be applied. Dark—The Dark theme will be applied.	String
title (Read and Write)	The title of the chart. The title text appears at the top of the chart view and is used as the label in the Contents pane on the List By Drawing Order tab .	String
type (Read only)	The string value indicating the chart type.	String
trendLineType (Read and Write)	Specifies the type of trend line displayed in the scatter plots. LINEAR—Displays a linear trend line. EXPONENTIAL—Displays an exponential trend line. LOGARITHMIC—Displays a logarithmic trend line. POWER—Displays a power trend line. POLYNOMIAL—Displays a polynomial trend line.	String
trendOrder (Read and Write)	Specifies the order for a polynomial trend line.	Integer
upperRight (Read and Write)	Sets the display of the upper right half of the matrix. R_SQUARED—Display r-squared values. PEARSONS_R—Display Pearson's r values. SCATTERPLOTS—Display scatter plots. PREVIEW_PLOT—Display preview plot. NONE—Display nothing.	String

Methods

`addToLayer(layer_or_layerfile)`

The addToLayer method adds the chart object to a layer or table view.

Adding the chart object to a layer or table using the addToLayer method is often the final step after defining chart properties.

Name	Explanation	Data type
layer_or_layerfile	The chart will be added to the target object. This argument can be a `Layer` or `Table` object.	Object

Add a chart to an existing layer.

import arcpy

# Insert creation of chart object here
# ...

aprx = arcpy.mp.ArcGISProject("current")
map = aprx.listMaps()[0]
censusLayer = map.listLayers('Census Block Groups')[0]

# Add chart object to a layer
chart.addToLayer(censusLayer)

`exportToJPEG(path, width, height)`

The exportToJPEG method exports a chart to JPEG format.

The chart is exported to a .jpg file that can be shared and viewed outside of ArcGIS Pro. JPEG is a raster image format that uses lossy compression to reduce file size.

Name	Explanation	Data type
path	The path where the chart will be exported in JPEG format.	String
width	The width of the output graphic.	Integer
height	The height of the output graphic.	Integer

Export a chart that has a feature service data source to a .jpeg file.

import arcpy

# Insert creation of chart object here
# ...

featureServiceURL = r'https://services1.arcgis.com/hLJbHVT9ZrDIzK0I/arcgis/rest/services/CrimesChiTheft/FeatureServer/0'

# Set data source of chart object to a feature service URL
chart.dataSource = featureServiceURL

# Save the chart to file with dimensions width=800, height=600
chart.exportToJPEG('theftsPerBeat.jpg', 800, 600)

`exportToPNG(path, width, height)`

The exportToPNG method exports a chart to PNG format.

The chart is exported to a .png file that can be shared and viewed outside of ArcGIS Pro. PNG is a raster image format that uses lossless compression to preserve image quality.

Name	Explanation	Data type
path	The path where the chart will be exported in PNG format.	String
width	The width of the output graphic.	Integer
height	The height of the output graphic.	Integer

Access an existing chart from a layer, update the title, and export it to a .png file.

import arcpy

lyr = arcpy.mp.ArcGISProject('current').listLayers()[0]

# Retrieve the first chart belonging to the layer
chart = lyr.listCharts()[0]

# Update chart title
chart.title = 'Voter Turnout by State'

# Save the chart to PNG file with dimensions width=800, height=600
chart.exportToPNG('populationByState.png', 800, 600)

`exportToSVG(path, width, height)`

The exportToSVG method exports a chart to SVG format.

The chart is exported to an .svg file that can be shared and viewed outside of ArcGIS Pro. SVG is a vector image format that allows for editing and infinite scaling of the graphic without a loss in quality.

Name	Explanation	Data type
path	The path where the chart will be exported in SVG format.	String
width	The width of the output graphic.	Integer
height	The height of the output graphic.	Integer

Export a chart that has a project layer data source to an .svg file.

import arcpy

# Insert creation of chart object here
# ...

aprx = arcpy.mp.ArcGISProject('current')
censusLayer = aprx.listMaps()[0].listLayers('Census Block Groups')[0]

# Set data source of chart object to a layer in current project
chart.dataSource = censusLayer

# Save the chart to file with dimensions width=500, height=500
chart.exportToSVG('populationByState.svg', 500, 500)

`updateChart()`

The updateChart method updates chart properties to sync changes between the object and the chart previously added to a layer.

Adding the chart object to a layer using the addToLayer method is often the final step after defining chart properties.

You can also modify the properties of the original chart instead of starting with a new chart. You can then use the updateChart method to synchronize any changes into the chart that was added to the layer. This allows the changes you make to be presented in the Chart properties pane and chart view.

Use the updateChart method to synchronize chart property changes into a layer.

import arcpy

# Insert creation of chart object here
# ...

chart.addToLayer(myLayer)

# Further modification is necessary
chart.description = "Data from the U.S. Census Bureau"
chart.updateChart()

Code sample

Create a scatter plot matrix using a layer name and export it to an .svg file.

import arcpy
chart = arcpy.charts.ScatterMatrix(fields=["copd", "diabetes", "heart_failure", "hypertension", "high_cholesterol"],
                                   lowerLeft="R_SQUARED", upperRight="PREVIEW_PLOT",
                                   dataSource="health_indicators", displaySize=(800, 500))
chart.exportToSVG("scatter_matrix.svg")