LineArrow

Namespace: PP.Ui;

Inheritance hierarchy

Object

Control

GaugeObject

GaugeArrowBase

LineArrow

Description

The LineArrow class implements the line pointer.

Syntax

PP.initClass(PP.Ui.LineArrow, PP.Ui.GaugeArrowBase, "LineArrow");

Constructor

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

Properties

  Property name Brief description
Size The Size property sets line width.
Tail The Tail property sets tail length.

Properties inherited from the GaugeArrowBase class

  Property name Brief description
Radius The Radius property determines radius (length) of the pointer.

Methods inherited from the GaugeArrowBase class

  Method name Brief description
animate The animate method returns arrow parameters to the specified animation step.
calcRadius The calcRadius method calculates radius (length) of the pointer.
getAutoResKoef The getAutoResKoef method returns ratio of speedometer arrow radius to speedometer radius.
getDimAttributeId The getDimAttributeId method returns identifier of the dimension attribute that is used to select data from data source.
getIsValid The getIsValid method returns the result of arrow validity check.
getScale The getScale method returns a scale that contains the current pointer.
setAnimationValues The setAnimationValues method sets value of the next animation step.
setRadiusUnit The setRadiusUnit method sets measurement type for pointer radius (length).

Properties inherited from the GaugeObject class

  Property name Brief description
Background The Background property determines a brush for element background fill.
Border The Border property determines a brush for element borders.
BorderEnabled The BorderEnabled property determines whether speedometer element has a border.
BorderStyle The BorderStyle property determines style of element borders.
BorderWidth The BorderWidth property determines element border width.
MajorArrow The MajorArrow property determines main arrow for speedometer scale.
Name The Name property sets name for speedometer scale pointer.
OpacityEnabled The OpacityEnabled property determines whether element transparency settings are used.
Shadow The Shadow property determines element shadow.

Methods inherited from GaugeObject class

  Method name Brief description
getChildren The getChildren method returns an array of child elements of GaugeObject.
paint The paint method colors SVG element background and border according to settings determined in Background and Border.
redraw The redraw method sets attributes of SVG element according to the properties.
render The render method creates SVG elements and places them in the parent object.
rerender The rerender method removes an object and rerenders it.

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

  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.

Properties inherited from the class Object

  Property name Brief description

Id

The Id property determines a repository object identifier.

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.

See also:

Speedometer