MapLine.StartLineCap Property

Returns MapLine start cap settings.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v24.1.dll

NuGet Package: DevExpress.Win.Map

Declaration

C#

public MapLineCap StartLineCap { get; }

VB.NET

Public ReadOnly Property StartLineCap As MapLineCap

Property Value

Type	Description
MapLineCap	Contains MapLine start cap settings.

Remarks

Use the StartLineCap property to display a shape at the beginning of a map line. The default cap shape is an arrow. Set the Visible property to true to display the arrow:

C#

MapLine line = new MapLine() { Point1 = new GeoPoint(-3, -10),
                               Point2 = new GeoPoint(0, 0), 
                               StrokeWidth = 2, 
                               Stroke = System.Drawing.Color.Blue };
mapItemStorage1.Items.Add(line);                              
line.StartLineCap.Visible = true;

VB.NET

Dim line As MapLine = New MapLine() With {
    .Point1 = New GeoPoint(-3, -10),
    .Point2 = New GeoPoint(0, 0),
    .StrokeWidth = 2,
    .Stroke = Drawing.Color.Blue
}
mapItemStorage1.Items.Add(line)
line.StartLineCap.Visible = True

Result:

To display a custom shape, set the MapLineCap.Template property to a MapUnit array that defines a cap template.

Use the MapLineCap.Width and MapLineCap.Length properties to specify dimensions of the default arrow or a custom shape.

The following example defines the start cap template and its dimensions:

C#

MapLine line = new MapLine() { Point1 = new GeoPoint(-3, -10),
                               Point2 = new GeoPoint(0, 0), 
                               StrokeWidth = 2, 
                               Stroke = System.Drawing.Color.Blue };
mapItemStorage1.Items.Add(line);                               
line.StartLineCap.Visible = true;
line.StartLineCap.Length = 30;
line.StartLineCap.Width = 22;
line.StartLineCap.Template = new MapUnit[] { new MapUnit(0, 0),
                                           new MapUnit(-0.5, -0.5),
                                           new MapUnit(0.25, 0),
                                           new MapUnit(-0.5, 0.5),
                                           new MapUnit(0, 0),
};

VB.NET

Dim line As MapLine = New MapLine() With {
                            .Point1 = New GeoPoint(-3, -10),
                            .Point2 = New GeoPoint(0, 0),
                            .StrokeWidth = 2,
                            .Stroke = Drawing.Color.Blue
}
mapItemStorage1.Items.Add(line)
line.StartLineCap.Visible = True
line.StartLineCap.Length = 30
line.StartLineCap.Width = 22
line.StartLineCap.Template = New MapUnit() {New MapUnit(0, 0), 
                                          New MapUnit(-0.5, -0.5), 
                                          New MapUnit(0.25, 0), 
                                          New MapUnit(-0.5, 0.5), 
                                          New MapUnit(0, 0)}

Result:

The MapLineCap.IsFilled property specifies whether the cap shape is filled:

C#

line.StartLineCap.IsFilled = false;

VB.NET

line.StartLineCap.IsFilled = False

When map lines are created based on data source values, use the following API members to map data source fields to start cap properties:

• MapLineStartCapIsFilledMapping
• MapLineStartCapLengthMapping
• MapLineStartCapTemplateMapping
• MapLineStartCapVisibleMapping
• MapLineStartCapWidthMapping

For more examples on MapLine cap property mappings, see the demo:

Run Demo: Map Arrows