|
Set the format of the text to be displayed using the ShowValue/ShowMaxMin/ShowHoverValue properties.
Syntax 1
SetTextType(
"NUMBER"
[,numberFormat]
)
Call this if you want to display a numeric value (note: normally it is not necessary to call this as it is set to a numeric value by default).
Parameters
textType
|
|
Type:
|
character
|
|
"NUMBER"
|
numberFormat
|
|
Type:
|
character
|
|
Number format. For more information about number formats, see "Number Format".
|
Return Value
|
|
Type:
|
Boolean
|
|
FALSE - Failure. TRUE - Success.
|
Syntax 2
SetTextType(
"DATETIME"
startTime,
dateTimeFormat
[,timeZone=""]
)
Call this to display the time. Max/Min/Value is treated as seconds, and the time based on startTime is displayed in text.
Parameters
textType
|
|
Type:
|
character
|
|
"DATETIME"
|
startTime
|
|
Type:
|
time
|
|
The start time.
|
dateTimeFormat
|
|
Type:
|
character
|
|
Date and time format. For details about date and time formats, see "Date and time formats".
|
timeZone
|
|
Type:
|
character
|
|
Time zone. For more information, see "About time zones".
|
Return Value
|
|
Type:
|
Boolean
|
|
FALSE - Failure. TRUE - Success.
|
Syntax 3
SetTextType(
"DURATION"
durationFormat
[,type="SEC"]
)
Call this when you want to display by period.
Parameters
textType
|
|
Type:
|
character
|
|
"DURATION"
|
durationFormat
|
|
Type:
|
character
|
|
Specifies the duration format. The following keywords can be used in the format:
%D - days / %H - hours / %M - minutes / %S - seconds / %T - ms / %% - %
%#H - hours / %#M - minutes / %#S - seconds / %#T - ms (displayed with leading zeros removed)
|
type
|
|
Type:
|
character
|
|
How to handle the units of Max/Min/Value. SEC / MIN / HOUR can be specified.
|
Return Value
|
|
Type:
|
Boolean
|
|
FALSE - Failure. TRUE - Success.
|
Supported
reference
|