LegendModifier

StockSharp.Xaml.Charting.ChartModifiers

Defines a custom chart modifier to provide info for the LegendTemplate

Inherits: InspectSeriesModifierBase

Constructors

LegendModifier()

Initializes a new instance of the LegendModifier class.

Properties

GetLegendDataFor : SourceMode

Gets or sets an enumeration constant defining which series to interrogate for the legend data source

LegendData : ChartDataObject

The LegendData object provides a collection of SeriesInfo which can be bound to in ItemsControls or UltrachartLegend control.

LegendItemTemplate : DataTemplate

Gets or sets the Legend Item Template, which provides UI that binds to a single SeriesInfo instance.

LegendPlacement : LegendPlacement

Used in combination with ShowLegend = true. Defines the placement of the auto-generated legend

LegendTemplate : ControlTemplate

Used in combination with ShowLegend = true. An optional control template for the auto-generated UltrachartLegend control

Orientation : Orientation

Gets or sets the Orientation of the Legend Items, e.g. Vertical, or Horizontal

ShowLegend : bool

If true, then the LegendModifier automatically shows and hosts a UltrachartLegend inside the chart surface, according to LegendPlacement. If false, then the user may provide an alternative legend control

ShowSeriesMarkers : bool

Used in combination with ShowLegend = true. If true, shows the Series Markers in the automatically generated legend

ShowVisibilityCheckboxes : bool

Used in combination with ShowLegend = true. If true, shows the Visibility Checkboxes in the automatically generated legend.

Methods

ClearAll()

When overriden in a derived class, this method should clear all markers and tooltips from the ModifierSurface

GetSeriesInfo(IEnumerable<IRenderableSeries>) : ObservableCollection<SeriesInfo>

Gets the SeriesInfo for all the RenderableSeries passed in

allSeries
HandleMasterMouseEvent(Point)

When overriden in a derived class, called to handle the Master ChartModifierBase MouseMove event

mousePoint
The current Mouse-point
HandleSlaveMouseEvent(Point)

When overriden in a derived class, called to handle the Slave ChartModifierBase MouseMove event

mousePoint
The current Mouse-point
OnAttached()

Called when the element is attached to the Chart Surface

OnDetached()

Called immediately before the element is detached from the Chart Surface

OnModifierMouseMove(ModifierMouseArgs)

Called when the Mouse is moved on the parent UltrachartSurface

e
Arguments detailing the mouse move operation
OnParentSurfaceRendered(UltrachartRenderedMessage)

Called when the parent UltrachartSurface is rendered

e
The UltrachartRenderedMessage which contains the event arg data
UpdateLegend()

Refreshes the legend with up-to-date SeriesInfo with series names, latest values

UpdateSeriesInfo(SeriesInfo, SeriesInfo)

Does a replace of the data on the OldSeriesInfo instance with data from NewSeriesInfo

oldSeriesInfo
newSeriesInfo

Fields

GetLegendDataForProperty : DependencyProperty

Defines the GetLegendDataFor DependencyProperty

LegendDataProperty : DependencyProperty

Defines the LegendData DependencyProperty

LegendItemTemplateProperty : DependencyProperty

Defines the LegendTemplate DependencyProperty

LegendPlacementProperty : DependencyProperty

Defines the LegendPlacement DependencyProperty

LegendTemplateProperty : DependencyProperty

Defines the UltrachartLegend DependencyProperty

OrientationProperty : DependencyProperty

Defines the LegendOrientation DependencyProperty

ShowLegendProperty : DependencyProperty

Defines the ShowLegend DependencyProperty

ShowSeriesMarkersProperty : DependencyProperty

Defines the ShowSeriesMarkers DependencyProperty

ShowVisibilityCheckboxesProperty : DependencyProperty

Defines the ShowVisibilityCheckboxes DependencyProperty