Class MapLegend

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

Inheritance
System.Object
MapLegend
Namespace: Telerik.Windows.Controls.Map
Assembly: Telerik.Windows.Controls.DataVisualization.dll

Syntax

public class MapLegend : HeaderedItemsControl

Constructors

MapLegend()

Initializes a new instance of the MapLegend class.

Declaration
public MapLegend()

Fields

FormatProperty

Identifies the Format dependency property.

Declaration
public static readonly DependencyProperty FormatProperty
Field Value
System.Windows.DependencyProperty

LabelLayoutProperty

Identifies the LabelLayout dependency property.

Declaration
public static readonly DependencyProperty LabelLayoutProperty
Field Value
System.Windows.DependencyProperty

LabelLocationProperty

Identifies the LabelLocation dependency property.

Declaration
public static readonly DependencyProperty LabelLocationProperty
Field Value
System.Windows.DependencyProperty

LayerProperty

Identifies the Layer dependency property.

Declaration
public static readonly DependencyProperty LayerProperty
Field Value
System.Windows.DependencyProperty

MarkerRadiusXProperty

Identifies the MarkerRadiusX dependency property.

Declaration
public static readonly DependencyProperty MarkerRadiusXProperty
Field Value
System.Windows.DependencyProperty

MarkerRadiusYProperty

Identifies the MarkerRadiusY dependency property.

Declaration
public static readonly DependencyProperty MarkerRadiusYProperty
Field Value
System.Windows.DependencyProperty

MarkerSizeProperty

Identifies the MarkerSize dependency property.

Declaration
public static readonly DependencyProperty MarkerSizeProperty
Field Value
System.Windows.DependencyProperty

MarkerSpacingProperty

Identifies the MarkerSpacing dependency property.

Declaration
public static readonly DependencyProperty MarkerSpacingProperty
Field Value
System.Windows.DependencyProperty

MeasureScaleProperty

Identifies the MeasureScale dependency property.

Declaration
public static readonly DependencyProperty MeasureScaleProperty
Field Value
System.Windows.DependencyProperty

OrientationProperty

Identifies the Orientation dependency property.

Declaration
public static readonly DependencyProperty OrientationProperty
Field Value
System.Windows.DependencyProperty

Properties

Format

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

Declaration
public string Format { get; set; }
Property Value
System.String

LabelLayout

Gets or sets the layout of the label.

Declaration
public LabelLayoutMode LabelLayout { get; set; }
Property Value
LabelLayoutMode

LabelLocation

Gets or sets the location of the Label.

Declaration
public LabelLocationMode LabelLocation { get; set; }
Property Value
LabelLocationMode

Layer

Gets or sets the information layer for the legend.

Declaration
public ILayer Layer { get; set; }
Property Value
ILayer

MarkerRadiusX

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

Declaration
public double MarkerRadiusX { get; set; }
Property Value
System.Double

MarkerRadiusY

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

Declaration
public double MarkerRadiusY { get; set; }
Property Value
System.Double

MarkerSize

Gets or sets the size of the marker shape.

Declaration
public Size MarkerSize { get; set; }
Property Value
System.Windows.Size

MarkerSpacing

Gets or sets the spacing between marker shapes.

Declaration
public double MarkerSpacing { get; set; }
Property Value
System.Double

MeasureScale

Gets or sets the MeasureScale instance.

Declaration
public ColorMeasureScale MeasureScale { get; set; }
Property Value
ColorMeasureScale

Orientation

Gets or sets the orientation of the control.

Declaration
public Orientation Orientation { get; set; }
Property Value
System.Windows.Controls.Orientation

Methods

ArrangeOverride(Size)

Called to arrange and size the content.

Declaration
protected override Size ArrangeOverride(Size finalSize)
Parameters
System.Windows.Size finalSize

The computed size that is used to arrange the content.
Returns
System.Windows.Size

The calculated size.

ClearContainerForItemOverride(DependencyObject, Object)

Undoes the effects of the PrepareContainerForItemOverride method.

Declaration
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject element

The container element.
System.Object item

The item.

GetContainerForItemOverride()

Returns new ContentPresenter object.

Declaration
protected override DependencyObject GetContainerForItemOverride()
Returns
System.Windows.DependencyObject

ContentPresenter object.

IsItemItsOwnContainerOverride(Object)

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

Declaration
protected override bool IsItemItsOwnContainerOverride(object item)
Parameters
System.Object item

The item to check.
Returns
System.Boolean

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 System.Windows.FrameworkElement-derived class.

Declaration
protected override Size MeasureOverride(Size availableSize)
Parameters
System.Windows.Size availableSize

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
System.Windows.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
public override void OnApplyTemplate()

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.

PrepareContainerForItemOverride(DependencyObject, Object)

Prepares object for the container.

Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject element

Element.
System.Object item

Item.

Refresh()

Refreshes the legend.

Declaration
public void Refresh()

Refresh(IMapShapeColorizer)

Refreshes the legend using the colorizer object.

Declaration
public void Refresh(IMapShapeColorizer colorizer)
Parameters
IMapShapeColorizer colorizer

The IMapShapeColorizer instance.

Extension Methods