Class Breaks Renderer

This sample demonstrates the dynamic layers functionality of the ArcGIS Runtime by overriding the default renderers for the Cities and States feature layers (originally defined within ArcGIS for Desktop) with new ClassBreaksRenderers defined via the ArcGIS Runtime client API. Crucially, this new rendering information is applied at the "server" level when rendering the map image. The user interface controls allow you to apply a new ClassBreaksRenderer to one feature layer at a time with the apppriate symbol type for the layer's geometry type being automatically used in each case. The Classification Method can also be selected from a list of enumeration values: Equal Interval; Natrual Breaks; Quantile; and Standard Deviation. The number of Class Breaks can be chosen from a drop down list. Each of these properties will be used when defining a new ClassBreaksDefinition to submit to the GenerateDataClassesTask. This task returns a new Renderer based on the supplied parameters.

XAML

<UserControl x:Class="ArcGISWPFSDK.DynamicLayersClassBreaksRenderer"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:esri="http://schemas.esri.com/arcgis/client/2009">
    <Grid>
        <Grid.Resources>
            <BooleanToVisibilityConverter x:Key="BooleanToVisibilityConverter"/>
            <LinearGradientBrush x:Key="PanelGradient" EndPoint="0.5,1" StartPoint="0.5,0">
                <LinearGradientBrush.RelativeTransform>
                    <TransformGroup>
                        <ScaleTransform CenterY="0.5" CenterX="0.5"/>
                        <SkewTransform CenterY="0.5" CenterX="0.5"/>
                        <RotateTransform Angle="176" CenterY="0.5" CenterX="0.5"/>
                        <TranslateTransform/>
                    </TransformGroup>
                </LinearGradientBrush.RelativeTransform>
                <GradientStop Color="#FF145787" Offset="0.16"/>
                <GradientStop Color="#FF3D7FAC" Offset="0.502"/>
                <GradientStop Color="#FF88C5EF" Offset="0.984"/>
            </LinearGradientBrush>
        </Grid.Resources>
        <esri:Map x:Name="_mapControl" Background="#FFE3E3E3">
        </esri:Map>
        <StackPanel Orientation="Vertical" Margin="10" HorizontalAlignment="Right" VerticalAlignment="Top">
            <Grid x:Name="DynamicLayersUiGrid" HorizontalAlignment="Right" VerticalAlignment="Top" Margin="0,5,5,0" Width="170">
                <Rectangle Fill="{StaticResource PanelGradient}" Stroke="Gray" Margin="0,0,0,5">
                    <Rectangle.Effect>
                        <DropShadowEffect/>
                    </Rectangle.Effect>
                </Rectangle>
                <StackPanel Orientation="Vertical" VerticalAlignment="Top">
                    <Canvas Margin="5,5,5,5" Height="240">
                        <Rectangle Height="235" Width="160" RadiusX="5" RadiusY="5" Fill="#DDFFFFFF" Stroke="DarkGray"/>
                        <StackPanel>
                            <TextBlock Text="Layer:" Margin="5,5,5,5"/>
                            <RadioButton x:Name="_citiesRadioButton" Checked="radioButton_Checked" Margin="10,0,10,5">
                                Cities (Population 2000)
                            </RadioButton>
                            <RadioButton x:Name="_statesRadioButton" Checked="radioButton_Checked" Margin="10,0,10,5" >
                                States (Population 2000)</RadioButton>
                            <TextBlock Text="Classification Method:" Margin="5,5,5,5"/>
                            <ComboBox x:Name="classificationMethodComboBox" SelectedIndex="0" Margin="0,0,5,5" Width="145">
                                <ComboBoxItem>EqualInterval</ComboBoxItem>
                                <ComboBoxItem>NaturalBreaks</ComboBoxItem>
                                <ComboBoxItem>Quantile</ComboBoxItem>
                                <ComboBoxItem>StandardDeviation</ComboBoxItem>
                            </ComboBox>
                            <TextBlock Text="Number of Class Breaks:" Margin="5,5,5,5"/>
                            <ComboBox x:Name="classBreaksComboBox" Height="20" Width="145" Margin="0,0,5,5" HorizontalContentAlignment="Right">
                                <ComboBoxItem>2</ComboBoxItem>
                                <ComboBoxItem>3</ComboBoxItem>
                                <ComboBoxItem>4</ComboBoxItem>
                                <ComboBoxItem IsSelected="True">5</ComboBoxItem>
                                <ComboBoxItem>6</ComboBoxItem>
                                <ComboBoxItem>7</ComboBoxItem>
                                <ComboBoxItem>8</ComboBoxItem>
                                <ComboBoxItem>9</ComboBoxItem>
                            </ComboBox>
                            <Button x:Name="ChangeRendererButton" Content="Change Renderer" 
                            Margin="5,5,10,5" Width="150" Click="ChangeRendererButton_Click"/>
                            <Button x:Name="ResetSelectedRendererButton" Content="Reset Selected Renderer"
                                Margin="5,0,10,10" Width="150" Click="ResetSelectedRendererButton_Click" />
                        </StackPanel>
                    </Canvas>
                </StackPanel>
            </Grid>
        </StackPanel>
        <ProgressBar x:Name="MyProgressBar" IsIndeterminate="True" VerticalAlignment="Bottom" Width="200" Height="20" Margin="10" Visibility="{Binding Path=IsBusy, Converter={StaticResource BooleanToVisibilityConverter}}"></ProgressBar>
    </Grid>
