LegendBoxBase Class

LightningChart .NET Help

LegendBox shows the series names and line/point styles in a box.

Inheritance Hierarchy

SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.WindowsFreezable
        Arction.Wpf.ChartingChartNode
          Arction.Wpf.ChartingUserInteractiveObjectInt
            Arction.Wpf.ChartingUserInteractiveObject
              Arction.Wpf.ChartingHighlightingItemBase
                Arction.Wpf.ChartingDraggableObject
                  Arction.Wpf.Charting.ViewsLegendBoxBase
                    Arction.Wpf.Charting.Views.View3DLegendBox3DBase
                    Arction.Wpf.Charting.Views.ViewRoundLegendBoxRound
                    Arction.Wpf.Charting.Views.ViewXYLegendBoxXY

Namespace: Arction.Wpf.Charting.Views
Assembly: Arction.Wpf.Charting.LightningChart (in Arction.Wpf.Charting.LightningChart.dll) Version: 10.3.1

Syntax

C++

Copy

[SerializableAttribute]
[TypeConverterAttribute(typeof(GeneralTypeConverter))]
public class LegendBoxBase : DraggableObject

<SerializableAttribute>
<TypeConverterAttribute(GetType(GeneralTypeConverter))>
Public Class LegendBoxBase
	Inherits DraggableObject

[SerializableAttribute]
[TypeConverterAttribute(typeof(GeneralTypeConverter))]
public ref class LegendBoxBase : public DraggableObject

The LegendBoxBase type exposes the following members.

Constructors

	Name	Description
	LegendBoxBase	Constructor.

Top

Properties

	Name	Description
	AllowDragging	Gets or sets whether dragging by user is allowed. (Inherited from DraggableObject.)
	AllowResize	Allow resize by user interactive device.
	AllowUserInteraction	Gets or sets whether allow user interaction. (Inherited from UserInteractiveObject.)
	AutoSize	Automatic sizing based on contents.
	BorderColor	Border color.
	BorderWidth	Border width.
	CanFreeze	Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
	CheckBoxColor	Checkbox color.
	CheckBoxSize	LegendBox checkbox size in DPI.
	CheckMarkColor	Checkbox mark color.
	DependencyObjectType	Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)
	Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
	Fill	Fill.
	Height	Height. Applies when AutoSize is not used.
	Highlight	Gets or sets highlight style. Item can be highlighted by user interactive device or by code. (Inherited from HighlightingItemBase.)
	HighlightSeriesOnTitle	Highlight series, if user interactive device is over it or title on legend box.
	HighlightSeriesTitleColor	Highlighted series title color on legend box.
	IsFrozen	Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)
	IsSealed	Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
	Layout	LegendBox layout.
	MoveFromSeriesTitle	Allow LegendBox moving from series title, which prevents sending messages from the series title clicks.
	Offset	Offset from location calculated by Position property.
	ScrollBarVisibility	LegendBox scroll bar visibility setting.
	SeriesTitleColor	Series title color.
	SeriesTitleFont	Series title font.
	Shadow	Shadow beneath the LegendBox.
	ShowCheckboxes	Show checkboxes for selecting visibility of series.
	ShowIcons	Show icons.
	UnitsColor	Units text color.
	UnitsFont	Units text font.
	UseSeriesTitlesColors	Use series title color. If false, uses Items color.
	ValueLabelColor	Series value label color.
	ValueLabelFont	Series value text font.
	Width	Width. Applies when AutoSize is not used.
	Visible	Is LegendBox visible.

Top

Methods

	Name	Description
	ClearValue(DependencyProperty)	Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
	ClearValue(DependencyPropertyKey)	Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
	Clone	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.)
	CloneCurrentValue	Creates a modifiable clone (deep copy) of the Freezable using its current values. (Inherited from Freezable.)
	CoerceValue	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.)
	Dispose	Release all resources used by this instance. (Inherited from ChartNode.)
	Equals	Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
	Freeze	Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
	GetAsFrozen	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.)
	GetCurrentValueAsFrozen	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.)
	GetHashCode	Gets a hash code for this DependencyObject. (Inherited from DependencyObject.)
	GetLocalValueEnumerator	Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
	GetRenderedRect	Get rendered rectangle.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
	InvalidateProperty	Re-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
	IsHighlighted	returns true if the object is highlighted. (Inherited from HighlightingItemBase.)
	IsPositionOver	Is mouse over item. (Overrides UserInteractiveObjectIsPositionOver(Int32, Int32, Boolean).)
	ReadLocalValue	Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
	RemoveHighlight	Removes forced highlighting. (Inherited from HighlightingItemBase.)
	ResetLocation	Reset location, if moved by mouse. (Inherited from DraggableObject.)
	SetCurrentValue	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
	SetHighlight	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.)
	SetProperCursor	Set cursor. (Overrides DraggableObjectSetProperCursor.)
	SetValue(DependencyProperty, Object)	Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
	SetValue(DependencyPropertyKey, Object)	Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
	ToString	Convert class description to string. (Overrides HighlightingItemBaseToString.)

Top

Events

	Name	Description
	Changed	Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)
	CheckBoxStateChanged	Occurs when the state of a series title check box has changed.
	DraggedByUser	Dragged by user. (Inherited from DraggableObject.)
	HighlightedStateChanged	Event telling that highlighted state has changed. Contains information of the new state. (Inherited from HighlightingItemBase.)
	MouseClick	Mouse button has been clicked. (Inherited from UserInteractiveObject.)
	MouseDoubleClick	Mouse button has been doubleclicked. (Inherited from UserInteractiveObject.)
	MouseDown	Mouse button has been pressed down. (Inherited from UserInteractiveObject.)
	MouseOverOff	Mouse has been moved outside of object. (Inherited from UserInteractiveObject.)
	MouseOverOn	Mouse has been moved over object. (Inherited from UserInteractiveObject.)
	MouseUp	Mouse button has been released. (Inherited from UserInteractiveObject.)
	SeriesTitleMouseClick	Series title mouse click event handler.
	SeriesTitleMouseDoubleClick	Series title mouse double click event handler.
	SeriesTitleMouseDown	Series title mouse down event handler.
	SeriesTitleMouseUp	Series title mouse up event handler.

Top

Fields

	Name	Description
	SeriesTitleMouseClickEvent	Occurs when a user interactive device button is clicked on a series title.
	SeriesTitleMouseDoubleClickEvent	Occurs when a mouse button is double-clicked on a series title.
	SeriesTitleMouseDownEvent	Occurs when a user interactive device is pressed down on a series title.
	SeriesTitleMouseUpEvent	Occurs when a user interactive device button is released over a series title.
	Tag	Tag. Freely assignable object. (Inherited from UserInteractiveObjectInt.)

Top

Reference

Arction.Wpf.Charting.Views Namespace