Class GraphicScale

Base class for the radial and linear scales.

Inheritance

System.Object

ScaleBase

GraphicScale

LinearScale

RadialScale

Inherited Members

ScaleBase.CustomItemsProperty

ScaleBase.CustomItemTemplateProperty

ScaleBase.CustomItemTemplateSelectorProperty

ScaleBase.MaxProperty

ScaleBase.MinProperty

ScaleBase.MultiplierProperty

ScaleBase.RangesProperty

ScaleBase.RangeTemplateProperty

ScaleBase.PositionObject(DependencyObject)

ScaleBase.ResizeObject(DependencyObject)

ScaleBase.ResetTheme()

ScaleBase.OnCreateAutomationPeer()

ScaleBase.CalculateCellSize()

ScaleBase.GetContainerForItemOverride()

ScaleBase.IsItemItsOwnContainerOverride(Object)

ScaleBase.GetObjectPosition(FrameworkElement, ScaleObjectLocation, GaugeMeasure, Double)

ScaleBase.CellSize

ScaleBase.CustomItems

ScaleBase.CustomItemTemplate

ScaleBase.CustomItemTemplateSelector

ScaleBase.Indicators

ScaleBase.Max

ScaleBase.Min

ScaleBase.Multiplier

ScaleBase.Ranges

ScaleBase.RangeTemplate

ScaleBase.DefaultRangeGroup

Namespace: Telerik.Windows.Controls.Gauge

Assembly: Telerik.Windows.Controls.DataVisualization.dll

Syntax

public abstract class GraphicScale : ScaleBase, IThemable

Constructors

GraphicScale()

Initializes a new instance of the GraphicScale class.

Declaration

protected GraphicScale()

Fields

MajorTickRelativeHeightProperty

Identifies the MajorTickRelativeHeight dependency property.

Declaration

public static readonly DependencyProperty MajorTickRelativeHeightProperty

Field Value

System.Windows.DependencyProperty

MajorTickRelativeWidthProperty

Identifies the MajorTickRelativeWidth dependency property.

Declaration

public static readonly DependencyProperty MajorTickRelativeWidthProperty

Field Value

System.Windows.DependencyProperty

MajorTickStrokeThicknessProperty

Identifies the MajorTickStrokeThickness dependency property.

Declaration

public static readonly DependencyProperty MajorTickStrokeThicknessProperty

Field Value

System.Windows.DependencyProperty

MajorTickTooltipFormatProperty

Identifies the MajorTickTooltipFormat dependency property.

Declaration

public static readonly DependencyProperty MajorTickTooltipFormatProperty

Field Value

System.Windows.DependencyProperty

MajorTickToolTipTemplateProperty

Identifies the MajorTickToolTipTemplate dependency property.

Declaration

public static readonly DependencyProperty MajorTickToolTipTemplateProperty

Field Value

System.Windows.DependencyProperty

MajorTickUseRangeColorProperty

Identifies the MajorTickUseRangeColor dependency property.

Declaration

public static readonly DependencyProperty MajorTickUseRangeColorProperty

Field Value

System.Windows.DependencyProperty

MiddleTickRelativeHeightProperty

Identifies the MiddleTickRelativeHeight dependency property.

Declaration

public static readonly DependencyProperty MiddleTickRelativeHeightProperty

Field Value

System.Windows.DependencyProperty

MiddleTickRelativeWidthProperty

Identifies the MiddleTickRelativeWidth dependency property.

Declaration

public static readonly DependencyProperty MiddleTickRelativeWidthProperty

Field Value

System.Windows.DependencyProperty

MiddleTickStrokeThicknessProperty

Identifies the MiddleTickStrokeThickness dependency property.

Declaration

public static readonly DependencyProperty MiddleTickStrokeThicknessProperty

Field Value

System.Windows.DependencyProperty

MiddleTickTooltipFormatProperty

Identifies the MiddleTickTooltipFormat dependency property.

Declaration

public static readonly DependencyProperty MiddleTickTooltipFormatProperty

Field Value

