ArcGIS Pro 3.8 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / ClassBreaksRendererDefinition Class / ColorRamp Property
Example

In This Topic
    ColorRamp Property (ClassBreaksRendererDefinition)
    In This Topic
    Gets or sets the color ramp be used to pick color for symbols from.
    Syntax
    public CIMColorRamp ColorRamp {get; set;}
    Public Property ColorRamp As CIMColorRamp
    Example
    Create a feature layer with class breaks renderer
    {
      string colorBrewerSchemesName = "ColorBrewer Schemes (RGB)";
      StyleProjectItem colorBrewerStyle = Project.Current.GetItems<StyleProjectItem>().First(s => s.Name == colorBrewerSchemesName);
      string colorRampName = "Greens (Continuous)";
      IList<ColorRampStyleItem> colorRampListFromTheStyle = await QueuedTask.Run(() =>
        colorBrewerStyle.SearchColorRamps(colorRampName));
    
      ColorRampStyleItem colorRampFound = colorRampList[0];
      GraduatedColorsRendererDefinition gcDef = new GraduatedColorsRendererDefinition()
      {
        ClassificationField = "CROP_ACR07",
        ClassificationMethod = ArcGIS.Core.CIM.ClassificationMethod.NaturalBreaks,
        BreakCount = 6,
        ColorRamp = colorRampFound.ColorRamp,
        SymbolTemplate = SymbolFactory.Instance.ConstructPolygonSymbol(
                                ColorFactory.Instance.GreenRGB, SimpleFillStyle.Solid, null).MakeSymbolReference(),
        ExclusionClause = "CROP_ACR07 = -99",
        ExclusionSymbol = SymbolFactory.Instance.ConstructPolygonSymbol(
                                ColorFactory.Instance.RedRGB, SimpleFillStyle.Solid, null).MakeSymbolReference(),
        ExclusionLabel = "No yield",
      };
      var featureLayerCreationParams = new FeatureLayerCreationParams((new Uri(@"c:\Data\CountyData.gdb\Counties")))
      {
        Name = "Crop",
        RendererDefinition = gcDef
      };
      await QueuedTask.Run(() =>
        LayerFactory.Instance.CreateLayer<FeatureLayer>(featureLayerCreationParams, map));
    }
    Class Breaks renderer with graduated colors.
    /// <summary>
    /// Renders a feature layer using graduated colors to draw quantities.
    /// ![cb-colors.png](https://ArcGIS.github.io/arcgis-pro-sdk/images/Renderers/cb-colors.png "Graduated colors with natural breaks renderer.")
    /// </summary>
    {
      //Check feature layer name
      //Code works with the USDemographics feature layer available with the ArcGIS Pro SDK Sample data
      var featureLayer = activeMap.GetLayersAsFlattenedList().OfType<FeatureLayer>().FirstOrDefault(f => f.Name == "USDemographics");
      if (featureLayer == null)
      {
        MessageBox.Show("This renderer works with the USDemographics feature layer available with the ArcGIS Pro SDK Sample data", "Data missing");
      }
    
      GraduatedColorsRendererDefinition gcDef = new GraduatedColorsRendererDefinition()
      {
        ClassificationField = "NumericFieldInFeatureLayer",
        ClassificationMethod = ClassificationMethod.NaturalBreaks,
        BreakCount = 5,
        ColorRamp = colorRamp,
      };
      await QueuedTask.Run(() =>
      {
        CIMClassBreaksRenderer renderer = (CIMClassBreaksRenderer)featureLayer.CreateRenderer(gcDef);
        featureLayer?.SetRenderer(renderer);
      });
    }
    Class Breaks renderer with graduated colors and outline
    /// <summary>
    /// Renders a feature layer using graduated colors to draw quantities. The outline width is varied based on attributes.
    /// ![graduatedColorOutline.png](https://ArcGIS.github.io/arcgis-pro-sdk/images/Renderers/graduatedColorOutline.png "Graduated colors with natural breaks renderer.")
    /// </summary>
    {
      //Check feature layer name
      //Code works with the USDemographics feature layer available with the ArcGIS Pro SDK Sample data
      var featureLayer = activeMap.GetLayersAsFlattenedList().OfType<FeatureLayer>().FirstOrDefault(f => f.Name == "USDemographics");
      if (featureLayer == null)
      {
        MessageBox.Show("This renderer works with the USDemographics feature layer available with the ArcGIS Pro SDK Sample data", "Data missing");
      }
      //Gets the first numeric field of the feature layer
      var firstNumericFieldOfFeatureLayer = "NumericFieldInFeatureLayer";
      //Gets the min and max value of the field
      var minMax = await GetFieldMinMaxAsync(featureLayer, firstNumericFieldOfFeatureLayer);
      GraduatedColorsRendererDefinition gcDef = new GraduatedColorsRendererDefinition()
      {
        ClassificationField = "NumericFieldInFeatureLayer",
        ClassificationMethod = ClassificationMethod.NaturalBreaks,
        BreakCount = 5,
        ColorRamp = colorRamp
      };
      CIMClassBreaksRenderer renderer = await QueuedTask.Run(() =>
        (CIMClassBreaksRenderer)featureLayer.CreateRenderer(gcDef));
      //Create array of CIMVisualVariables to hold the outline information.
      var visualVariables = new CIMVisualVariable[] {
                  new CIMSizeVisualVariable
                  {
                      ValueExpressionInfo = new CIMExpressionInfo
                      {
                         Title = "Custom",
                         Expression = "$feature.AREA",
                         ReturnType = ExpressionReturnType.Default
                      },
                      AuthoringInfo = new CIMVisualVariableAuthoringInfo
                      {
                          MinSliderValue = Convert.ToDouble(minMax.Item1),
                          MaxSliderValue = Convert.ToDouble(minMax.Item2),
                          ShowLegend = false,
                          Heading = firstNumericFieldOfFeatureLayer
                      },
                      VariableType = SizeVisualVariableType.Graduated,
                      Target = "outline",
                      MinSize = 1,
                      MaxSize = 13,
                      MinValue = Convert.ToDouble(minMax.Item1),
                      MaxValue = Convert.ToDouble(minMax.Item2)
                  },
    
              };
      renderer.VisualVariables = visualVariables;
      await QueuedTask.Run(() => featureLayer?.SetRenderer(renderer));
    }
    Class Breaks renderer with graduated symbols.
    /// <summary>
    /// Renders a feature layer using graduated symbols and natural breaks to draw quantities.
    /// ![cb-symbols.png](https://ArcGIS.github.io/arcgis-pro-sdk/images/Renderers/cb-symbols.png "Graduated symbols with natural breaks renderer.")
    /// </summary>
    {
      //Check feature layer name
      //Code works with the USDemographics feature layer available with the ArcGIS Pro SDK Sample data
      var featureLayer = activeMap.GetLayersAsFlattenedList().OfType<FeatureLayer>().FirstOrDefault(f => f.Name == "USDemographics");
      if (featureLayer == null)
      {
        MessageBox.Show("This renderer works with the USDemographics feature layer available with the ArcGIS Pro SDK Sample data", "Data missing");
      }
      GraduatedSymbolsRendererDefinition gsDef = new GraduatedSymbolsRendererDefinition()
      {
        ClassificationField = "NumericFieldInFeatureLayer", //getting the first numeric field
        ClassificationMethod = ClassificationMethod.NaturalBreaks,
        SymbolTemplate = SymbolFactory.Instance.ConstructPointSymbol(CIMColor.CreateRGBColor(76, 230, 0)).MakeSymbolReference(),
        MinimumSymbolSize = 4,
        MaximumSymbolSize = 50,
        BreakCount = 5,
        ColorRamp = colorRamp, //getting a color ramp
      };
      await QueuedTask.Run(() =>
      {
        CIMClassBreaksRenderer renderer = (CIMClassBreaksRenderer)featureLayer.CreateRenderer(gsDef);
        featureLayer?.SetRenderer(renderer);
      });
    }
    Requirements

    Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

    ArcGIS Pro version: 3.0 or higher.
    See Also