today - script and chart function

This function returns the current date from the system clock.


today([ timer_mode])

Return data type: dual


Argument Description

Can have the following values:

0 (day of last finished data load)
1 (day of function call)
2 (day when the document was opened)

Note: If you use the function in a load script, timer_mode=0 will result in the day of the last finished data load, while timer_mode=1 will give the day of the current data load.

Examples and results:  

Example Result

Today( 0)

Returns the day of the last finished data load.

Today( 1)

When used in a chart expression, this returns the day of the function call.

When used in a load script, this returns the day when the current data load started.

Today( 2)

Returns the day when the document was opened.

Did this information help you?

Thanks for letting us know. Is there anything you'd like to tell us about this topic?

Can you tell us why it did not help you and how we can improve it?