Table of Contents

Class ColorAxis

Namespace
HelixToolkit.Wpf
Assembly
HelixToolkit.Wpf.dll

The base class for color axes.

[TemplatePart(Name = "PART_Canvas", Type = typeof(Canvas))]
public abstract class ColorAxis : Control, IAnimatable, ISupportInitialize, IFrameworkInputElement, IInputElement, IQueryAmbient
Inheritance
ColorAxis
Implements
Derived
Inherited Members
Extension Methods

Constructors

ColorAxis()

Initializes a new instance of the ColorAxis class.

protected ColorAxis()

Fields

BarWidthProperty

Identifies the BarWidth dependency property.

public static readonly DependencyProperty BarWidthProperty

Field Value

DependencyProperty

ColorSchemeProperty

Identifies the ColorScheme dependency property.

public static readonly DependencyProperty ColorSchemeProperty

Field Value

DependencyProperty

FlipColorSchemeProperty

Identifies the FlipColorScheme dependency property.

public static readonly DependencyProperty FlipColorSchemeProperty

Field Value

DependencyProperty

PositionProperty

Identifies the Position dependency property.

public static readonly DependencyProperty PositionProperty

Field Value

DependencyProperty

TextMarginProperty

Identifies the TextMargin dependency property.

public static readonly DependencyProperty TextMarginProperty

Field Value

DependencyProperty

TickLengthProperty

Identifies the TickLength dependency property.

public static readonly DependencyProperty TickLengthProperty

Field Value

DependencyProperty

Properties

BarWidth

Gets or sets the width of the color bar rectangle.

public double BarWidth { get; set; }

Property Value

double

The width.

Canvas

Gets the canvas.

protected Canvas? Canvas { get; }

Property Value

Canvas

ColorArea

Gets the color rectangle area.

protected Rect ColorArea { get; }

Property Value

Rect

ColorScheme

Gets or sets the color scheme.

public Brush ColorScheme { get; set; }

Property Value

Brush

The color scheme.

FlipColorScheme

Gets or sets the color scheme direction, if true inverts the color normal color brush direction.

public bool FlipColorScheme { get; set; }

Property Value

bool

A boolean indicating inverted color direction when true.

Position

Gets or sets the position.

public ColorAxisPosition Position { get; set; }

Property Value

ColorAxisPosition

The position.

TextMargin

Gets or sets the text margin.

public double TextMargin { get; set; }

Property Value

double

The text margin.

TickLength

Gets or sets the length of the tick.

public double TickLength { get; set; }

Property Value

double

The length of the tick.

Methods

AddVisuals()

Adds the visuals.

protected virtual void AddVisuals()

GetTickLabels()

Gets the tick labels.

protected abstract IEnumerable<string> GetTickLabels()

Returns

IEnumerable<string>

The labels.

MeasureOverride(Size)

Measures the child elements of a Canvas in anticipation of arranging them during the ArrangeOverride(Size) pass.

protected override Size MeasureOverride(Size constraint)

Parameters

constraint Size

An upper limit Size that should not be exceeded.

Returns

Size

A Size that represents the size that is required to arrange child content.

OnApplyTemplate()

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

public override void OnApplyTemplate()

PropertyChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Handles changes in properties.

protected static void PropertyChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)

Parameters

d DependencyObject

The sender.

e DependencyPropertyChangedEventArgs

The DependencyPropertyChangedEventArgs instance containing the event data.

UpdateVisuals()

Updates the visuals.

protected void UpdateVisuals()