</UserControl>

C#

using System;
using System.Collections.Generic;
using System.Linq;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Media;
using ESRI.ArcGIS.Client.Local;
using ESRI.ArcGIS.Client;
using ESRI.ArcGIS.Client.Tasks;
using System.ComponentModel;

namespace ArcGISWPFSDK
{
    public partial class DynamicLayersClassBreaksRenderer : UserControl, INotifyPropertyChanged
    {
        public event PropertyChangedEventHandler PropertyChanged;

        private bool _isBusy = true;

        public bool IsBusy
        {
            get
            {
                return _isBusy;
            }
            set
            {
                _isBusy = value;

                if (PropertyChanged != null)
                {

                    PropertyChanged(this, new PropertyChangedEventArgs("IsBusy"));
                }
            }
        }
    
        // Member variable for the dynamic map service layer
        ArcGISLocalDynamicMapServiceLayer _arcGISLocalDynamicMapServiceLayer;

        // Member variable for the random number generator to create symbol sizes, line widths, etc.
        Random _random = new Random();

        // Member variable representing the LayerDrawingOptions definition for the selected layer.
        LayerDrawingOptions _layerDrawingOptions;

        // LayerInfo representing the selected layer.
        LayerInfo _selectedLayerInfo;

        public DynamicLayersClassBreaksRenderer()
        {
            InitializeComponent();

            // Disable the UI Grid until the ArcGISDynamicMapServiceLayer has initialized.
            DynamicLayersUiGrid.IsEnabled = false;

            // Create a new local map service from an MPK and enable the Dynamic Layers capability
            LocalMapService localMapService = new LocalMapService()
            {
                Path = @"..\Data\DynamicLayers\USA.mpk",
                EnableDynamicLayers = true
            };

            // Start the local map service
            localMapService.StartAsync((mapService) =>
            {
                // Once the LocalMapServce has started create a new local dynamic map service layer based on the local map service 
                _arcGISLocalDynamicMapServiceLayer = new ArcGISLocalDynamicMapServiceLayer(localMapService)
                {
                    ID = "_arcGISLocalDynamicMapServiceLayer",
                    ImageFormat = ArcGISDynamicMapServiceLayer.RestImageFormat.PNG32,
                };

                // Set up an event handler for the layer initialized event
                _arcGISLocalDynamicMapServiceLayer.Initialized += (s, e) =>
                {
                    //Enable the UI once the layer has initialized
                    DynamicLayersUiGrid.IsEnabled = true;
                    _citiesRadioButton.IsChecked = true;
                    DataContext = this;
                    IsBusy = false;
                };

                // Add the layer to the map
                _mapControl.Layers.Add(_arcGISLocalDynamicMapServiceLayer);

            });
        }

