Color Coded Layer (Business Analyst)

Available with Business Analyst license.

Summary

Creates multilevel, scale-dependent choropleth layers from a variable describing a business, demographic, consumer, or landscape characteristic.

Illustration

Usage

• The output is a group layer containing scale-dependent administrative geography levels with a user-defined variable. By default, all levels and all features within each level are included in the group layer.

• Local data or online data can be used to create a color coded layer. The data can be explored through the data browser.

• The Area of Interest parameter defines the geographic extent of the analysis. The following also pertain to the area of interest:

  • It is only supported with local data.
  • The output creates a feature dataset.
  • If specified, administrative geography levels intersecting the area of interest that include more than 10,000 features will not be included in the group layer.
  • If specified, it enables the Color Coded Group Layer symbology pane and ribbon contextual menu and supports additional settings and usability features outside of this tool.

• When the Classification Method parameter is set to Auto, the following methods will be used for each variable type:

  Variable type	Method
  Natural Breaks (Jenks)	Count, Density
  Quantile	Average
  Equal Interval	Percent, Median, Index, Ratio, Rate, Per capita

• Custom data (.sdcx file) variables only include the custom feature layer; multiple levels will not be created.

Parameters

Dialog

Label	Explanation	Data Type
Classification Variable	A variable that will display as a color-coded map.	String
Output Layer Name	The name of the color-coded layer that will be added to the map.	String
Classification Method	Specifies the method that will be used to calculate the class breaks. Natural Breaks (Jenks)—Natural breaks classes are based on natural groupings inherent in the data. Class breaks that best group similar values and maximize the differences between classes will be identified. This is the default. Quantile—Each class will contain an equal number of features. A quantile classification is well suited to linearly distributed data. Equal Interval—The range of attribute values will be divided into equal-sized subranges. This allows you to specify the number of intervals and will automatically determine the class breaks based on the value range. Geometric Interval—Class breaks will be created based on class intervals that have a geometric series. The geometric coefficient in this classifier can change once (to its inverse) to optimize the class ranges. Auto—Classification methods will be automatically defined using the variable metadata. This presents the recommended thematic map style based on the data type.	String
Number of Classes	The number of data classification breaks that will appear on the map. The default value is 5.	String
Area of Interest (Optional)	The feature layer that will be used to determine the geographic extent of the analysis.	Feature Layer
Output Geodatabase (Optional)	The geodatabase in which the output feature dataset will be created.	Workspace
Feature Dataset Name (Optional)	The name of the feature dataset in the output geodatabase in which the color-coded layer feature classes will be created.	String
Boundary Mode (Optional)	Specifies the types of boundaries that will be used to create levels in the color-coded group layer. Standard Geographies—Boundaries will be levels of standard geographies. This is the default. H3 Hexagons—Boundaries will be levels of H3 hexagons.	String

Derived Output

Label	Explanation	Data Type
Output Layer	A container for the output layer.	Group Layer
Updated Feature Dataset	The new output feature dataset.	Feature Dataset

Python

arcpy.ba.ColorCodedLayer(classification_variable, out_layer_name, classification_method, number_of_classes, {area_of_interest}, {out_dataset_path}, {out_dataset_name}, {boundary_mode})

Name	Explanation	Data Type
classification_variable	A variable that will display as a color-coded map.	String
out_layer_name	The name of the color-coded layer that will be added to the map.	String
classification_method	Specifies the method that will be used to calculate the class breaks. NATURAL_BREAKS—Natural breaks classes are based on natural groupings inherent in the data. Class breaks that best group similar values and maximize the differences between classes will be identified. This is the default. QUANTILE—Each class will contain an equal number of features. A quantile classification is well suited to linearly distributed data. EQUAL_INTERVAL—The range of attribute values will be divided into equal-sized subranges. This allows you to specify the number of intervals and will automatically determine the class breaks based on the value range. GEOMETRIC_INTERVAL—Class breaks will be created based on class intervals that have a geometric series. The geometric coefficient in this classifier can change once (to its inverse) to optimize the class ranges. AUTO—Classification methods will be automatically defined using the variable metadata. This presents the recommended thematic map style based on the data type.	String
number_of_classes	The number of data classification breaks that will appear on the map. The default value is 5.	String
area_of_interest (Optional)	The feature layer that will be used to determine the geographic extent of the analysis.	Feature Layer
out_dataset_path (Optional)	The geodatabase in which the output feature dataset will be created.	Workspace
out_dataset_name (Optional)	The name of the feature dataset in the output geodatabase in which the color-coded layer feature classes will be created.	String
boundary_mode (Optional)	Specifies the types of boundaries that will be used to create levels in the color-coded group layer. STANDARD_GEOGRAPHIES—Boundaries will be levels of standard geographies. This is the default. H3_HEXAGONS—Boundaries will be levels of H3 hexagons.	String

Derived Output

Name	Explanation	Data Type
out_layer	A container for the output layer.	Group Layer
out_dataset	The new output feature dataset.	Feature Dataset

Code sample

ColorCodedLayer example (Python window)

The following Python window script demonstrates how to use the ColorCodedLayer function.

import arcpy
arcpy.env.baDataSource = "ONLINE;US;"
arcpy.ba.ColorCodedLayer("networth.mednw_cy", "CCL_NetWorth", "NATURAL_BREAKS", 5, "San_Francisco_County_BGs", "path to GDB", "SF_BGs)

ColorCodedLayer (Python window)

The following Python window script demonstrates how to use the ColorCodedLayer function with Statistical Data Collection variables.

import arcpy
arcpy.env.baDataSource = "USA_ESRI_2018"
arcpy.ba.ColorCodedLayer(r"c:\users\<User ID>\documents\arcgis\projects\my_project\bayarea_proprietarydata.sdcx/sales_s01_sales", "sales_s01_sales Layer", "NATURAL_BREAKS", 5)

Environments

Current Workspace, Data Source

Licensing information

• Basic: Requires Business Analyst
• Standard: Requires Business Analyst
• Advanced: Requires Business Analyst