com.nchart3d.NChart.NChartAutoScrollLabel Class Reference

The NChartAutoScrollLabel provides methods to control the label that is shown whenever auto scroll mode of chart is toggled. More...

Inheritance diagram for com.nchart3d.NChart.NChartAutoScrollLabel:
com.nchart3d.NChart.NChartLabel com.nchart3d.NChart.NChartPlaced com.nchart3d.NChart.NChartObject

Public Member Functions

 NChartAutoScrollLabel ()
 Create auto scroll label instance.
 
String getOnText ()
 Text that should appear on the label whenever auto scroll is ON. More...
 
void setOnText (String onText)
 For details see getOnText().
 
String getOffText ()
 Text that should appear on the label whenever auto scroll is OFF. More...
 
void setOffText (String offText)
 For details see getOffText().
 
float getFadeTime ()
 Fade time of the label (in seconds). More...
 
void setFadeTime (float fadeTime)
 For details see getFadeTime().
 
float getVisibleTime ()
 Time the label is visible (in seconds). More...
 
- Public Member Functions inherited from com.nchart3d.NChart.NChartLabel
NChartFont getFont ()
 Font of the label's text.
 
void setFont (NChartFont font)
 For details see getFont().
 
int getTextColor ()
 Color of the label's text.
 
void setTextColor (int textColor)
 For details see getTextColor().
 
String getText ()
 Text to display in the label.
 
void setText (String text)
 For details see getText().
 
NChartLineBreakMode getTextWrapping ()
 Wrapping mode of the label's text.
 
void setTextWrapping (NChartLineBreakMode textWrapping)
 For details see getTextWrapping().
 
float getMaxWidth ()
 Maximal width of the label's text in pixels. More...
 
Paint.Align getTextAlignment ()
 Alignment of the label's text. More...
 
void setTextAlignment (Paint.Align textAlignment)
 For details see getTextAlignment().
 
void setMaxWidth (float maxWidth)
 For details see getMaxWidth().
 
- Public Member Functions inherited from com.nchart3d.NChart.NChartPlaced
NChartBrush getBackground ()
 Brush filling the background of the text container. More...
 
void setBackground (NChartBrush background)
 For details see getBackground().
 
int getBorderColor ()
 Color of the border that is drawn around the text container.
 
void setBorderColor (int borderColor)
 For details see getBorderColor().
 
float getBorderRadius ()
 Corner rounding radius (in pixels) of the border that is drawn around the text container.
 
void setBorderRadius (float borderRadius)
 For details see getBorderRadius().
 
float getBorderThickness ()
 Thickness of the border (in pixels) that is drawn around the text container.
 
void setBorderThickness (float borderThickness)
 For details see getBorderThickness().
 
NChartMargin getMargin ()
 Margin of the text container in pixels (spacing from the bounds of the enclosing area).
 
void setMargin (NChartMargin margin)
 For details see getMargin().
 
NChartMargin getPadding ()
 Padding of the text container in pixels (spacing to sub-areas).
 
void setPadding (NChartMargin padding)
 For details see getPadding().
 
float getOpacity ()
 Opacity of the text container. More...
 
void setOpacity (float opacity)
 For details see getOpacity().
 
- Public Member Functions inherited from com.nchart3d.NChart.NChartObject
boolean isVisible ()
 Flag that determines if the object is visible or not. More...
 
void setVisible (boolean visible)
 For details see isVisible().
 
NChart getChart ()
 Chart the object belongs to. More...
 

Detailed Description

The NChartAutoScrollLabel provides methods to control the label that is shown whenever auto scroll mode of chart is toggled.

Member Function Documentation

float com.nchart3d.NChart.NChartAutoScrollLabel.getFadeTime ( )
inline

Fade time of the label (in seconds).

The default value is 0.25.

String com.nchart3d.NChart.NChartAutoScrollLabel.getOffText ( )
inline

Text that should appear on the label whenever auto scroll is OFF.

The default value is null.

String com.nchart3d.NChart.NChartAutoScrollLabel.getOnText ( )
inline

Text that should appear on the label whenever auto scroll is ON.

The default value is null.

float com.nchart3d.NChart.NChartAutoScrollLabel.getVisibleTime ( )
inline

Time the label is visible (in seconds).

The default value is 1.