Click or drag to resize

HighLowSeriesBase Class

LightningChart .NET Help
HighLow series.
Inheritance Hierarchy
SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.WindowsFreezable
        Arction.Wpf.ChartingMVVMChartNode
          Arction.Wpf.ChartingMVVMUserInteractiveObjectInt
            Arction.Wpf.ChartingMVVMUserInteractiveObject
              Arction.Wpf.ChartingMVVMHighlightingItemBase
                Arction.Wpf.ChartingMVVM.SeriesXYSeriesBaseXY
                  Arction.Wpf.ChartingMVVM.SeriesXYPointLineSeriesBase
                    Arction.Wpf.ChartingMVVM.SeriesXYHighLowSeriesBase
                      Arction.Wpf.ChartingMVVM.SeriesXYAreaSeries
                      Arction.Wpf.ChartingMVVM.SeriesXYHighLowSeries

Namespace:  Arction.Wpf.ChartingMVVM.SeriesXY
Assembly:  Arction.Wpf.ChartingMVVM.LightningChart (in Arction.Wpf.ChartingMVVM.LightningChart.dll) Version: 10.3.1
Syntax
Copy
[SerializableAttribute]
[TypeConverterAttribute(typeof(GeneralTypeConverter))]
public class HighLowSeriesBase : PointLineSeriesBase, 
	ITrackable, IRealtimeShiftable, ISingleLineSeriesSolveResultReturningSeries

The HighLowSeriesBase type exposes the following members.

Constructors
  NameDescription
Public methodHighLowSeriesBase
Constructor.
Top
Properties
  NameDescription
Public propertyAllowUserInteraction
Gets or sets if user interaction is allowed. This is a dependency property.
(Inherited from UserInteractiveObject.)
Public propertyAntialias
Gets or sets if draw antialiased. This is a dependency property.
Public propertyAssignXAxisIndex
Gets or sets index of X axis assigned to this series. Give -1 when you don't want to assign it yet to any X axis. This is a dependency property.
(Inherited from SeriesBaseXY.)
Public propertyAssignYAxisIndex
Gets or sets index of Y axis assigned to this series. Give -1 when you don't want to assign it yet to any Y axis. This is a dependency property.
(Inherited from SeriesBaseXY.)
Public propertyCanFreeze
Gets a value that indicates whether the object can be made unmodifiable.
(Inherited from Freezable.)
Public propertyContinuousOverScaleBreak
Draws a connecting area over ExcludeRange gap, if this flag is set. This is a dependency property.
Public propertyCursorTrackEnabled
Gets or sets if cursor tracking is enabled. This is a dependency property.
Public propertyDataBreaking
Data breaking options. Defines, if gaps are enabled on series data and by which value. Default state is disabled and default gap value is Double.NaN;
(Inherited from PointLineSeriesBase.)
Public propertyDeceedColor
Gets or sets deceed fill. This is a dependency property.
Public propertyDeceedLimit
Gets or sets deceed limit (value "of below"). This is a dependency property.
Public propertyDependencyObjectType
Gets the DependencyObjectType that wraps the CLR type of this instance. 
(Inherited from DependencyObject.)
Public propertyDisableDragToAnotherAxis
Gets or sets if disable dragging from Y axis to another Y axis or from chart to another chart. This is a dependency property. Set this true if you want to zoom in the series area, and keep other user interactive device interactivity features available.
(Inherited from SeriesBaseXY.)
Public propertyDispatcher
Gets the Dispatcher this DispatcherObject is associated with.
(Inherited from DispatcherObject.)
Public propertyExceedColor
Gets or sets exceed color. This is a dependency property.
Public propertyExceedLimit
Gets or sets exceed limit. This is a dependency property.
Public propertyFill
Gets or sets normal fill. This is a dependency property.
Public propertyHighlight
Gets or sets highlight style. Item can be highlighted by user interactive device or by code. This is a dependency property.
(Inherited from HighlightingItemBase.)
Public propertyIncludeInAutoFit
Gets or sets if includes series values in automatic fit. This is a dependency property.
(Inherited from SeriesBaseXY.)
Public propertyIndividualPointColoring
Selects how to use the individual point colors. Sets which PointStyle color is replaced with PointColor.
Public propertyIsFrozen
Gets a value that indicates whether the object is currently modifiable.
(Inherited from Freezable.)
Public propertyIsSealed
Gets a value that indicates whether this instance is currently sealed (read-only).
(Inherited from DependencyObject.)
Public propertyLegendBoxIndex
Gets or sets legendbox index. This is a dependency property.
(Inherited from SeriesBaseXY.)
Public propertyLimitYToStackSegment
Gets or sets if limit Y draw range to segment area when y-axes are stacked. This is a dependency property.
(Inherited from SeriesBaseXY.)
Public propertyLineStyle
Gets or sets line style. This is a dependency property.
(Inherited from PointLineSeriesBase.)
Public propertyLineVisible
Gets or sets if line is visible or not. This is a dependency property.
(Inherited from PointLineSeriesBase.)
Public propertyOwnerView
Owner view.
(Inherited from SeriesBaseXY.)
Public propertyPointCount
Gets point count stored in the Points array. This is a dependency property.
(Inherited from PointLineSeriesBase.)
Public propertyPointsOptimization
Gets or sets points rendering optimization. This is a dependency property.
(Inherited from PointLineSeriesBase.)
Public propertyPointStyle
Gets or sets point style. This is a dependency property.
(Inherited from PointLineSeriesBase.)
Public propertyPointsVisible
Gets or sets are points visible or not. This is a dependency property.
(Inherited from PointLineSeriesBase.)
Public propertyScrollingStabilizing
Gets or sets if stabilize scrolling mode by rounding shifting to nearest integer pixel position. This is a dependency property. Reduces wobbling of the scrolling waveform, but may show as slight X-dimensional distortion.
Remarks
Only applies when XAxis ScrollMode = Scrolling
Public propertyScrollModePointsKeepLevel
Gets or sets how often the draw data is cleared when using X axis scroll mode. This is a dependency property. Valid range is 1...100 1 frees the draw data and the reconstucts the draw data after every 1/10 scroll page. Use this when there's not much memory available. 100 frees the draw data and the reconstucts the draw data after every 100/10 = 10 pages. Use this when smooth scroll with high FPS is important. Reserves some extra memory.
Public propertySeriesEventMarkers
Gets or sets series event markers. This is a dependency property.
(Inherited from PointLineSeriesBase.)
Public propertyShowInLegendBox
Gets or sets if enlists the series title text in Legend box of the chart. This is a dependency property.
(Inherited from SeriesBaseXY.)
Public propertySimpleHighlightColor
Gets or sets simple highlight color when user interactive device is over. This is a dependency property.
Public propertyStatistics
Gets statistics of the series. This is a dependency property.
(Inherited from PointLineSeriesBase.)
Public propertyTitle
Gets or sets series title. This is a dependency property.
(Inherited from PointLineSeriesBase.)
Public propertyUseLimits
Gets or sets if use limits. This is a dependency property.
Public propertyUsePalette
Gets or sets if use palette for line coloring. This is a dependency property.
(Inherited from PointLineSeriesBase.)
Public propertyValueRangePalette
Gets or sets color palette for Y value range. This is a dependency property.
(Inherited from PointLineSeriesBase.)
Public propertyVisible
Gets or sets series visible state. This is a dependency property.
(Inherited from SeriesBaseXY.)
Top
Methods
  NameDescription
