IntervalsLegend

Namespace: PP.Ui;

Inheritance hierarchy

Object

Control

PlacedControlBase

LegendBase

ColorLegendBase

IntervalsLegend

Description

The IntervalsLegend class implements visualizer legend with intervals.

Syntax

PP.initClass(PP.Ui.IntervalsLegend, PP.Ui.ColorLegendBase, "PP.Ui.IntervalsLegend");

Constructor

	Constructor name	Brief description
	IntervalsLegend	The IntervalsLegend constructor creates an instance of the IntervalsLegend class.

Properties

	Property name	Brief description
	AllowMultipleSelection	The AllowMultipleSelection property determines whether multiple selection is available for legend elements.
	AutoColumnsCount	The AutoColumnsCount property determines automatic calculation of the number of legend columns.
	CellAutoColor	The CellAutoColor property determines legend element font color.
	CellBorder	The CellBorder property determines legend element border.
	CellPadding	The CellPadding property determines legend element paddings.
	CellSpacing	The CellSpacing property determines spacing between legend elements.
	ColorApplying	The ColorApplying property determines interval legend color visualization mode.
	ColumnsCount	The ColumnsCount property determines the number of legend element columns.
	CurrentPage	The CurrentPage property determines the current legend page.
	Descending	The Descending property determines whether legend elements are sorted in descending order.
	IncludeEquals	The IncludeEquals property determines whether "equal" legend elements should be displayed.
	Items	The Items property determines how the element names are mapped with legend element colors.
	ItemsOrder	The ItemsOrder property determines display order of legend elements.
	Marker	The Marker property determines shape of legend element markers.
	MarkersAtRight	The MarkersAtRight property determines whether legend element markers are displayed at the right of the text.
	MaxHeaderWidth	The MaxHeaderWidth property determines the maximum width of top and bottom legend text in percents.
	MaxHeight	The MaxHeight property sets maximum legend height in percents.
	MaxWidth	The MaxWidth property sets maximum legend width in percents.
	Mode	The Mode property determines legend element display mode.
	PageMode	The PageMode property determines the mode of dividing legend elements into pages.
	TextHorizontalAlignment	The TextHorizontalAlignment property determines horizontal alignment of legend element text.
	TextSpacing	The TextSpacing property determines spacing between legend element text and marker.

Methods

	Method name	Brief description
	getColumnCount	The getColumnCount method returns the number of legend columns.
	getSelectedItemsIndexes	The getSelectedItemsIndexes method returns indexes of selected legend elements.

Events

	Event name	Brief description
	ItemHovered	The ItemHovered event occurs on hovering the mouse cursor on a legend element.
	Selected	The Selected event occurs after selecting a legend element.
	Selecting	The Selecting event occurs on selecting a legend element.

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.

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

	Method name	Brief description
	HeaderClicked	The HeaderClicked event occurs after clicking on the chart header.

Properties inherited from the PlacedControlBase class

	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.

Methods inherited from the PlacedControlBase class

	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.

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 sets animation parameters for component.
	Bottom	The Bottom property sets bottom offset on placing the component within the LayoutPanel.
	Content	The Content property sets the component contents.
	ContextMenu	The ContextMenu property sets the context menu for the component.
	Data	The Data property is used to store any custom data.
	DataContext	The DataContext property contains an object with data.
	Enabled	The Enabled property sets whether the component is enabled.
	Height	The Height property determines the component height.
	IsResizable	The IsResizable property determines whether the component can be resized.
	IsRTL	The lsRTL property sets right to left text direction.
	IsVisible	The IsVisible property determines whether the component is displayed.
	Left	The Left property sets left offset on placing the component within the GridPanel.
	Offset	The Offset property determines coordinates of root DOM node of a control.
	Opacity	The Opacity property determines component transparency.
	Parent	The Parent property determines a parent component of a control.
	ParentNode	The ParentNode property sets parent DOM node.
	ResourceKey	The ResourceKey property sets the resource key for the component.
	Right	The Right property sets right offset on placing the component within the LayoutPanel.
	Rotate	The Rotate property sets component rotation angle.
	ShowToolTip	The ShowToolTip property determines whether the tooltip of the component can be displayed.
	Style	The Style property sets component style.
	TabIndex	The TabIndex property sets the order of the control element passing inside the container.
	Tag	The Tag property sets JSON object associated with the component.
	ToolTip	The ToolTip property determines text of component tooltip.
	Top	The Top property sets top offset on placing the component within the GridPanel.
	Value	The Value property sets the value to the component.
	Width	The Width property sets the component width.

Methods inherited from the class Control

	Method name	Brief description
	addClass	The addClass method adds a CSS class to the component.
	addEvent	The addEvent method adds an event handler to a DOM node.
	addEventHandler	The addEventHandler method adds an event handler to a DOM node.
	addEvents	The addEvents method adds an array of event handlers to a DOM node.
	addStateClass	The addStateClass method adds a CSS class to the component and removes the previous CSS class.
	addStyleBySelector	The addStyleBySelector method creates a block that contains a style with the specified CSS selector.
	addToNode	The addToNode method adds a component to the specified node.
	bindEvents	The bindEvents method subscribes an element to all available events.
	clearStylesCache	The clearStylesCache method clears cache of component styles.
	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.
	getFunctionByName	The getFunctionByName method returns function by name.
	getIsBinded	The getIsBinded method returns whether an element is subscribed to all DOM node events.
	hasClass	The hasClass method determines whether the specified CSS class is set for root DOM node of the control.
	hide	The hide method hides a control.
	hideToolTip	The hideToolTip method clears tooltip timeout and hides the tooltip if it is displayed.
	isResingNow	The isResingNow method determines whether the component is being resized.
	refreshBindingProperty	The refreshBindingProperty method refreshes the bound property by name.
	refreshItemsStyle	The refreshItemsStyle method refreshes CSS styles of child elements.
	refreshStyle	The refreshStyle method refreshes element CSS styles.
	removeClass	The removeClass method removes CSS class from the component.
	removeEvent	The removeEvent method removes event handler from DOM node.
	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 it is possible to drag component on the HTML page.
	setFocus	The setFocus method sets the component focus.
	setIsHovered	The setIsHovered method displays the component as on hover.
	setIsPressed	The setIsPressed method displays the component as if clicked upon.
	setOpacityIE8	The setOpacityIE8 method sets component transparency value in Internet Explorer 8.
	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

	Event name	Brief description
	Drag	The Drag event occurs on clicking and holding the left 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.

Properties inherited from the class Object

	Property name	Brief description
	Data	The Data property associates a random object with this component.
	Id	The Id property sets component identifier.
	Settings	The Settings property sets the component parameters.

Methods inherited from the class Object

	Method name	Brief description
	clone	The clone method creates a copy of object. It is not implemented in PP.Ui.Control.
	dispose	The dispose method deletes the component.
	getTypeName	The getTypeName method returns the name of the object type without the namespace, to which it belongs.

See also:

PP.Ui