ArgumentItemKeyProvider Class

This class is used to provide an argument value of map chart items as a key for the KeyColorColorizer to colorize these items.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v18.1.dll

Declaration

C#

public class ArgumentItemKeyProvider :
    IColorizerItemKeyProvider

VB.NET

Public Class ArgumentItemKeyProvider
    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.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-colorize-a-cartesian-map-using-a-key-color-colorizer-t176227

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ArgumentItemKeyProvider class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-customize-map-pie-parameters-t202713/CS/MapPieExample/Form1.cs#L28

Colorizer = new KeyColorColorizer() {
    ItemKeyProvider = new ArgumentItemKeyProvider(),
    PredefinedColorSchema = PredefinedColorSchema.Palette

how-to-manually-add-mapbubble-items-to-the-map-t116230/CS/MapBubbleItem/Form1.cs#L74

// Load color indexes from bubbles via the 'Color' attribute
colorizer.ItemKeyProvider = new ArgumentItemKeyProvider();

how-to-manually-add-mappie-items-to-the-map-t116241/CS/MapPieItem/Form1.cs#L54

// Load color indexes from bubbles via the 'Color' attribute
colorizer.ItemKeyProvider = new ArgumentItemKeyProvider();

how-to-use-piechartdataadapter-to-add-pie-charts-to-a-map-t141324/CS/WinForms_MapControl_PieChartDataAdapter/Form1.cs#L64

KeyColorColorizer colorizer = new KeyColorColorizer() {
    ItemKeyProvider = new ArgumentItemKeyProvider()
};

VB.NET

how-to-customize-map-pie-parameters-t202713/VB/MapPieExample/Form1.vb#L24

mapControl1.Layers.Add(New VectorItemsLayer() With { _
    .Data = storage, .Colorizer = New KeyColorColorizer() With {.ItemKeyProvider = New ArgumentItemKeyProvider(), .PredefinedColorSchema = PredefinedColorSchema.Palette} _
})

how-to-manually-add-mapbubble-items-to-the-map-t116230/VB/MapBubbleItem/Form1.vb#L52

' Load color indexes from bubbles via the 'Color' attribute
colorizer.ItemKeyProvider = New ArgumentItemKeyProvider()

how-to-manually-add-mappie-items-to-the-map-t116241/VB/MapPieItem/Form1.vb#L53

' Load color indexes from bubbles via the 'Color' attribute
colorizer.ItemKeyProvider = New ArgumentItemKeyProvider()

how-to-use-piechartdataadapter-to-add-pie-charts-to-a-map-t141324/VB/WinForms_MapControl_PieChartDataAdapter/Form1.vb#L64

Private Function CreateColorizer() As MapColorizer
    Dim colorizer As New KeyColorColorizer() With {.ItemKeyProvider = New ArgumentItemKeyProvider()}

Inheritance

Object

ArgumentItemKeyProvider