        private void ChangeRendererButton_Click(object sender, RoutedEventArgs e)
        {
            // If there is already an instance of the LayerDrawOptions definition remove it from the layer's LayerDrawingOptions collection.
            if (_layerDrawingOptions != null)
                ResetRenderer(_layerDrawingOptions, false);

            // Create a new Layer Drawing Options object which will define the new renderer for a specific layer in the underlying local map service
            _layerDrawingOptions = new LayerDrawingOptions();

            // Set the ID of the map layer in the local map service
            _layerDrawingOptions.LayerID = _selectedLayerInfo.ID;

            // Get the selected Classification Method combo box item
            System.Windows.Controls.ComboBoxItem selectedItem =
                (System.Windows.Controls.ComboBoxItem)classificationMethodComboBox.SelectedItem;

            // Get the ClassificationMethod enumeration type from the selected ComboBoxItem
            ClassificationMethod classificationMethod = (ClassificationMethod)Enum.Parse(typeof(ClassificationMethod), selectedItem.Content.ToString());

            // Create a new GenerateDataClassesTask to generate a new ClassBreaksRenderer based on the supplied ClassBreaksDefinition.
            var generateDataClassesTask = new GenerateRendererTask(_arcGISLocalDynamicMapServiceLayer.Url + "/" + _selectedLayerInfo.ID);

            // Build the GenerateDataClassesParameters to submit to the GenerateDataClassesTask
            var generateDataClassesParameters = new GenerateRendererParameters
            {
                // Create a ClassBreaksDefinition to create a ClassBreaksRenderer
                ClassificationDefinition = new ClassBreaksDefinition
                {
                    BreakCount = Convert.ToInt32(((ComboBoxItem)classBreaksComboBox.SelectedValue).Content),
                    ClassificationField = "POP2000",
                    ClassificationMethod = classificationMethod,
                    ColorRamps = new System.Collections.ObjectModel.ObservableCollection<ColorRamp>()
                    {
                        new ColorRamp()
                        {

                        Algorithm = Algorithm.LabLChAlgorithm,
                        From = Colors.Yellow,
                        To = Colors.Red
                        }
                    },
                }
            };

            // Call the synchronous Execute method on the GenerateDataClassesTask 
            GenerateRendererResult generateDataClassesResult = generateDataClassesTask.Execute(generateDataClassesParameters);

            // Set the Renderer property on the LayerDrawingOptions
            _layerDrawingOptions.Renderer = generateDataClassesResult.Renderer as ClassBreaksRenderer;

            // Create a new layer drawing options collection and set the layer drawing options property on the local dynamic map service layer
            _arcGISLocalDynamicMapServiceLayer.LayerDrawingOptions = new LayerDrawingOptionsCollection() { _layerDrawingOptions };

            // Refresh the layer
            _arcGISLocalDynamicMapServiceLayer.Refresh();
        }

        private void radioButton_Checked(object sender, RoutedEventArgs e)
        {
            // Get the selected RadioButton
            RadioButton li = (sender as RadioButton);

            // Set the class member LayerInfo based on the selected radio button
            switch (li.Name)
            {
                case "_citiesRadioButton":
                    _selectedLayerInfo = _arcGISLocalDynamicMapServiceLayer.Layers.First(l => l.Name == "Cities");
                    break;
                case "_statesRadioButton":
                    _selectedLayerInfo = _arcGISLocalDynamicMapServiceLayer.Layers.First(l => l.Name == "States");
                    break;
            }
        }

        public void ResetRenderer(LayerDrawingOptions layerDrawingOptions, bool refreshMap)
        {
            // Exit if the layer has no LayerDrawingOptions
            if (_arcGISLocalDynamicMapServiceLayer.LayerDrawingOptions == null || _arcGISLocalDynamicMapServiceLayer.LayerDrawingOptions.Count == 0)
                return;

            // Remove the LayerDrawingOptions from the layer's LayerDrawingOptions collection
            if (_arcGISLocalDynamicMapServiceLayer.LayerDrawingOptions.Contains(layerDrawingOptions))
            {
                _arcGISLocalDynamicMapServiceLayer.LayerDrawingOptions.Remove(layerDrawingOptions);

                if (refreshMap)
                    _arcGISLocalDynamicMapServiceLayer.Refresh();
            }
        }

