New to Telerik UI for WPF? Start a free 30-day trial

MapLegend

Class

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:

public class MapLegend : HeaderedItemsControl

Inheritance: objectMapLegend

Constructors

MapLegend()

Initializes a new instance of the MapLegend class.

public MapLegend()

Fields

FormatProperty

DependencyProperty

Identifies the Format dependency property.

public static readonly DependencyProperty FormatProperty

LabelLayoutProperty

DependencyProperty

Identifies the LabelLayout dependency property.

public static readonly DependencyProperty LabelLayoutProperty

LabelLocationProperty

DependencyProperty

Identifies the LabelLocation dependency property.

public static readonly DependencyProperty LabelLocationProperty

LayerProperty

DependencyProperty

Identifies the Layer dependency property.

public static readonly DependencyProperty LayerProperty

MarkerRadiusXProperty

DependencyProperty

Identifies the MarkerRadiusX dependency property.

public static readonly DependencyProperty MarkerRadiusXProperty

MarkerRadiusYProperty

DependencyProperty

Identifies the MarkerRadiusY dependency property.

public static readonly DependencyProperty MarkerRadiusYProperty

MarkerSizeProperty

DependencyProperty

Identifies the MarkerSize dependency property.

public static readonly DependencyProperty MarkerSizeProperty

MarkerSpacingProperty

DependencyProperty

Identifies the MarkerSpacing dependency property.

public static readonly DependencyProperty MarkerSpacingProperty

MeasureScaleProperty

DependencyProperty

Identifies the MeasureScale dependency property.

public static readonly DependencyProperty MeasureScaleProperty

OrientationProperty

DependencyProperty

Identifies the Orientation dependency property.

public static readonly DependencyProperty OrientationProperty

Properties

Format

string

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

public string Format { get; set; }

LabelLayout

LabelLayoutMode

Gets or sets the layout of the label.

public LabelLayoutMode LabelLayout { get; set; }

LabelLocation

LabelLocationMode

Gets or sets the location of the Label.

public LabelLocationMode LabelLocation { get; set; }

Layer

ILayer

Gets or sets the information layer for the legend.

public ILayer Layer { get; set; }

MarkerRadiusX

double

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

public double MarkerRadiusX { get; set; }

MarkerRadiusY

double

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

public double MarkerRadiusY { get; set; }

MarkerSize

Size

Gets or sets the size of the marker shape.

public Size MarkerSize { get; set; }

MarkerSpacing

double

Gets or sets the spacing between marker shapes.

public double MarkerSpacing { get; set; }

MeasureScale

ColorMeasureScale

Gets or sets the MeasureScale instance.

public ColorMeasureScale MeasureScale { get; set; }

Orientation

Gets or sets the orientation of the control.

public Orientation Orientation { get; set; }

Methods

ArrangeOverride(Size)

Called to arrange and size the content.

protected override Size ArrangeOverride(Size finalSize)

Parameters:finalSizeSize

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.

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameters:elementDependencyObject

The container element.

itemobject

The item.

GetContainerForItemOverride()

Returns new ContentPresenter object.

protected override DependencyObject GetContainerForItemOverride()

Returns:

DependencyObject

ContentPresenter object.

IsItemItsOwnContainerOverride(object)

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

protected override bool IsItemItsOwnContainerOverride(object item)

Parameters:itemobject

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.

protected override Size MeasureOverride(Size availableSize)

Parameters:availableSizeSize

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.

public override void OnApplyTemplate()

OnInitialized(EventArgs)

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

protected override void OnInitialized(EventArgs e)

Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

PrepareContainerForItemOverride(DependencyObject, object)

Prepares object for the container.

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters:elementDependencyObject

Element.

itemobject

Item.

Refresh()

Refreshes the legend.

public void Refresh()

Refresh(IMapShapeColorizer)

Refreshes the legend using the colorizer object.

public void Refresh(IMapShapeColorizer colorizer)

Parameters:colorizerIMapShapeColorizer

The IMapShapeColorizer instance.