SetRenderer(CIMRenderer,FeatureRendererTarget) Method

In This Topic

Specifies the feature layer's renderer object which determines how the layer draws. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Overloads Sub SetRenderer( _
   ByVal renderer As CIMRenderer, _
   ByVal featureRendererTarget As FeatureRendererTarget _
)

public void SetRenderer( 
   CIMRenderer renderer,
   FeatureRendererTarget featureRendererTarget
)

Parameters

renderer: Your custom renderer that will be used to draw features of the feature layer.
featureRendererTarget: A FeatureRendererTarget indicating the intended usage of the resulting renderer.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.ArgumentException	Renderer cannot be of type CIMHeatMapRenderer
System.ArgumentException	Renderer cannot be of type CIMDotDensityRenderer
System.ArgumentException	The provided renderer cannot be used as a {0} renderer for this layer
System.InvalidOperationException	This feature layer does not support tracks

Remarks

Intended for use with StreamLayer. For non-stream layer types use FeatureRendererTarget.Default. Passing FeatureRendererTarget.PreviousObservations or FeatureRendererTarget.TrackLines for a non-track aware layer (feature or stream) will throw a System.InvalidOperationException. If the feature layer is a member of a SubtypeGroupLayer, the renderer argument passed cannot be of type CIMHeatMapRenderer or you will get a System.ArgumentException. If the feature layer is a member of a SubtypeGroupLayer and is in the 3D category of the table of contents in a 3D view, the renderer argument passed cannot be of type CIMDotDensityRenderer or you will get a System.ArgumentException. Use the IsSubtypeLayer property to determine if the feature layer is a member of a SubtypeGroupLayer. Use the SceneLayerType property to determine if the feature layer is in 3D category of the table of contents.

Example

Setting a unique value renderer for latest observations

{
  // Note: call within QueuedTask.Run()
  {
    var url = @"https://geoeventsample1.esri.com:6443/arcgis/rest/services/AirportTraffics/StreamServer";
    var uri = new Uri(url, UriKind.Absolute);

    var createParams = new FeatureLayerCreationParams(uri)
    {
      IsVisible = false
    };
    streamLayer = LayerFactory.Instance.CreateLayer<StreamLayer>(
                        createParams, map);
    //Define the unique values by hand
    var uvr = new CIMUniqueValueRenderer()
    {
      Fields = new string[] { "ACTYPE" },
      UseDefaultSymbol = true,
      DefaultLabel = "Others",
      DefaultSymbol = SymbolFactory.Instance.ConstructPointSymbol(
                  CIMColor.CreateRGBColor(185, 185, 185), 8, SimpleMarkerStyle.Hexagon).MakeSymbolReference()
    };

    var classes = new List<CIMUniqueValueClass>
    {
      //add in classes - one for ACTYPE of 727, one for DC 9
      new CIMUniqueValueClass()
      {
        Values = new CIMUniqueValue[] {
                new CIMUniqueValue() { FieldValues = new string[] { "B727" } } },
        Visible = true,
        Label = "Boeing 727",
        Symbol = SymbolFactory.Instance.ConstructPointSymbol(
                  ColorFactory.Instance.RedRGB, 10, SimpleMarkerStyle.Hexagon).MakeSymbolReference()
      },
      new CIMUniqueValueClass()
      {
        Values = new CIMUniqueValue[] {
                new CIMUniqueValue() { FieldValues = new string[] { "DC9" } } },
        Visible = true,
        Label = "DC 9",
        Symbol = SymbolFactory.Instance.ConstructPointSymbol(
                  ColorFactory.Instance.GreenRGB, 10, SimpleMarkerStyle.Hexagon).MakeSymbolReference()
      }
    };
    //add the classes to a group
    var groups = new List<CIMUniqueValueGroup>()
  {
    new CIMUniqueValueGroup() {
       Classes = classes.ToArray()
    }
  };
    //add the groups to the renderer
    uvr.Groups = groups.ToArray();
    //Apply the renderer (for current observations)
    streamLayer.SetRenderer(uvr);
    streamLayer.SetVisibility(true);//turn on the layer        
  }
}

Defining a unique value renderer definition

{
  // Note: call within QueuedTask.Run()
  {
    streamLayer = null;
    //https://geoeventsample1.esri.com:6443/arcgis/rest/services/AirportTraffics/StreamServer

    var uvrDef = new UniqueValueRendererDefinition()
    {
      ValueFields = new List<string> { "ACTYPE" },
      SymbolTemplate = SymbolFactory.Instance.ConstructPointSymbol(
        ColorFactory.Instance.RedRGB, 10, SimpleMarkerStyle.Hexagon)
          .MakeSymbolReference(),
      ValuesLimit = 5
    };
    //Note: CreateRenderer can only create value classes based on
    //the current events it has received
    streamLayer.SetRenderer(streamLayer.CreateRenderer(uvrDef));
  }
}

Setting a unique value renderer for latest observations 2

