SpectrumLegend

The spectrum legend is used to map values of visualizer factors with a specific color spectrum value.

Syntax

Constructor

Properties

	Property name	Brief description
	AreMarksVisible	The AreMarksVisible property determines whether color range separators of spectrum legend are displayed.
	ItemBorderColor	The ItemBorderColor property determines border color for legend elements.
	ItemBorderThickness	The ItemBorderThickness property determines border width for legend elements.
	ItemFormat	The ItemFormat property determines format of legend elements text.
	MarkColor	The MarkColor property determines color of spectrum legend color range separators.
	MarkSize	The MarkSize property determines length of spectrum legend color range separators.
	MarkThickness	The MarkThickness property determines thickness of spectrum legend color range separators.
	Mode	The Mode property determines legend elements display mode.
	RotateText	The RotateText property determines whether legend elements text is rotated when alignment changes.
	SpectrumSize	The SpectrumSize property determines height of spectrum band.
	TextPosition	The TextPosition property determines position of chart element text respective to this element.
	TextSize	The TextSize property returns height of legend text.
	TextSpacing	The TextSpacing property determines a distance from spectrum legend color range separators to text.

Methods

Events

Properties inherited from the class ColorLegendBase

	Property name	Brief description
	ActiveEffects	The ActiveEffects property determines an array of effects applied to scale active elements.
	BetweenFormat	The BetweenFormat property determines format for intervals with both borders.
	DoHighlight	The DoHighlight property determines whether highlighting is allowed for color scale elements.
	EqualFormat	The EqualFormat property determines format of record for intervals with a specific value.
	GreaterFormat	The GreaterFormat property determines format of record for intervals with left border.
	HighlightBrush	The HighlightBrush property determines a brush to be used for visualizer elements' highlighting.
	HighlightItemColor	The HighlightItemColor property sets color of marker and label of highlighted legend element.
	HoverMode	The HoverMode property determines activation mode of legend elements highlighting.
	InactiveEffects	The InactiveEffects property determines an array of effects applied to inactive scale elements.
	LessFormat	The LessFormat property determines format of record for intervals with the right border.
	NoDataPosition	The NoDataPosition property determines positions of elements that correspond to missing data in visualizer.
	NoDataText	The NoDataText property determines label for the element that corresponds to data not available in the visualizer.
	NoDataVisible	The NoDataVisible property determines whether the element that corresponds to data not available in the visualizer is visible.

Methods inherited from the class ColorLegendBase

Properties inherited from the LegendBase class

	Property name	Brief description
	ContentAlignment	The ContentAlignment property determines alignment of legend contents.
	Footer	The Footer property determines legend footer.
	FooterLine	The FooterLine property determines a line near the legend footer.
	Format	The Format property determines default format of legend elements.
	Header	The Header property determines legend header.
	HeaderLine	The HeaderLine property determines a line near the legend header.
	IsOuter	The IsOuter property determines whether a legend is rendered from outside.
	IsOverlap	The IsOverlap property determines whether a legend overlaps the visualizer working area.
	Scale	The Scale property determines a scale of visualizer legend.
	TextWrapping	The TextWrapping property determines whether text is wrapped.
	Type	The Type property determines legend type.
	Visibility	The Visibility property determines whether a legend is visible.

Events inherited from the LegendBase class

Properties inherited from the PlacedControlBase class

Methods inherited from the PlacedControlBase class

Properties inherited from the class Control

	Property name	Brief description
	Anchors	The Anchors property determines position of the component placed within container.
	Animation	The Animation property determines component animation parameters.
	Bottom	The Bottom property determines a bottom margin if a component is placed inside LayoutPanel.
	Content	The Content property determines component contents.
	ContextMenu	The ContextMenu property determines a component's context menu.
	Data	The Data property is used to store any custom data.
	Enabled	The Enabled property determines whether a component can be used.
	Height	The Height property determines component height.
	IsRTL	The IsRTL property determines whether component elements are aligned to the right.
	IsVisible	The IsVisible property determines whether a component is displayed.
	Left	The Left property determines a left margin if a component is placed inside GridPanel.
	Opacity	The Opacity property determines component transparency.
	Parent	The Parent property determines a parent component of a control.
	ParentNode	The ParentNode property determines a parent DOM node.
	ResourceKey	The ResourceKey property determines a component resource key.
	Right	The Right property determines a right margin if a component is placed inside LayoutPanel.
	Rotate	The Rotate property determines a component rotation angle.
	ShowToolTip	The ShowToolTip property determines whether a tooltip of the component can be displayed.
	Style	The Style property determines a component style.
	TabIndex	The TabIndex property determines the order of the control element passing inside the container.
	Tag	The Tag property determines a JSON object associated with the component.
	ToolTip	The ToolTip property determines text of component tooltip.
	Top	The Top property determines a top margin if a component is placed inside GridPanel.
	Value	The Value property determines a component value.
	Width	The Width property determines component width.

