Difference between revisions of "SsParseNum"

From SmartWiki
Jump to: navigation, search
(TOC)
(Example)
Line 15: Line 15:
  
  
==Example==
+
==Examples==
 
<pre>
 
<pre>
 
ssParseNum($5,000.00,true);
 
ssParseNum($5,000.00,true);
Line 22: Line 22:
 
Will return: 5000
 
Will return: 5000
  
 +
----
 +
 +
If you wish to display a ratio of two fields that are set to have currency formatting, you should convert the values to numbers using ''ssParseNum'':
 +
 +
<pre>
 +
ssParseNum(field1,true)/ssParseNum(field2,true)
 +
</pre>
  
 
==Requirements==
 
==Requirements==

Revision as of 14:28, 18 November 2013

Overview

To convert a number from a formatted string (containing symbols like "$" or "%") to a number using JavaScript you can use a function called ssParseNum.

ssParseNum is preferred to the standard parseFloat function because it automatically replaces the dollar sign.

Syntax

ssParseNum( value, emptyok );

Where:
value - is the a value to be converted to a number (i.e: $5,000.00 and 5,000% will be converted to 5000)
emptyok - is a true/false value

  • if emptyok is true - an empty string will be returned by ssParseNum if the value is empty
  • if emptyok is false - a "0" will be returned by ssParseNum if the value is empty


Examples

ssParseNum($5,000.00,true);

Will return: 5000


If you wish to display a ratio of two fields that are set to have currency formatting, you should convert the values to numbers using ssParseNum:

ssParseNum(field1,true)/ssParseNum(field2,true)

Requirements

This function is part of the sstools.js library and needs to be added to Browser Script custom fields or on template pages, sign-up pages etc. using the following syntax:

<SCRIPT type="text/javascript" language="javascript" src="/sstools.js"></SCRIPT>


See Also