TNumericIndicator
extends TChartBase
in package
Numeric indicator widget
Tags
Table of Contents
Constants
- COLORS = ['#91afec', '#fcba6d', '#78cd8b', '#f4a1c3', '#c3a643', '#c49ac6', '#e8dc66', '#f37978', '#4791cd', '#f0abab', '#bfd6ed', '#ffa640', '#ffce9e', '#53b948', '#aadca4', '#ee4b4c', '#ffb6b0', '#a982d3', '#d3c5de', '#a67a6d', '#d0b5aa', '#ec91d1', '#f9c4dd', '#999999', '#d9d9d9', '#d3cf45', '#e4e4a9', '#46c9e0', '#afe4f1', '#fba898', '#93e3a3', '#dcd9d6', '#7edabf', '#ffd44f', '#d9ddd9', '#b4dd79', '#f3bfc9', '#dbd7da', '#c199ff', '#c3d3e5', '#d6f18a', '#f2ecc1', '#dac4aa', '#ffe3cb', '#dac7c4', '#f0dff0', '#f2f240', '#f0ebdd', '#f6b884', '#bebebe']
Properties
- $children : mixed
- $height : mixed
- $metadata : mixed
- $numberPrefix : mixed
- $numericMask : mixed
- $palette : mixed
- $title : mixed
- $color : mixed
- $icon : mixed
- $value : mixed
Methods
- __clone() : mixed
- Clone the object
- __construct() : mixed
- Constructor method
- __get() : mixed
- Returns a property's value
- __isset() : mixed
- Returns is a property's is set
- __set() : mixed
- Intercepts whenever someones assign a new property's value
- __toString() : mixed
- Converts the object into a string
- __unset() : mixed
- Intercepts whenever someones unset a property's value
- add() : mixed
- Add an child element
- addMany() : mixed
- Add many children
- after() : mixed
- Insert element after
- before() : mixed
- Insert element before
- clearChildren() : mixed
- Clear element children
- close() : mixed
- BC only
- closeTag() : mixed
- Closes the tag
- del() : mixed
- Del an child element
- enableVoidElement() : mixed
- Turn element into a void element
- find() : mixed
- Find child element
- get() : mixed
- Get an child element
- getAfterElement() : mixed
- Return the after element
- getBeforeElement() : mixed
- Return the before element
- getChildren() : mixed
- get children
- getColors() : mixed
- Returns the array of colors from palette
- getContents() : mixed
- Returns the element content as a string
- getIsWrapped() : mixed
- Return if the element is wrapped inside another one
- getMetadata() : mixed
- Get metadata
- getName() : mixed
- Returns tag name
- getProperties() : mixed
- Return element properties
- getProperty() : mixed
- Return a property
- hide() : mixed
- hide object
- insert() : mixed
- Insert an child element
- open() : mixed
- BC only
- openTag() : mixed
- Opens the tag
- setColor() : mixed
- Set indicator color
- setHeight() : mixed
- Define the chart height
- setIcon() : mixed
- Set indicator icon
- setIsWrapped() : mixed
- Define if the element is wrapped inside another one
- setMetadata() : mixed
- Set metadata
- setName() : mixed
- Change the element name
- setNumberPrefix() : mixed
- Set default number prefix
- setNumericMask() : mixed
- Set default numeric mask
- setPalette() : mixed
- Define the color palette name
- setProperties() : mixed
- Set element properties
- setProperty() : mixed
- Set tag property
- setTitle() : mixed
- Define the chart title
- setUseLineBreaks() : mixed
- Set the use of linebreaks
- setUseSingleQuotes() : mixed
- Set the use of single quotes
- setValue() : mixed
- Set indicator value
- show() : mixed
- Show indicator
- tag() : mixed
- Create an element
Constants
COLORS
public
mixed
COLORS
= ['#91afec', '#fcba6d', '#78cd8b', '#f4a1c3', '#c3a643', '#c49ac6', '#e8dc66', '#f37978', '#4791cd', '#f0abab', '#bfd6ed', '#ffa640', '#ffce9e', '#53b948', '#aadca4', '#ee4b4c', '#ffb6b0', '#a982d3', '#d3c5de', '#a67a6d', '#d0b5aa', '#ec91d1', '#f9c4dd', '#999999', '#d9d9d9', '#d3cf45', '#e4e4a9', '#46c9e0', '#afe4f1', '#fba898', '#93e3a3', '#dcd9d6', '#7edabf', '#ffd44f', '#d9ddd9', '#b4dd79', '#f3bfc9', '#dbd7da', '#c199ff', '#c3d3e5', '#d6f18a', '#f2ecc1', '#dac4aa', '#ffe3cb', '#dac7c4', '#f0dff0', '#f2f240', '#f0ebdd', '#f6b884', '#bebebe']
Properties
$children
protected
mixed
$children
$height
protected
mixed
$height
$metadata
protected
mixed
$metadata
$numberPrefix
protected
mixed
$numberPrefix
$numericMask
protected
mixed
$numericMask
$palette
protected
mixed
$palette
$title
protected
mixed
$title
$color
private
mixed
$color
$icon
private
mixed
$icon
$value
private
mixed
$value
Methods
__clone()
Clone the object
public
__clone() : mixed
__construct()
Constructor method
public
__construct() : mixed
__get()
Returns a property's value
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
__isset()
Returns is a property's is set
public
__isset(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
__set()
Intercepts whenever someones assign a new property's value
public
__set(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
-
Property Name
- $value : mixed
-
Property Value
__toString()
Converts the object into a string
public
__toString() : mixed
__unset()
Intercepts whenever someones unset a property's value
public
__unset(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
add()
Add an child element
public
add(mixed $child) : mixed
Parameters
- $child : mixed
-
Any object that implements the show() method
addMany()
Add many children
public
addMany(mixed $children) : mixed
Parameters
- $children : mixed
-
Array of child
after()
Insert element after
public
after(mixed $element) : mixed
Parameters
- $element : mixed
before()
Insert element before
public
before(mixed $element) : mixed
Parameters
- $element : mixed
clearChildren()
Clear element children
public
clearChildren() : mixed
close()
BC only
public
close() : mixed
closeTag()
Closes the tag
public
closeTag() : mixed
del()
Del an child element
public
del(mixed $object) : mixed
Parameters
- $object : mixed
enableVoidElement()
Turn element into a void element
public
enableVoidElement() : mixed
find()
Find child element
public
find(mixed $element[, mixed $properties = null ]) : mixed
Parameters
- $element : mixed
-
tag name
- $properties : mixed = null
-
match properties
get()
Get an child element
public
get(mixed $position) : mixed
Parameters
- $position : mixed
-
Element position
getAfterElement()
Return the after element
public
getAfterElement() : mixed
getBeforeElement()
Return the before element
public
getBeforeElement() : mixed
getChildren()
get children
public
getChildren() : mixed
getColors()
Returns the array of colors from palette
public
getColors() : mixed
getContents()
Returns the element content as a string
public
getContents() : mixed
getIsWrapped()
Return if the element is wrapped inside another one
public
getIsWrapped() : mixed
getMetadata()
Get metadata
public
getMetadata(mixed $metadata) : mixed
Parameters
- $metadata : mixed
getName()
Returns tag name
public
getName() : mixed
getProperties()
Return element properties
public
getProperties() : mixed
getProperty()
Return a property
public
getProperty(mixed $name) : mixed
Parameters
- $name : mixed
-
property name
hide()
hide object
public
hide() : mixed
insert()
Insert an child element
public
insert(mixed $position, mixed $child) : mixed
Parameters
- $position : mixed
-
Element position
- $child : mixed
-
Any object that implements the show() method
open()
BC only
public
open() : mixed
openTag()
Opens the tag
public
openTag() : mixed
setColor()
Set indicator color
public
setColor(mixed $color) : mixed
Parameters
- $color : mixed
setHeight()
Define the chart height
public
setHeight(mixed $height) : mixed
Parameters
- $height : mixed
-
Chart height
setIcon()
Set indicator icon
public
setIcon(mixed $icon) : mixed
Parameters
- $icon : mixed
setIsWrapped()
Define if the element is wrapped inside another one
public
setIsWrapped(mixed $bool) : mixed
Parameters
- $bool : mixed
setMetadata()
Set metadata
public
setMetadata(mixed $metadata, mixed $value) : mixed
Parameters
- $metadata : mixed
- $value : mixed
setName()
Change the element name
public
setName(mixed $tagname) : mixed
Parameters
- $tagname : mixed
-
Element name
setNumberPrefix()
Set default number prefix
public
setNumberPrefix(mixed $prefix) : mixed
Parameters
- $prefix : mixed
setNumericMask()
Set default numeric mask
public
setNumericMask(mixed $decimals, mixed $decimalsSeparator, mixed $thousandSeparator) : mixed
Parameters
- $decimals : mixed
- $decimalsSeparator : mixed
- $thousandSeparator : mixed
setPalette()
Define the color palette name
public
setPalette(mixed $palette) : mixed
Parameters
- $palette : mixed
setProperties()
Set element properties
public
setProperties(mixed $properties) : mixed
Parameters
- $properties : mixed
setProperty()
Set tag property
public
setProperty(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
-
Property Name
- $value : mixed
-
Property Value
setTitle()
Define the chart title
public
setTitle(mixed $title) : mixed
Parameters
- $title : mixed
-
Chart title
setUseLineBreaks()
Set the use of linebreaks
public
setUseLineBreaks(mixed $linebreaks) : mixed
Parameters
- $linebreaks : mixed
-
boolean
setUseSingleQuotes()
Set the use of single quotes
public
setUseSingleQuotes(mixed $singlequotes) : mixed
Parameters
- $singlequotes : mixed
-
boolean
setValue()
Set indicator value
public
setValue(mixed $value) : mixed
Parameters
- $value : mixed
show()
Show indicator
public
show() : mixed
tag()
Create an element
public
static tag(mixed $tagname, mixed $value[, mixed $attributes = NULL ]) : mixed
Parameters
- $tagname : mixed
-
Element name
- $value : mixed
-
Element value
- $attributes : mixed = NULL
-
Element attributes