Volver al principio

MatrixHeat

En este tema

  1. Resumen
  2. Debate
  3. Sintaxis
  4. Propiedades
  5. Descripción general del método
  6. Métodos
  7. Muestra de código

Resumen

Matrix heat charts analyze relationships between two categorical fields, which can be visualized by count or summarized by a numeric field.

Learn more about matrix heat charts in ArcGIS Pro

Debate

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

Sintaxis

MatrixHeat (x, y, {numberField}, {aggregation}, {nullPolicy}, {classificationMethod}, {classCount}, {timeBinningPropertiesCol}, {timeBinningPropertiesRow}, {title}, {description}, {xTitle}, {yTitle}, {dataSource}, {displaySize})
ParámetroExplicaciónTipo de datos
x

The name of the field that determines the column categories.

String
y

The name of the field that determines the row categories.

String
numberField

The name of the field that is aggregated and used to determine the color of the chart cells.

String
aggregation

Specifies the statistical calculation that will be applied to values aggregated into each cell.

  • COUNT—The total number of records will be identified.
  • SUM—The sum of all values will be calculated.
  • MEAN—The mean of all values will be calculated.
  • MEDIAN—The median of all values will be calculated.
  • MIN—The minimum value will be identified.
  • MAX—The maximum value will be identified.
String
nullPolicy

Specifies how summarized cells returning a null value will be displayed.

  • null—Cells will be displayed as null.
  • zero—Cells will be displayed as zero.
String
classificationMethod

Specifies the classification method that will be used to visualize cell color and classify data.

  • equalIntervals—The equal interval method will be used.
  • geometricalIntervals—The geometric interval method will be used.
  • naturalBreaks—The natural breaks method will be used.
  • quantiles—The quantiles method will be used.
String
classCount

The number of classes used in the classification method.

Integer
timeBinningPropertiesCol

The time binning properties from the TimeBinningProperties class that are applied to the x-axis.

Object
timeBinningPropertiesRow

The time binning properties from the TimeBinningProperties class that are applied to the y-axis.

Object
title

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

The description of the chart. The description text appears at the bottom of the chart view.

String
xTitle

The title of the x-axis of the chart.

String
yTitle

The title of the y-axis of the chart.

String
dataSource

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
  • Arrow table objects
  • Layer objects

Object
displaySize
[displaySize,...]

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

Propiedades

PropiedadExplicaciónTipo de datos
aggregation
(Lectura y escritura)

Specifies the statistical calculation that will be applied to values aggregated into each cell.

  • COUNT—The total number of records will be identified.
  • SUM—The sum of all values will be calculated.
  • MEAN—The mean of all values will be calculated.
  • MEDIAN—The median of all values will be calculated.
  • MIN—The minimum value will be identified.
  • MAX—The maximum value will be identified.
String
classCount
(Lectura y escritura)

The number of classes used in the classification method.

Integer
classificationMethod
(Lectura y escritura)

Specifies the classification method that will be used to visualize cell color and classify data.

  • equalIntervals—The equal interval method will be used.
  • geometricalIntervals—The geometric interval method will be used.
  • naturalBreaks—The natural breaks method will be used.
  • quantiles—The quantiles method will be used.
String
dataSource
(Lectura y escritura)

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
  • Arrow table objects
  • Layer objects.

Object
description
(Lectura y escritura)

The description of the chart. The description text appears at the bottom of the chart view.

String
displaySize
(Lectura y escritura)

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
legend
(Lectura y escritura)

The properties of the chart legend.

  • visible—Specifies whether the legend will be displayed in the chart view. True displays the legend, and False hides the legend.
  • title—The title of the legend.
Object
nullPolicy
(Lectura y escritura)

Specifies how summarized cells returning a null value will be displayed.

  • null—Cells will be displayed as null.
  • zero—Cells will be displayed as zero.
String
numberField
(Lectura y escritura)

The name of the field that is aggregated and used to determine the color of the chart cells.

String
theme
(Lectura y escritura)

Specifies the name of the theme that is applied to the chart.

String
timeBinningPropertiesCol
(Lectura y escritura)

The time binning properties from the TimeBinningProperties class that are applied to the x-axis.

Object
timeBinningPropertiesRow
(Lectura y escritura)

The time binning properties from the TimeBinningProperties class that are applied to the y-axis.

Object
title
(Lectura y escritura)

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 Lista por orden de dibujo.

String
type
(Sólo lectura)

The string value indicating the chart type.

String
x
(Lectura y escritura)

The name of the field that determines the column categories.

String
xAxis
(Lectura y escritura)

The properties of the x-axis.

  • field—The name of the field that determines the column categories.
  • logarithmic—This property is not supported for the MatrixHeat class.
  • maximum—This property is not supported for the MatrixHeat class.
  • minimum—This property is not supported for the MatrixHeat class.
  • sort—The sorting method applied to this axis. ASC is for ascending sorting and DESC is for descending sorting. A custom sort order can be specified by assigning a list of ordered category names.
  • title—The label of the axis that displays on the chart.
Object
y
(Lectura y escritura)

The name of the field that determines the row categories.

String
yAxis
(Lectura y escritura)

The properties of the y-axis.

  • field—The name of the field that determines the row categories. This property optionally accepts a two-item list in which the first item is the y-axis field and the second item is the numeric field that will be aggregated.
  • logarithmic—This property is not supported for the MatrixHeat class.
  • maximum—This property is not supported for the MatrixHeat class.
  • minimum—This property is not supported for the MatrixHeat class.
  • sort—The sorting method applied to this axis. ASC is for ascending sorting and DESC is for descending sorting. A custom sort order can be specified by assigning a list of ordered category names.
  • title—The label of the axis that displays on the chart.
Object

Descripción general del método

MétodoExplicación
addToLayer (layer_or_layerfile)

Adds the chart object to a layer or stand-alone table.

exportToSVG (path, width, height)

Exports the chart to SVG format.

updateChart ()

Updates chart properties to sync changes between the object and the chart previously added to a layer.

Métodos

addToLayer (layer_or_layerfile)
ParámetroExplicaciónTipo de datos
layer_or_layerfile

The chart will be added to the target object. The layer_or_layerfile argument can be a Layer or a Table object.

Object

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

Add a chart to an existing layer.

import arcpy

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)
exportToSVG (path, width, height)
ParámetroExplicaciónTipo de datos
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

In some cases, you may want to save the chart as a graphic that can be shared and viewed outside of ArcGIS Pro. Exporting to the SVG graphic format is beneficial, as the chart elements and text are stored as vector elements that can be independently modified in a vector graphics software. An SVG graphic can also be resized to any scale without pixelation or loss in quality.

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

import arcpy

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

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

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

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


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.exportToSVG('theftsPerBeat.svg', 800, 600)
updateChart ()

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

To further modify the chart properties, you can modify the properties of the original chart instead of starting from scratch 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 will allow 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.


chart.addToLayer(myLayer)

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

Muestra de código

Create a matrix heat chart using a .csv file and export the chart to an .svg file.


import arcpy
chart = arcpy.charts.MatrixHeat(x="OrigCity", y="DestCity", numberField="DelayTime",
                                aggregation="mean", title="Average Flight Arrival Delay",
                                displaySize=(800, 500), dataSource="flight_delays.csv")
chart.exportToSVG("matrix_heat_chart.svg")

¿Algún comentario sobre este tema?

En este tema
  1. Resumen
  2. Debate
  3. Sintaxis
  4. Propiedades
  5. Descripción general del método
  6. Métodos
  7. Muestra de código