Class
MapLegend

Control which show map legend. It is designed to be used in conjunction with ColorMeasureScale colorizer.

Definition

Namespace:Telerik.Windows.Controls.Map

Assembly:Telerik.Windows.Controls.DataVisualization.dll

Syntax:

cs-api-definition
public class MapLegend : HeaderedItemsControl

Inheritance: objectMapLegend

Constructors

MapLegend()

Initializes a new instance of the MapLegend class.

Declaration

cs-api-definition
public MapLegend()

Fields

FormatProperty

Identifies the Format dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty FormatProperty

Field Value

DependencyProperty

LabelLayoutProperty

Identifies the LabelLayout dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty LabelLayoutProperty

Field Value

DependencyProperty

LabelLocationProperty

Identifies the LabelLocation dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty LabelLocationProperty

Field Value

DependencyProperty

LayerProperty

Identifies the Layer dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty LayerProperty

Field Value

DependencyProperty

MarkerRadiusXProperty

Identifies the MarkerRadiusX dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty MarkerRadiusXProperty

Field Value

DependencyProperty

MarkerRadiusYProperty

Identifies the MarkerRadiusY dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty MarkerRadiusYProperty

Field Value

DependencyProperty

MarkerSizeProperty

Identifies the MarkerSize dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty MarkerSizeProperty

Field Value

DependencyProperty

MarkerSpacingProperty

Identifies the MarkerSpacing dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty MarkerSpacingProperty

Field Value

DependencyProperty

MeasureScaleProperty

Identifies the MeasureScale dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty MeasureScaleProperty

Field Value

DependencyProperty

OrientationProperty

Identifies the Orientation dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty OrientationProperty

Field Value

DependencyProperty

Properties

Format

Gets or sets string Format property for the Min an Max output.

Declaration

cs-api-definition
public string Format { get; set; }

Property Value

string

LabelLayout

Gets or sets the layout of the label.

Declaration

cs-api-definition
public LabelLayoutMode LabelLayout { get; set; }

Property Value

LabelLayoutMode

LabelLocation

Gets or sets the location of the Label.

Declaration

cs-api-definition
public LabelLocationMode LabelLocation { get; set; }

Property Value

LabelLocationMode

Layer

Gets or sets the information layer for the legend.

Declaration

cs-api-definition
public ILayer Layer { get; set; }

Property Value

ILayer

MarkerRadiusX

Gets or sets the corner radius X value for the marker shape.

Declaration

cs-api-definition
public double MarkerRadiusX { get; set; }

Property Value

double

MarkerRadiusY

Gets or sets the corner radius Y value for the marker shape.

Declaration

cs-api-definition
public double MarkerRadiusY { get; set; }

Property Value

double

MarkerSize

Gets or sets the size of the marker shape.

Declaration

cs-api-definition
public Size MarkerSize { get; set; }

Property Value

Size

MarkerSpacing

Gets or sets the spacing between marker shapes.

Declaration

cs-api-definition
public double MarkerSpacing { get; set; }

Property Value

double

MeasureScale

Gets or sets the MeasureScale instance.

Declaration

cs-api-definition
public ColorMeasureScale MeasureScale { get; set; }

Property Value

ColorMeasureScale

Orientation

Gets or sets the orientation of the control.

Declaration

cs-api-definition
public Orientation Orientation { get; set; }

Property Value

Orientation

Methods

ArrangeOverride(Size)

Called to arrange and size the content.

Declaration

cs-api-definition
protected override Size ArrangeOverride(Size finalSize)

Parameters

finalSize

Size

The computed size that is used to arrange the content.

Returns

Size

The calculated size.

ClearContainerForItemOverride(DependencyObject, object)

Undoes the effects of the PrepareContainerForItemOverride method.

Declaration

cs-api-definition
protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameters

element

DependencyObject

The container element.

item

object

The item.

GetContainerForItemOverride()

Returns new ContentPresenter object.

Declaration

cs-api-definition
protected override DependencyObject GetContainerForItemOverride()

Returns

DependencyObject

ContentPresenter object.

IsItemItsOwnContainerOverride(object)

Determines if the specified item is (or is eligible to be) its own container.

Declaration

cs-api-definition
protected override bool IsItemItsOwnContainerOverride(object item)

Parameters

item

object

The item to check.

Returns

bool

True if the item is (or is eligible to be) its own container; otherwise, false.

MeasureOverride(Size)

When overridden in a derived class, measures the size in layout required for child elements and determines a size for the FrameworkElement-derived class.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")]
protected override Size MeasureOverride(Size availableSize)

Parameters

availableSize

Size

The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.

Returns

Size

The size that this element determines it needs during layout, based on its calculations of child element sizes.

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate.

Declaration

cs-api-definition
public override void OnApplyTemplate()

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

PrepareContainerForItemOverride(DependencyObject, object)

Prepares object for the container.

Declaration

cs-api-definition
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters

element

DependencyObject

Element.

item

object

Item.

Refresh()

Refreshes the legend.

Declaration

cs-api-definition
public void Refresh()

Refresh(IMapShapeColorizer)

Refreshes the legend using the colorizer object.

Declaration

cs-api-definition
public void Refresh(IMapShapeColorizer colorizer)

Parameters

colorizer

IMapShapeColorizer

The IMapShapeColorizer instance.