AttributeItemKeyProvider Class

This class is used to provide an MapItem objects argument value as a key for the KeyColorColorizer to colorize these items.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v24.1.dll

NuGet Package: DevExpress.Win.Map

Declaration

C#

public class AttributeItemKeyProvider :
    NamedAttributeProviderBase,
    IColorizerItemKeyProvider

VB.NET

Public Class AttributeItemKeyProvider
    Inherits NamedAttributeProviderBase
    Implements IColorizerItemKeyProvider

Example

To colorize the map using a key-color colorizer, do the following.

• Create a KeyColorColorizer object.
• Specify its KeyColorColorizer.Colors collection or its PredefinedColorsColorizer.PredefinedColorSchema property value.
• Specify its KeyColorColorizer.Keys collection (optionally).
• Assign this object to the VectorItemsLayer.Colorizer property.

Form1.cs

    // Create a vector layer and add it to the map.
    VectorItemsLayer hotelLayer = new VectorItemsLayer() {
        Data = CreateData(),
        Colorizer = CreateColorizer()
    };
    map.Layers.Add(hotelLayer);
// Creates a key color colorizer.
private MapColorizer CreateColorizer() {
    KeyColorColorizer colorizer = new KeyColorColorizer() {
        ItemKeyProvider = new AttributeItemKeyProvider() { AttributeName = "CATEGORY" },
        PredefinedColorSchema = PredefinedColorSchema.Palette
    };

    colorizer.Keys.Add(new ColorizerKeyItem() { Key = 1, Name = "Restaurant" });
    colorizer.Keys.Add(new ColorizerKeyItem() { Key = 2, Name = "Business room" });
    colorizer.Keys.Add(new ColorizerKeyItem() { Key = 3, Name = "Bathroom" });
    colorizer.Keys.Add(new ColorizerKeyItem() { Key = 4, Name = "Living room" });
    colorizer.Keys.Add(new ColorizerKeyItem() { Key = 5, Name = "Other" });
    colorizer.Keys.Add(new ColorizerKeyItem() { Key = 6, Name = "Service room" });
    colorizer.Keys.Add(new ColorizerKeyItem() { Key = 7, Name = "Pool" });
    colorizer.Keys.Add(new ColorizerKeyItem() { Key = 8, Name = "Gym" });

    return colorizer;
}

Form1.vb

    ' Create a vector layer and add it to the map.
    Dim hotelLayer As New VectorItemsLayer() With {.Data = CreateData(), .Colorizer = CreateColorizer()}
    map.Layers.Add(hotelLayer)
' Creates a key color colorizer.
Private Function CreateColorizer() As MapColorizer
    Dim colorizer As New KeyColorColorizer() With {.ItemKeyProvider = New AttributeItemKeyProvider() With {.AttributeName = "CATEGORY"}, .PredefinedColorSchema = PredefinedColorSchema.Palette}

    colorizer.Keys.Add(New ColorizerKeyItem() With {.Key = 1, .Name = "Restaurant"})
    colorizer.Keys.Add(New ColorizerKeyItem() With {.Key = 2, .Name = "Business room"})
    colorizer.Keys.Add(New ColorizerKeyItem() With {.Key = 3, .Name = "Bathroom"})
    colorizer.Keys.Add(New ColorizerKeyItem() With {.Key = 4, .Name = "Living room"})
    colorizer.Keys.Add(New ColorizerKeyItem() With {.Key = 5, .Name = "Other"})
    colorizer.Keys.Add(New ColorizerKeyItem() With {.Key = 6, .Name = "Service room"})
    colorizer.Keys.Add(New ColorizerKeyItem() With {.Key = 7, .Name = "Pool"})
    colorizer.Keys.Add(New ColorizerKeyItem() With {.Key = 8, .Name = "Gym"})

    Return colorizer
End Function

Inheritance

Object

NamedAttributeProviderBase

AttributeItemKeyProvider