System.Windows.DependencyProperty

MiddleTickToolTipStyleProperty

Identifies the MiddleTickToolTipStyle dependency property.

Declaration

public static readonly DependencyProperty MiddleTickToolTipStyleProperty

Field Value

System.Windows.DependencyProperty

MiddleTickToolTipTemplateProperty

Identifies the MiddleTickToolTipTemplate dependency property.

Declaration

public static readonly DependencyProperty MiddleTickToolTipTemplateProperty

Field Value

System.Windows.DependencyProperty

MiddleTickUseRangeColorProperty

Identifies the MiddleTickUseRangeColor dependency property.

Declaration

public static readonly DependencyProperty MiddleTickUseRangeColorProperty

Field Value

System.Windows.DependencyProperty

MinorTickRelativeHeightProperty

Identifies the MinorTickRelativeHeight dependency property.

Declaration

public static readonly DependencyProperty MinorTickRelativeHeightProperty

Field Value

System.Windows.DependencyProperty

MinorTickRelativeWidthProperty

Identifies the MinorTickRelativeWidth dependency property.

Declaration

public static readonly DependencyProperty MinorTickRelativeWidthProperty

Field Value

System.Windows.DependencyProperty

MinorTickStrokeThicknessProperty

Identifies the MinorTickStrokeThickness dependency property.

Declaration

public static readonly DependencyProperty MinorTickStrokeThicknessProperty

Field Value

System.Windows.DependencyProperty

MinorTickTooltipFormatProperty

Identifies the MinorTickTooltipFormat dependency property.

Declaration

public static readonly DependencyProperty MinorTickTooltipFormatProperty

Field Value

System.Windows.DependencyProperty

MinorTickToolTipTemplateProperty

Identifies the MinorTickToolTipTemplate dependency property.

Declaration

public static readonly DependencyProperty MinorTickToolTipTemplateProperty

Field Value

System.Windows.DependencyProperty

MinorTickUseRangeColorProperty

Identifies the MinorTickUseRangeColor dependency property.

Declaration

public static readonly DependencyProperty MinorTickUseRangeColorProperty

Field Value

System.Windows.DependencyProperty

Properties

The format string can use properties of the scale objects. For example "{Value|F2} Range: Min={Range.Min|F2} Max={Range.Max|F2}". This format string uses value of the indicator and Min and Max properties of the gauge range this indicator is pointing to. Currently you can use Range and Scale objects in the format string. The '|' character is used to separate property name and its output format.

LabelToolTipStyle

Gets or sets the style applied to the toolTip of the label.

Declaration

public Style LabelToolTipStyle { get; set; }

Property Value

System.Windows.Style

LabelToolTipTemplate

Gets or sets the template of the label tooltip.

Declaration

public DataTemplate LabelToolTipTemplate { get; set; }

Property Value

System.Windows.DataTemplate

LabelUseRangeColor

Gets or sets value which indicates whether the tick label will use range color as its background.

Declaration

[SRCategory("Scale")]
public bool LabelUseRangeColor { get; set; }

Property Value

System.Boolean

MajorTickBackground

Gets or sets the major tick background.

Declaration

[SRCategory("Scale")]
public Brush MajorTickBackground { get; set; }

Property Value

System.Windows.Media.Brush

MajorTickList

Gets or sets a list of doubles which specify positions of the major ticks.

Declaration

[SRCategory("Scale")]
public IEnumerable<double> MajorTickList { get; set; }

Property Value

System.Collections.Generic.IEnumerable<System.Double>

MajorTickLocation

Gets or sets location of the major tick.

Declaration

[SRCategory("Scale")]
public ScaleObjectLocation MajorTickLocation { get; set; }

Property Value

ScaleObjectLocation

MajorTickOffset

Gets or sets offset the major tick.

Declaration

[SRCategory("Scale")]
public GaugeMeasure MajorTickOffset { get; set; }

Property Value

GaugeMeasure

MajorTickRelativeHeight

Gets or sets the relative height of the major tick.

Declaration

