サマリー
Box plots allow you to visualize and compare the distribution and central tendency of numeric values through their quartiles.
説明
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 sample section for an example of how to specify arguments using keywords.
構文
Box (y, {x}, {splitCategory}, {splitCategoryAsMeanLine}, {standardizeValues}, {showOutliers}, {rotated}, {title}, {description}, {xTitle}, {yTitle}, {dataSource}, {displaySize})| パラメーター | 説明 | データ タイプ |
y | The fields to display as boxes. Specify a single field name or a list of field names. | String |
x | The x-axis field is used to create multiple series box plots by setting the category. See the documentation on box plots for more information. | String |
splitCategory | A second categorical field that adds a separate series or box for each unique value in the field. | String |
splitCategoryAsMeanLine | Multiple-series box plots created with a split field can be displayed as mean lines or as side-by-side boxes. True displays split multiple series as mean lines. False displays multiple series as side-by-side boxes. (デフォルト値は次のとおりです False) | Boolean |
standardizeValues | Box plots created from multiple fields are standardized by default. True displays standardized values. False displays nonstandardized values. (デフォルト値は次のとおりです True) | Boolean |
showOutliers | Indicates whether outliers are shown as points extending beyond the whiskers. True displays outliers as points. False includes outliers in whiskers. (デフォルト値は次のとおりです False) | Boolean |
rotated | Indicates whether boxes are viewed vertically or horizontally. Boxes are displayed vertically by default. True rotates boxes horizontally. False displays boxes vertically. (デフォルト値は次のとおりです False) | Boolean |
title |
Sets 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 | Sets the description of the chart. The description text appears at the bottom of the chart view. | String |
xTitle | Sets the title for the x-axis of the chart. | String |
yTitle | Sets the title for the y-axis of the chart. | String |
dataSource | Sets the data source of the chart. When a chart is exported using the exportToSVG method or displayed in an ArcGIS Notebook, the data source is read and rendered on the chart. Valid data sources include paths to datasets, including local datasets, UNC paths, and service URLs, and arcpy.mp Layer objects. | Object |
displaySize [displaySize,...] | Sets 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, where the first item is the width of the chart and the second item is the height of the chart. | List |
プロパティ
| プロパティ | 説明 | データ タイプ |
| dataSource (読み書き) | Sets the data source of the chart. When a chart is exported using the exportToSVG method or displayed in an ArcGIS Notebook, the data source is read and rendered on the chart. Valid data sources include paths to datasets, including local datasets, UNC paths, and service URLs, and arcpy.mp Layer objects. | Object |
| description (読み書き) | Sets the description of the chart. The description text appears at the bottom of the chart view. | String |
| displaySize (読み書き) | Sets 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, where the first item is the width of the chart and the second item is the height of the chart. | List |
| legend (読み書き) | Sets the properties of the chart legend.
| Object |
| rotated (読み書き) | Indicates whether the chart is viewed vertically or horizontally. The chart displays vertically by default. True rotates the chart horizontally. False displays the chart vertically. | Boolean |
| showOutliers (読み書き) | Indicates whether outliers are shown as points extending beyond the whiskers. True displays outliers as points. False includes outliers in whiskers. | Boolean |
| splitCategory (読み書き) | A second categorical field that adds a separate series or box for each unique value in the field. | String |
| splitCategoryAsMeanLine (読み書き) | Multiple series box plots created with a split field can be displayed as mean lines or as side-by-side boxes. True displays split multiple series as mean lines. False displays split multiple series as side-by-side boxes. | Boolean |
| standardizeValues (読み書き) | Box plots created from multiple fields are standardized by default. True displays standardized values. False displays nonstandardized values. | Boolean |
| title (読み書き) | Sets 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 (読み取り専用) | The string value indicating the chart type. | String |
| x (読み書き) | The field name used to create multiple series box plots by setting the category. See the documentation on box plots for more information. | String |
| xAxis (読み書き) | Sets the properties of the x-axis.
| Object |
| y (読み書き) | The field or fields to display as boxes. Must specify a single field name or a list of field names. | String |
| yAxis (読み書き) | Sets the properties of the y-axis.
| Object |
.方法の概要
| 方法 | 説明 |
| 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. |
方法
addToLayer (layer_or_layerfile)
| パラメーター | 説明 | データ タイプ |
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)
| パラメーター | 説明 | データ タイプ |
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()コードのサンプル
Create a box plot using a .csv file and export the box plot to an .svg file.
import arcpy
chart = arcpy.charts.Box(y=["pct_diabetes", "pct_asthma", "pct_heart"],
splitCategory="State",
dataSource="chronic_health_conditions.csv")
chart.title = "Distribution of Chronic Health Conditions by State"
chart.exportToSVG("box.svg", width=700, height=600)