Public methodClear
Clear the series data
(Inherited from PointLineSeriesBase.)
Public methodClearValue(DependencyProperty)
Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier.
(Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)
Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey.
(Inherited from DependencyObject.)
Public methodClone
Creates a modifiable clone of the Freezable, making deep copies of the object's values. When copying the object's dependency properties, this method copies expressions (which might no longer resolve) but not animations or their current values.
(Inherited from Freezable.)
Public methodCloneCurrentValue
Creates a modifiable clone (deep copy) of the Freezable using its current values.
(Inherited from Freezable.)
Public methodCoerceValue
Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.
(Inherited from DependencyObject.)
Public methodDeletePointsBeforeX
Delete points having smaller X value than given value
Public methodDispose
Release all resources used by this instance.
(Inherited from ChartNode.)
Public methodEquals
Determines whether a provided DependencyObject is equivalent to the current DependencyObject.
(Inherited from DependencyObject.)
Public methodFreeze
Makes the current object unmodifiable and sets its IsFrozen property to true.
(Inherited from Freezable.)
Public methodGetAsFrozen
Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference.
(Inherited from Freezable.)
Public methodGetClipAreas
Get clipping areas.
(Inherited from SeriesBaseXY.)
Public methodGetCurrentValueAsFrozen
Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference.
(Inherited from Freezable.)
Public methodGetHashCode
Gets a hash code for this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetLocalValueEnumerator
Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetMinMaxFromXRange
Get min and max Y value within given X range.
(Overrides PointLineSeriesBaseGetMinMaxFromXRange(Double, Double, Double, Double, Boolean).)
Public methodGetMinMaxFromXRangeIgnoreValue
This is similar to GetMinMaxFromXRange, but tailored for Series with DataBreaking. Get minimum and maximum Y value within given X range, but Ignore some values (gap defining value).
(Inherited from PointLineSeriesBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Returns the current effective value of a dependency property on this instance of a DependencyObject.
(Inherited from DependencyObject.)
Public methodGetXMinMax
Get minimum X and maximum X of series X values
(Overrides PointLineSeriesBaseGetXMinMax(Double, Double).)
Public methodInvalidateData
Invalidate data array. Statistics and draw data are recalculated.
(Overrides SeriesBaseXYInvalidateData.)
Public methodInvalidateProperty
Re-evaluates the effective value for the specified dependency property
(Inherited from DependencyObject.)
Public methodIsHighlighted
returns true if the object is highlighted.
(Inherited from HighlightingItemBase.)
Public methodIsPositionOver
Is position over series.
(Overrides PointLineSeriesBaseIsPositionOver(Int32, Int32, Boolean).)
Public methodLoadFromCSV
Loads series data from a CSV file.
(Inherited from SeriesBaseXY.)
Public methodReadLocalValue
Returns the local value of a dependency property, if it exists.
(Inherited from DependencyObject.)
Public methodRemoveHighlight
Removes forced highlighting.
(Inherited from HighlightingItemBase.)
Public methodSaveToCSV
Saves series data into CSV file
(Inherited from SeriesBaseXY.)
Public methodSetClipAreas
Set clipping areas. Give null to disable all clip areas.
(Inherited from SeriesBaseXY.)
Public methodSetCurrentValue
Sets the value of a dependency property without changing its value source.
(Inherited from DependencyObject.)
Public methodSetHighlight
Highlights the object.

This is a kind of "forced" highlight, and the object might be highlighted even if the highlighting type (defined by Highlight property) is set to None. How the highlighting happens, if any, depends on object. Most objects use the defined type by default, and fall back to Simple highlighting if None is set.

(Inherited from HighlightingItemBase.)
Public methodSetProperCursor
Set proper drag cursor. Default is hand.
(Inherited from PointLineSeriesBase.)
Public methodSetValue(DependencyProperty, Object)
Sets the local value of a dependency property, specified by its dependency property identifier.
(Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)
Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property.
(Inherited from DependencyObject.)
Public methodSolveYCoordAtXCoord
Find nearest series point of given X-coordinate and get corresponding Y-coordinate.
Public methodSolveYValueAtXValue
Solve y-value or range on given x-value.
Public methodToString
Item to string.
(Inherited from SeriesBaseXY.)
Top
Events
  NameDescription
Public eventBeforeSeriesRendering
Occurs just before the rendering of the series takes place.
(Inherited from SeriesBaseXY.)
Public eventChanged
Occurs when the Freezable or an object it contains is modified.
(Inherited from Freezable.)
Public eventCustomLinePointColoringAndShaping
Custom line coloring and line coordinates event. Event handler must give color for each data point received in the handler. The coordinates can be adjusted as well and new line points can be inserted.
(Inherited from PointLineSeriesBase.)
Public eventHighlightedStateChanged
Event telling that highlighted state has changed. Contains information of the new state.
(Inherited from HighlightingItemBase.)
Public eventMouseClick
Mouse button has been clicked.
(Inherited from UserInteractiveObject.)
Public eventMouseDoubleClick
Mouse button has been doubleclicked.
(Inherited from UserInteractiveObject.)
Public eventMouseDown
Mouse button has been pressed down.
(Inherited from UserInteractiveObject.)
Public eventMouseOverOff
Mouse has been moved outside of object.
(Inherited from UserInteractiveObject.)
Public eventMouseOverOn
Mouse has been moved over object.
(Inherited from UserInteractiveObject.)
Public eventMouseUp
Mouse button has been released.
(Inherited from UserInteractiveObject.)
Public eventOldDataDropped
Occurs when old data points have been dropped.
Top
Fields
  NameDescription
Public fieldStatic memberAntialiasProperty
Identifies the Antialias dependency property.
Public fieldStatic memberContinuousOverScaleBreakProperty
Identifies the ContinuousOverScaleBreak dependency property.
Public fieldStatic memberCursorTrackEnabledProperty
Identifies the CursorTrackEnabled dependency property.
Public fieldStatic memberDeceedColorProperty
Identifies the DeceedColor dependency property.
Public fieldStatic memberDeceedLimitProperty
Identifies the DeceedLimit dependency property.
Public fieldStatic memberExceedColorProperty
Identifies the ExceedColor dependency property.
Public fieldStatic memberExceedLimitProperty
Identifies the ExceedLimit dependency property.
Public fieldStatic memberFillProperty
Identifies the Fill dependency property.
Public fieldStatic memberIndividualPointColoringProperty
Identifies the IndividualPointColoring dependency property.
Public fieldStatic memberScrollingStabilizingProperty
Identifies the ScrollingStabilizing dependency property.
Public fieldStatic memberScrollModePointsKeepLevelProperty
Identifies the ScrollModePointsKeepLevel dependency property.
Public fieldStatic memberSimpleHighlightColorProperty
Identifies the SimpleHighlightColor dependency property.
Public fieldTag
Tag. Freely assignable object.
(Inherited from UserInteractiveObjectInt.)
Public fieldStatic memberUseLimitsProperty
Identifies the UseLimits dependency property.
Top
See Also