[SRCategory("Scale")]
public GaugeMeasure MajorTickRelativeHeight { get; set; }

Property Value

GaugeMeasure

MajorTickRelativeWidth

Gets or sets the relative width of the major tick.

Declaration

[SRCategory("Scale")]
public GaugeMeasure MajorTickRelativeWidth { get; set; }

Property Value

GaugeMeasure

MajorTicks

Gets or sets number of the major ticks along the scale.

Declaration

[SRCategory("Scale")]
public int MajorTicks { get; set; }

Property Value

System.Int32

MajorTicksCount

Calculate number of the major tick marks using this.MajorTicks, this.MajorTickStep and this.ShowLastLabel property.

Declaration

protected int MajorTicksCount { get; }

Property Value

System.Int32

MajorTickStep

Gets or sets the interval between major ticks.

Declaration

[SRCategory("Scale")]
public double MajorTickStep { get; set; }

Property Value

System.Double

MajorTickStroke

Gets or sets the major tick stroke.

Declaration

[SRCategory("Scale")]
public Brush MajorTickStroke { get; set; }

Property Value

System.Windows.Media.Brush

MajorTickStrokeThickness

Gets or sets the major tick stroke thickness.

Declaration

[SRCategory("Scale")]
public double MajorTickStrokeThickness { get; set; }

Property Value

System.Double

MajorTickTemplate

Gets or sets the major tick data template.

Declaration

[SRCategory("Scale")]
public DataTemplate MajorTickTemplate { get; set; }

Property Value

System.Windows.DataTemplate

MajorTickTooltipFormat

Gets or sets format of the major tick mark tooltip.

Declaration

public string MajorTickTooltipFormat { get; set; }

Property Value

System.String

Remarks

MajorTickToolTipStyle

Gets or sets the style applied to the toolTip of the major tick mark.

Declaration

public Style MajorTickToolTipStyle { get; set; }

Property Value

System.Windows.Style

MajorTickToolTipTemplate

Gets or sets the template of the major tick mark tooltip.

Declaration

public DataTemplate MajorTickToolTipTemplate { get; set; }

Property Value

System.Windows.DataTemplate

MajorTickUseRangeColor

Gets or sets value which indicates whether the major tick will use range color as its background.

Declaration

[SRCategory("Scale")]
public bool MajorTickUseRangeColor { get; set; }

Property Value

System.Boolean

MiddleTickBackground

Gets or sets the background of the middle tick.

Declaration

[SRCategory("Scale")]
public Brush MiddleTickBackground { get; set; }

Property Value

System.Windows.Media.Brush

MiddleTickLocation

Gets or sets location of the middle tick.

Declaration

[SRCategory("Scale")]
public ScaleObjectLocation MiddleTickLocation { get; set; }

Property Value

ScaleObjectLocation

MiddleTickOffset

Gets or sets offset of the middle tick.

Declaration

[SRCategory("Scale")]
public GaugeMeasure MiddleTickOffset { get; set; }

Property Value

GaugeMeasure

MiddleTickRelativeHeight

Gets or sets the relative height of the middle tick.

Declaration

[SRCategory("Scale")]
public GaugeMeasure MiddleTickRelativeHeight { get; set; }

Property Value

GaugeMeasure

MiddleTickRelativeWidth

Gets or sets the relative width of the middle tick.

Declaration

[SRCategory("Scale")]
public GaugeMeasure MiddleTickRelativeWidth { get; set; }

Property Value

GaugeMeasure

MiddleTicks

Gets or sets number of the middle ticks per one major tick.

Declaration

[SRCategory("Scale")]
public int MiddleTicks { get; set; }

Property Value

System.Int32

MiddleTickStroke

Gets or sets stroke of the middle tick.

Declaration

[SRCategory("Scale")]
public Brush MiddleTickStroke { get; set; }

Property Value

System.Windows.Media.Brush

MiddleTickStrokeThickness

Gets or sets stroke thickness of the middle tick.

Declaration

[SRCategory("Scale")]
public double MiddleTickStrokeThickness { get; set; }

