Class ColorMeasureScale

Class that calculates the range collection for the further use in Map Legend. ShapeFill, Min, Max, Mode and properties corresponding to the mode should be determined here.

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

Syntax

public class ColorMeasureScale : DependencyObject, IMapShapeColorizer

Constructors

ColorMeasureScale()

Initializes a new instance of the ColorMeasureScale class.

Declaration
public ColorMeasureScale()

Fields

ExtendedPropertyNameProperty

DependencyProperty for ExtendedPropertyName value.

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

HighlightFillCollectionProperty

DependencyProperty for HighlightFillCollection property.

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

MaxValueProperty

DependencyProperty for Max value.

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

MinValueProperty

DependencyProperty for Min value.

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

ModeProperty

DependencyProperty for Mode value.

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

RangeDistributionProperty

DependencyProperty for IRangeDistribution value.

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

ShapeFillCollectionProperty

DependencyProperty for ShapeFillCollection property.

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

TickMarkCountProperty

DependencyProperty for TickMarkCount value.

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

TickMarkStepProperty

DependencyProperty for TickMarkStep value.

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

Properties

ExtendedPropertyName

Gets or sets the extended property name.

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

Implements

HighlightFillCollection

Gets the collection of MapShapeFill instances for the shapes highlighting.

Declaration
public MapShapeFillCollection HighlightFillCollection { get; }
Property Value
MapShapeFillCollection

IsPrepared

Gets or sets value which indicates whether colorizer have been prepared already.

Declaration
public bool IsPrepared { get; set; }
Property Value
System.Boolean

Implements

MaxValue

Gets or sets the value of Max for the whole MapRangeCollection.

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

MinValue

Gets or sets the value of Min for the whole MapRangeCollection.

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

Mode

Gets or sets ColorScaleMode.

Declaration
public ColorScaleMode Mode { get; set; }
Property Value
ColorScaleMode

RangeCollection

Readonly property to get MapRangeCollection.

Declaration
public MapRangeCollection RangeCollection { get; }
Property Value
MapRangeCollection

RangeDistribution

Gets or sets ranges distribution. This property specify class which creates range distribution. It makes sense when "Count" mode is used for ColorMeasureScale.

Declaration
public IRangeDistribution RangeDistribution { get; set; }
Property Value
IRangeDistribution

ResetOnItemsChanged

Gets or sets value which indicates whether colorizer should be re-prepared when items collection of the information layer is changed.

Declaration
public bool ResetOnItemsChanged { get; set; }
Property Value
System.Boolean

Implements

ShapeFillCollection

Gets the collection of MapShapeFill instances for the shapes coloring.

Declaration
public MapShapeFillCollection ShapeFillCollection { get; }
Property Value
MapShapeFillCollection

TickMarkCount

Gets or sets the number of tick marks.

Declaration
public int TickMarkCount { get; set; }
Property Value
System.Int32

TickMarkStep

Gets or sets the number of steps.

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

UsageMode

Gets colorizer usage mode.

Declaration
public ColorizerUsageMode UsageMode { get; }
Property Value
ColorizerUsageMode

Implements

Methods

Colorize(IEnumerable<Object>)

Colorize elements from the list.

Declaration
public void Colorize(IEnumerable<object> shapes)
Parameters
System.Collections.Generic.IEnumerable<System.Object> shapes

The shape list.
Implements

GetColorByValue(Double)

Returns MapShapeFill from MapRangeCollection corresponding the value.

Declaration
public MapShapeFill GetColorByValue(double value)
Parameters
System.Double value

Value.
Returns
MapShapeFill

MapShapeFill instance corresponding value.

OnPrepareCompleted(ShapeColorizerEventArgs)

Raises the PrepareCompleted event.

Declaration
protected virtual void OnPrepareCompleted(ShapeColorizerEventArgs args)
Parameters
ShapeColorizerEventArgs args

The ShapeColorizerEventArgs instance containing the event data.

OnUpdateLegend()

Raises the UpdateLegend event.

Declaration
protected virtual void OnUpdateLegend()

Prepare(IEnumerable<Object>)

Prepares the instance of the ColorMeasureScale class using the shape list.

Declaration
public void Prepare(IEnumerable<object> shapes)
Parameters
System.Collections.Generic.IEnumerable<System.Object> shapes

The shape list.
Implements

SetColor(IExtendedData)

Sets color to item by extended data.

Declaration
public void SetColor(IExtendedData item)
Parameters
IExtendedData item

Item of IExtendedData type.
Implements

SetColorByExtendedData(IEnumerable<Object>, String)

Colors shapes according to specified property from extended data.

Declaration
public void SetColorByExtendedData(IEnumerable<object> shapes, string propertyName)
Parameters
System.Collections.Generic.IEnumerable<System.Object> shapes

Shapes collection.
System.String propertyName

Name of property from extended data (should have numeric type).

SetColorByExtendedData(IEnumerable<Object>, String, Boolean)

Colors shapes according to specified property from extended data.

Declaration
public void SetColorByExtendedData(IEnumerable<object> shapes, string propertyName, bool autoRange)
Parameters
System.Collections.Generic.IEnumerable<System.Object> shapes

Shapes collection.
System.String propertyName

Name of property from extended data (should have numeric type).
System.Boolean autoRange

If set to true automatically calculates the scale range.

SetColorCallback(ColorMeasureScale.SetColorDelegate)

Set callback that colors the framework element. If the parameter is null, then built-in callback will be used.

Declaration
public void SetColorCallback(ColorMeasureScale.SetColorDelegate colorCallback)
Parameters
ColorMeasureScale.SetColorDelegate colorCallback

Delegate method.

SetScaleRangeByExtendedData(IEnumerable<Object>, String)

Specifies Min and Max value according to extended data of shapes.

Declaration
public void SetScaleRangeByExtendedData(IEnumerable<object> shapes, string propertyName)
Parameters
System.Collections.Generic.IEnumerable<System.Object> shapes

Shapes.
System.String propertyName

Property name.

Events

PrepareCompleted

The Prepare completed event handler.

Declaration
public event EventHandler<ShapeColorizerEventArgs> PrepareCompleted
Event Type
System.EventHandler<ShapeColorizerEventArgs>

Implements

UpdateLegend

The update legend event handler. Occurs when the instance is changed and the map legend should be updated.

Declaration
public event EventHandler UpdateLegend
Event Type
System.EventHandler

Implements

Extension Methods