        private void ResetSelectedRendererButton_Click(object sender, RoutedEventArgs e)
        {
            // Remove the selected LayerDrawOptions definition from the layer's LayerDrawingOptions collection and refresh the map.
            ResetRenderer(_layerDrawingOptions, true);
        }
    }
}

VB.NET

Imports System.Collections.Generic
Imports System.Linq
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Media
Imports ESRI.ArcGIS.Client.Local
Imports ESRI.ArcGIS.Client
Imports ESRI.ArcGIS.Client.Tasks
Imports System.ComponentModel

Namespace ArcGISWPFSDK
    Partial Public Class DynamicLayersClassBreaksRenderer
        Inherits UserControl
        Implements INotifyPropertyChanged

        Public Event PropertyChanged As PropertyChangedEventHandler Implements INotifyPropertyChanged.PropertyChanged

        Private _isBusy As Boolean = True

        Public Property IsBusy() As Boolean
            Get
                Return _isBusy
            End Get
            Set(value As Boolean)
                _isBusy = value

                RaiseEvent PropertyChanged(Me, New PropertyChangedEventArgs("IsBusy"))
            End Set
        End Property
        ' Member variable for the dynamic map service layer
        Private _arcGISLocalDynamicMapServiceLayer As ArcGISLocalDynamicMapServiceLayer

        ' Member variable for the random number generator to create symbol sizes, line widths, etc.
        Private _random As New Random()

        ' Member variable representing the LayerDrawingOptions definition for the selected layer.
        Private _layerDrawingOptions As LayerDrawingOptions

        ' LayerInfo representing the selected layer.
        Private _selectedLayerInfo As LayerInfo

        Public Sub New()
            InitializeComponent()

            ' Disable the UI Grid until the ArcGISDynamicMapServiceLayer has initialized.
            DynamicLayersUiGrid.IsEnabled = False

            ' Create a new local map service from an MPK and enable the Dynamic Layers capability
            Dim localMapService As New LocalMapService() With {
            .Path = "..\Data\DynamicLayers\USA.mpk",
            .EnableDynamicLayers = True}

            ' Start the local map service
            localMapService.StartAsync(Function(mapService)
                                           ' Once the LocalMapServce has started create a new local dynamic map service layer based on the local map service 
                                           _arcGISLocalDynamicMapServiceLayer = New ArcGISLocalDynamicMapServiceLayer(localMapService) With { _
                                           .ID = "_arcGISLocalDynamicMapServiceLayer", _
                                           .ImageFormat = ArcGISDynamicMapServiceLayer.RestImageFormat.PNG32 _
                                           }

                                           ' Set up an event handler for the layer initialized event
                                           AddHandler _arcGISLocalDynamicMapServiceLayer.Initialized, AddressOf localDynamicMapServiceLayerInitialized

                                           ' Add the layer to the map

                                           _mapControl.Layers.Add(_arcGISLocalDynamicMapServiceLayer)

                                       End Function)
        End Sub

        Private Sub localDynamicMapServiceLayerInitialized(sender As Object, e As EventArgs)

            'Enable the UI once the layer has initialized
            DynamicLayersUiGrid.IsEnabled = True
            _citiesRadioButton.IsChecked = True
            DataContext = Me
            IsBusy = False
        End Sub

        Private Sub ChangeRendererButton_Click(sender As Object, e As RoutedEventArgs)
            ' If there is already an instance of the LayerDrawOptions definition remove it from the layer's LayerDrawingOptions collection.
            If _layerDrawingOptions IsNot Nothing Then
                ResetRenderer(_layerDrawingOptions, False)
            End If

            ' Create a new Layer Drawing Options object which will define the new renderer for a specific layer in the underlying local map service
            _layerDrawingOptions = New LayerDrawingOptions()

            ' Set the ID of the map layer in the local map service
            _layerDrawingOptions.LayerID = _selectedLayerInfo.ID

            ' Get the selected Classification Method combo box item
            Dim selectedItem As System.Windows.Controls.ComboBoxItem = DirectCast(classificationMethodComboBox.SelectedItem, System.Windows.Controls.ComboBoxItem)

            ' Get the ClassificationMethod enumeration type from the selected ComboBoxItem
            Dim classificationMethod As ClassificationMethod = CType([Enum].Parse(GetType(ClassificationMethod), selectedItem.Content.ToString()), ClassificationMethod)

            ' Create a new GenerateDataClassesTask to generate a new ClassBreaksRenderer based on the supplied ClassBreaksDefinition.
            Dim generateDataClassesTask As New GenerateRendererTask(_arcGISLocalDynamicMapServiceLayer.Url & "/" & _selectedLayerInfo.ID)

            ' Build the GenerateDataClassesParameters to submit to the GenerateDataClassesTask
            ' Create a ClassBreaksDefinition to create a ClassBreaksRenderer

            Dim generateDataClassesParameters As New GenerateRendererParameters() With { _
              .ClassificationDefinition = New ClassBreaksDefinition() With { _
               .BreakCount = Convert.ToInt32(DirectCast(classBreaksComboBox.SelectedValue, ComboBoxItem).Content), _
               .ClassificationField = "POP2000", _
               .ClassificationMethod = classificationMethod, _
               .ColorRamps = New System.Collections.ObjectModel.ObservableCollection(Of ColorRamp)() From { _
               New ColorRamp() With { _
                 .Algorithm = Algorithm.LabLChAlgorithm, _
                 .From = Colors.Yellow, _
                 .[To] = Colors.Red _
               }
              }
             }
            }

            ' Call the synchronous Execute method on the GenerateDataClassesTask 
            Dim generateDataClassesResult As GenerateRendererResult = generateDataClassesTask.Execute(generateDataClassesParameters)

            ' Set the Renderer property on the LayerDrawingOptions
            _layerDrawingOptions.Renderer = TryCast(generateDataClassesResult.Renderer, ClassBreaksRenderer)

            ' Create a new layer drawing options collection and set the layer drawing options property on the local dynamic map service layer
            _arcGISLocalDynamicMapServiceLayer.LayerDrawingOptions = New LayerDrawingOptionsCollection() From { _
             _layerDrawingOptions _
            }

            ' Refresh the layer
            _arcGISLocalDynamicMapServiceLayer.Refresh()
        End Sub

        Private Sub radioButton_Checked(sender As Object, e As RoutedEventArgs)
            ' Get the selected RadioButton
            Dim li As RadioButton = TryCast(sender, RadioButton)

            ' Set the class member LayerInfo based on the selected radio button
            Select Case li.Name
                Case "_citiesRadioButton"
                    _selectedLayerInfo = _arcGISLocalDynamicMapServiceLayer.Layers.First(Function(l) l.Name = "Cities")
                    Exit Select
                Case "_statesRadioButton"
                    _selectedLayerInfo = _arcGISLocalDynamicMapServiceLayer.Layers.First(Function(l) l.Name = "States")
                    Exit Select
            End Select
        End Sub

        Public Sub ResetRenderer(layerDrawingOptions As LayerDrawingOptions, refreshMap As Boolean)
            ' Exit if the layer has no LayerDrawingOptions
            If _arcGISLocalDynamicMapServiceLayer.LayerDrawingOptions Is Nothing OrElse _arcGISLocalDynamicMapServiceLayer.LayerDrawingOptions.Count = 0 Then
                Return
            End If

            ' Remove the LayerDrawingOptions from the layer's LayerDrawingOptions collection
            If _arcGISLocalDynamicMapServiceLayer.LayerDrawingOptions.Contains(layerDrawingOptions) Then
                _arcGISLocalDynamicMapServiceLayer.LayerDrawingOptions.Remove(layerDrawingOptions)

                If refreshMap Then
                    _arcGISLocalDynamicMapServiceLayer.Refresh()
                End If
            End If
        End Sub

        Private Sub ResetSelectedRendererButton_Click(sender As Object, e As RoutedEventArgs)
            ' Remove the selected LayerDrawOptions definition from the layer's LayerDrawingOptions collection and refresh the map.
            ResetRenderer(_layerDrawingOptions, True)
        End Sub
    End Class
End Namespace