Property Value

System.Double

MiddleTickTemplate

Gets or sets the data template of the middle tick.

Declaration

[SRCategory("Scale")]
public DataTemplate MiddleTickTemplate { get; set; }

Property Value

System.Windows.DataTemplate

MiddleTickTooltipFormat

Gets or sets format of the middle tick mark tooltip.

Declaration

public string MiddleTickTooltipFormat { get; set; }

Property Value

System.String

Remarks

MiddleTickToolTipStyle

Gets or sets the style applied to the toolTip of the middle tick mark.

Declaration

public Style MiddleTickToolTipStyle { get; set; }

Property Value

System.Windows.Style

MiddleTickToolTipTemplate

Gets or sets template of the middle tick mark tooltip.

Declaration

public DataTemplate MiddleTickToolTipTemplate { get; set; }

Property Value

System.Windows.DataTemplate

MiddleTickUseRangeColor

Gets or sets value which indicates whether the middle tick will use the range color as its background.

Declaration

[SRCategory("Scale")]
public bool MiddleTickUseRangeColor { get; set; }

Property Value

System.Boolean

MinorTickBackground

Gets or sets the background of the minor tick.

Declaration

[SRCategory("Scale")]
public Brush MinorTickBackground { get; set; }

Property Value

System.Windows.Media.Brush

MinorTickLocation

Gets or sets the location of the minor tick.

Declaration

[SRCategory("Scale")]
public ScaleObjectLocation MinorTickLocation { get; set; }

Property Value

ScaleObjectLocation

MinorTickOffset

Gets or sets offset of the minor tick.

Declaration

[SRCategory("Scale")]
public GaugeMeasure MinorTickOffset { get; set; }

Property Value

GaugeMeasure

MinorTickRelativeHeight

Gets or sets the relative height of the minor tick.

Declaration

[SRCategory("Scale")]
public GaugeMeasure MinorTickRelativeHeight { get; set; }

Property Value

GaugeMeasure

MinorTickRelativeWidth

Gets or sets the relative width of the minor tick.

Declaration

[SRCategory("Scale")]
public GaugeMeasure MinorTickRelativeWidth { get; set; }

Property Value

GaugeMeasure

MinorTicks

Gets or sets number of the minor ticks per one middle tick.

Declaration

[SRCategory("Scale")]
public int MinorTicks { get; set; }

Property Value

System.Int32

MinorTickStroke

Gets or sets stroke of the minor tick.

Declaration

[SRCategory("Scale")]
public Brush MinorTickStroke { get; set; }

Property Value

System.Windows.Media.Brush

MinorTickStrokeThickness

Gets or sets stroke thickness of the minor tick.

Declaration

[SRCategory("Scale")]
public double MinorTickStrokeThickness { get; set; }

Property Value

System.Double

MinorTickTemplate

Gets or sets the data template of the minor tick.

Declaration

[SRCategory("Scale")]
public DataTemplate MinorTickTemplate { get; set; }

Property Value

System.Windows.DataTemplate

MinorTickTooltipFormat

Gets or sets the format of the minor tick mark tooltip.

Declaration

public string MinorTickTooltipFormat { get; set; }

Property Value

System.String

Remarks

MinorTickToolTipStyle

Gets or sets the style applied to the toolTip of the minor tick mark.

Declaration

public Style MinorTickToolTipStyle { get; set; }

Property Value

System.Windows.Style

MinorTickToolTipTemplate

Gets or sets template of the minor tick mark tooltip.

Declaration

public DataTemplate MinorTickToolTipTemplate { get; set; }

Property Value

System.Windows.DataTemplate

MinorTickUseRangeColor

Gets or sets value which indicates whether the minor tick will use range color as its background.

Declaration

[SRCategory("Scale")]
public bool MinorTickUseRangeColor { get; set; }

Property Value

System.Boolean

RangeLocation

Gets or sets the default range location.

Declaration

[SRCategory("Scale")]
public ScaleObjectLocation RangeLocation { get; set; }

Property Value

