Class Interpolator
Abstract base class for Interpolator converters.
Inheritance
Inherited Members
Namespace: System.Windows.Controls.DataVisualization
Assembly: Controls.DataVisualization.OpenSilver.dll
Syntax
public abstract class Interpolator : FrameworkElement
Remarks
An Interpolator is used to project a value from a source range [ActualDataMinimum, ActualDataMaximum] to a target range [From, To]. The source range can be specified directly by setting the DataMinimum and/or DataMaximum properties, or indirectly by setting DataRangeBinding. When the DataRangeBinding property is set,the TreeMap will evaluate the binding for the entire tree, calculating the minimum and maximum values automatically. The custom target range and the actual interpolation logic is defined by sub-classes of this abstract class.
Constructors
| Improve this Doc View SourceInterpolator()
Initializes a new instance of the Interpolator class.
Declaration
protected Interpolator()
Fields
| Improve this Doc View SourceDataMaximumProperty
Identifies the DataMaximum dependency property.
Declaration
public static readonly DependencyProperty DataMaximumProperty
Field Value
Type | Description |
---|---|
DependencyProperty |
DataMinimumProperty
Identifies the DataMinimum dependency property.
Declaration
public static readonly DependencyProperty DataMinimumProperty
Field Value
Type | Description |
---|---|
DependencyProperty |
Properties
| Improve this Doc View SourceActualDataMaximum
Gets the value representing the maximal value in the data set. It is automatically from the data set by using the DataRangeBinding property if DataMaximum is not set. If it is set, DataMaximum is returned.
Declaration
public double ActualDataMaximum { get; }
Property Value
Type | Description |
---|---|
System.Double |
ActualDataMinimum
Gets the value representing the minimal value in the data set. It is automatically from the data set by using the DataRangeBinding property if DataMinimum is not set. If it is set, DataMinimum is returned.
Declaration
public double ActualDataMinimum { get; }
Property Value
Type | Description |
---|---|
System.Double |
DataMaximum
Gets or sets a value representing the fixed maximum value across the entire set. If the value is not set directly or is NaN, the ActualDataMinimum will be calculated automatically from the data set by using the DataRangeBinding property.
Declaration
public double DataMaximum { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
DataMinimum
Gets or sets a value representing the fixed minimum value across the entire set. If the value is not set directly or is NaN, the ActualDataMaximum will be calculated automatically from the data set by using the DataRangeBinding property.
Declaration
public double DataMinimum { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
DataRangeBinding
Gets or sets a binding to a property which will be examined to retrieve the minimum and maximum range values across the entire data set. If this value is null then the DataMinimum and DataMaximum values need be set manually.
Declaration
public Binding DataRangeBinding { get; set; }
Property Value
Type | Description |
---|---|
Binding |
InterpolationMode
Gets or sets a value telling to which tree nodes the interpolation should be applied to. LeafNodesOnly by default.
Declaration
public InterpolationMode InterpolationMode { get; set; }
Property Value
Type | Description |
---|---|
InterpolationMode |
TargetName
Gets or sets a value representing the x:Name of the element to which the interpolated value will be applied.
Declaration
public string TargetName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
TargetProperty
Gets or sets a value representing the path to a property which will receive the interpolated value.
Declaration
public string TargetProperty { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Methods
| Improve this Doc View SourceInterpolate(Double)
Called to interpolate the value of the given object between the DataMinimum and DataMaximum extremes, and to project it in a specific [From, To] range defined. The target range (and therefore the implementation of this method) is defined in a specific sub-class.
Declaration
public abstract object Interpolate(double value)
Parameters
Type | Name | Description |
---|---|---|
System.Double | value | Value to interpolate. |
Returns
Type | Description |
---|---|
System.Object | An interpolated value. |