{
  // Note: call within QueuedTask.Run()
  {
    //Define the classes by hand to avoid using CreateRenderer(...)
    CIMUniqueValueClass uvcB727 = new CIMUniqueValueClass()
    {
      Values = new CIMUniqueValue[] { new CIMUniqueValue() { FieldValues = new string[] { "B727" } } },
      Visible = true,
      Label = "Boeing 727",
      Symbol = SymbolFactory.Instance.ConstructPointSymbol(CIMColor.CreateRGBColor(255, 0, 0), 8, SimpleMarkerStyle.Hexagon).MakeSymbolReference()
    };

    CIMUniqueValueClass uvcD9 = new CIMUniqueValueClass()
    {
      Values = new CIMUniqueValue[] { new CIMUniqueValue() { FieldValues = new string[] { "DC9" } } },
      Visible = true,
      Label = "DC 9",
      Symbol = SymbolFactory.Instance.ConstructPointSymbol(CIMColor.CreateRGBColor(0, 255, 0), 8, SimpleMarkerStyle.Hexagon).MakeSymbolReference()
    };
    //Assign the classes to a group
    CIMUniqueValueGroup uvGrp = new CIMUniqueValueGroup()
    {
      Classes = new CIMUniqueValueClass[] { uvcB727, uvcD9 }
    };
    //assign the group to the renderer
    var UVrndr = new CIMUniqueValueRenderer()
    {
      Fields = new string[] { "ACTYPE" },
      Groups = new CIMUniqueValueGroup[] { uvGrp },
      UseDefaultSymbol = true,
      DefaultLabel = "Others",
      DefaultSymbol = SymbolFactory.Instance.ConstructPointSymbol(
        CIMColor.CreateRGBColor(185, 185, 185), 8, SimpleMarkerStyle.Hexagon).MakeSymbolReference()
    };
    //set the renderer. Depending on the current events received, the
    //layer may or may not have events for each of the specified
    //unique value classes
    streamLayer.SetRenderer(UVrndr);
  }
}

Setting a unique value renderer for previous observations

{
  //The layer must be track aware and spatial
  if (streamLayer.TrackType != TrackType.Spatial)
  {
    // not track aware and spatial
  }
  // Note: call within QueuedTask.Run()
  {
    //Define unique value classes same as we do for current observations
    //or use "CreateRenderer(...)" to assign them automatically
    CIMUniqueValueClass uvcB727Prev = new CIMUniqueValueClass()
    {
      Values = new CIMUniqueValue[] { new CIMUniqueValue() {
      FieldValues = new string[] { "B727" } } },
      Visible = true,
      Label = "Boeing 727",
      Symbol = SymbolFactory.Instance.ConstructPointSymbol(
      CIMColor.CreateRGBColor(255, 0, 0), 4, SimpleMarkerStyle.Hexagon)
      .MakeSymbolReference()
    };

    CIMUniqueValueClass uvcD9Prev = new CIMUniqueValueClass()
    {
      Values = new CIMUniqueValue[] { new CIMUniqueValue() {
      FieldValues = new string[] { "DC9" } } },
      Visible = true,
      Label = "DC 9",
      Symbol = SymbolFactory.Instance.ConstructPointSymbol(
        CIMColor.CreateRGBColor(0, 255, 0), 4, SimpleMarkerStyle.Hexagon)
        .MakeSymbolReference()
    };

    CIMUniqueValueGroup uvGrpPrev = new CIMUniqueValueGroup()
    {
      Classes = new CIMUniqueValueClass[] { uvcB727Prev, uvcD9Prev }
    };

    var UVrndr = new CIMUniqueValueRenderer()
    {
      Fields = new string[] { "ACTYPE" },
      Groups = new CIMUniqueValueGroup[] { uvGrpPrev },
      UseDefaultSymbol = true,
      DefaultLabel = "Others",
      DefaultSymbol = SymbolFactory.Instance.ConstructPointSymbol(
        CIMColor.CreateRGBColor(185, 185, 185), 4, SimpleMarkerStyle.Hexagon)
        .MakeSymbolReference()
    };

    streamLayer.SetRenderer(UVrndr, FeatureRendererTarget.PreviousObservations);
  }
}

Setting a simple renderer to draw track lines

{
  // Note: call within QueuedTask.Run()
  {
    //The layer must be track aware and spatial
    if (streamLayer.TrackType != TrackType.Spatial)
    {
      // not track aware and spatial
    }

    //Note: only a simple renderer with solid line symbol is supported for track 
    //line renderer
    var trackRenderer = new SimpleRendererDefinition()
    {
      SymbolTemplate = SymbolFactory.Instance.ConstructLineSymbol(
          ColorFactory.Instance.BlueRGB, 2, SimpleLineStyle.Solid)
            .MakeSymbolReference()
    };
    streamLayer.SetRenderer(
         streamLayer.CreateRenderer(trackRenderer),
           FeatureRendererTarget.TrackLines);
  }
}

Requirements

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

ArcGIS Pro version: 3.0 or higher.

Reference

FeatureLayer Class
FeatureLayer Members
Overload List

Send feedback