ScaleObjectLocation

RangeOffset

Gets or sets default range offset.

Declaration

[SRCategory("Scale")]
public GaugeMeasure RangeOffset { get; set; }

Property Value

GaugeMeasure

ShowFirstLabel

Gets or sets value that indicates whether the first tick and its label should be shown.

Declaration

[SRCategory("Scale")]
public bool ShowFirstLabel { get; set; }

Property Value

System.Boolean

ShowLastLabel

Gets or sets value that indicates whether the last tick and its label should be shown.

Declaration

[SRCategory("Scale")]
public bool ShowLastLabel { get; set; }

Property Value

System.Boolean

StartTickOffset

Gets or sets the offset of the first major tick on the scale from scale's minimal value.

Declaration

[SRCategory("Scale")]
public double StartTickOffset { get; set; }

Property Value

System.Double

StartValue

Value at the first major tick mark on the scale.

Declaration

protected double StartValue { get; set; }

Property Value

System.Double

StartWidth

Gets or sets the start width of the scale bar.

Declaration

[SRCategory("Layout")]
public double StartWidth { get; set; }

Property Value

System.Double

Stroke

Gets or sets the Brush that specifies how the scale bar outline is painted.

Declaration

[SRCategory("Layout")]
public Brush Stroke { get; set; }

Property Value

System.Windows.Media.Brush

StrokeThickness

Gets or sets gets or sets stroke thickness of the scale bar.

Declaration

[SRCategory("Layout")]
public double StrokeThickness { get; set; }

Property Value

System.Double

TickRangeGroup

Gets or sets range group which will be used with tick list.

Declaration

public GaugeRangeGroup TickRangeGroup { get; set; }

Property Value

GaugeRangeGroup

UseTickList

Returns true when the MajorTickList property should be used.

Declaration

protected bool UseTickList { get; }

Property Value

System.Boolean

UseTickSteps

Returns true when the MajorTickStep property should be used.

Declaration

protected bool UseTickSteps { get; }

Property Value

System.Boolean

Methods

ArrangeOverride(Size)

Called to arrange and size the content of a scale.

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 size of the scale.

Overrides

ScaleBase.ArrangeOverride(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.

Overrides

ScaleBase.ClearContainerForItemOverride(DependencyObject, Object)

GetValueByPoint(Point)

Gets the value which corresponds to the point on scale.

Declaration

public abstract double GetValueByPoint(Point point)

Parameters

System.Windows.Point point

Point on the scale to get value for.

Returns

System.Double

Double value corresponds to the given point.

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

protected override Size MeasureOverride(Size availableSize)

Parameters

System.Windows.Size availableSize

The maximum size that the method can return.

Returns

System.Windows.Size

The size of the control, up to the maximum specified by constraint.

Overrides

ScaleBase.MeasureOverride(Size)

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()

Overrides

ScaleBase.OnApplyTemplate()

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.

PresenterSizeChanged(Object, SizeChangedEventArgs)

Occurs when size of the content presenter is changed.

Declaration

protected override void PresenterSizeChanged(object sender, SizeChangedEventArgs e)

Parameters

System.Object sender

Sender.

System.Windows.SizeChangedEventArgs e

Event args.

Overrides

ScaleBase.PresenterSizeChanged(Object, SizeChangedEventArgs)

ScaleObjectChanged(FrameworkElement)

Notifies that the element is changed.

Declaration

protected override void ScaleObjectChanged(FrameworkElement element)

Parameters

System.Windows.FrameworkElement element

Element.

Overrides

ScaleBase.ScaleObjectChanged(FrameworkElement)

UpdateScaleBar()

Update geometry of the scale bar.

Declaration

protected abstract void UpdateScaleBar()

UpdateTicksAndLabels()

Update tick and label lists.

Declaration

protected override void UpdateTicksAndLabels()

Overrides

ScaleBase.UpdateTicksAndLabels()

Extension Methods

CollectionExtensions.ToEnumerable<T>(T)

EnumerableExtensions.ToEnumerable<T>(T)