Methods inherited from the class Control

	Method name	Brief description
	addClass	The addClass method adds a CSS class to the component.
	addEventHandler	The addEventHandler method adds an event handler to a DOM node.
	addStateClass	The addStateClass method adds a CSS class to the component and removes the previous CSS class.
	addToNode	The addToNode method adds a component to the specified node.
	bindEvents	The bindEvents method subscribes an element to all available events.
	getAnchorFlags	The getAnchorFlags method returns JSON object that contains settings of the current component's position.
	getClass	The getClass method returns the current CSS classes of the component.
	getCssStyle	The getCssStyle method returns style for the specified node.
	getDomNode	The getDomNode method returns main DOM node of the component.
	getFocused	The getFocused method determines whether the component is focused.
	getIsBinded	The getIsBinded method returns whether an element is subscribed to all DOM node events.
	hide	The hide method hides a control.
	hideToolTip	The hideToolTip method clears tooltip timeout and hides the tooltip if it is shown.
	refreshStyle	The refreshStyle method refreshes element CSS styles.
	removeClass	The removeClass method removes CSS class from the component.
	removeEventHandler	The removeEventHandler method removes event handler from DOM node.
	removeFromDOM	The removeFromDOM method removes node from the DOM structure.
	removeStateClasses	The removeStateClasses method removes CSS classes of the component.
	setDraggable	The setDraggable method determines whether a component can be dragged on the HTML page.
	setFocus	The setFocus method sets the component focus.
	setIsHovered	The setIsHovered method sets up component displaying only on mouseover.
	setSize	The setSize method establishes the sizes of the component.
	show	The show method displays a control.
	unBindEvents	The unBindEvents method unsubscribes an element from all standard events.
	updatePosition	The updatePosition method updates size and position when absolute positioning based on the current parameters is used.
	updateSize	The updateSize method updates the component size on changing the size of the container that contains the component.

Events inherited from the class Control

Properties inherited from the class Object

Methods inherited from the class Object

	Method name	Brief description
	clone	The clone method creates an object copy.
	dispose	The dispose method deletes the component.
	getHashCode	The getHashCode method returns hash code of repository object.
	getId	The getId method returns repository object identifier.
	getSettings	The getSettings method returns repository object settings.
	getTypeName	The getTypeName method returns the name of the object type without the namespace, to which it belongs.
	isEqual	The isEqual method determines whether the specified object is equal to the current repository object.
	isLive	The isLive method determines validity of repository object.
	removeAllEvents	The removeAllEvents method removes all object event handlers by the specified context.
	setId	The setId method determines a repository object identifier.
	setSettings	The setSettings method determines repository object settings.
	defineProps	The defineProps method creates get and set methods from name array for the specified class.
	keys	The keys method returns array of methods and properties names for the specified object.

	Method name	Brief description
	Selected	The Selected event occurs after selecting a spectrum legend element.
	Selecting	The Selecting event occurs on selecting a spectrum legend element.

	Property name	Brief description
	Background	The Background property determines a brush for visual control background fill.
	Border	The Border property determines borders of visual control.
	Font	The Font property determines font of visual control.
	HorizontalAlignment	The HorizontalAlignment property determines horizontal alignment of visual control.
	Margin	The Margin property determines margins of a control.
	Padding	The Padding property determines paddings of a control.
	VerticalAlignment	The VerticalAlignment property determines vertical alignment of visual control.

	Method name	Brief description
	contains	The contains property determines whether the specified point belongs to component area.
	draw	The draw method renders the current visual control.
	getRealHeight	The getRealHeight method returns total height of visual control, including paddings and margins.
	getRealWidth	The getRealWidth method returns total width of visual control, including paddings and margins.

	Event name	Brief description
	Drag	The Drag event occurs on clicking and holding the mouse button.
	DragEnd	The DragEnd event occurs when dragging the component finishes.
	DragStart	The DragStart event occurs when dragging the component starts.
	OnContextMenu	The OnContextMenu event occurs on calling context menu of the component.
	SizeChanged	The SizeChanged event occurs after the component is resized.
	SizeChanging	The SizeChanging event occurs during component resize.