UNPKG

gs-mobile-cordova-plugin-jslib

Version:

GS Mobile JSLib

160 lines (117 loc) 5.7 kB
<a name="Utility"></a> ## Utility **Kind**: global class * [Utility](#Utility) * [new Utility()](#new_Utility_new) * [.getInfo(successCallback, errorCallback)](#Utility+getInfo) * [.leftPad(value, length)](#Utility+leftPad) ⇒ <code>String</code> * [.formatNumber(number, point)](#Utility+formatNumber) ⇒ <code>String</code> * [.yyyy2yyy()](#Utility+yyyy2yyy) ⇒ <code>String</code> * [.yyy2yyyy()](#Utility+yyy2yyyy) ⇒ <code>String</code> * [.getCurrentDate()](#Utility+getCurrentDate) ⇒ <code>String</code> * [.getCurrentDateDiff(diff)](#Utility+getCurrentDateDiff) ⇒ <code>String</code> * [.getCurrentTime()](#Utility+getCurrentTime) ⇒ <code>String</code> * [.getLastMonthCurrentDate(num)](#Utility+getLastMonthCurrentDate) ⇒ <code>String</code> * [.getNextMonthCurrentDate(num)](#Utility+getNextMonthCurrentDate) ⇒ <code>String</code> * [.getParameterByName(name, num)](#Utility+getParameterByName) ⇒ <code>String</code> * [.twd97_to_latlng($x, $y)](#Utility+twd97_to_latlng) ⇒ <code>array</code> <a name="new_Utility_new"></a> ### new Utility() This represents the mobile device, and provides properties for inspecting the model, version, UUID of the phone, etc. <a name="Utility+getInfo"></a> ### utility.getInfo(successCallback, errorCallback) 取得行動裝置資訊 **Kind**: instance method of [<code>Utility</code>](#Utility) | Param | Type | Description | | --- | --- | --- | | successCallback | <code>function</code> | The function to call when the heading data is available | | errorCallback | <code>function</code> | The function to call when there is an error getting the heading data. (OPTIONAL) | <a name="Utility+leftPad"></a> ### utility.leftPad(value, length) ⇒ <code>String</code> leftPad(1,3) **Kind**: instance method of [<code>Utility</code>](#Utility) **Summary**: 固定n位數, 不足補0 **Returns**: <code>String</code> - str 001 | Param | Type | Description | | --- | --- | --- | | value | <code>int</code> | 傳入值 | | length | <code>int</code> | n位數 | <a name="Utility+formatNumber"></a> ### utility.formatNumber(number, point) ⇒ <code>String</code> formatNumber(1234.123, 2) **Kind**: instance method of [<code>Utility</code>](#Utility) **Summary**: 格式化數字補千分位,固定小數n位 **Returns**: <code>String</code> - num 1,234.12 | Param | Type | Description | | --- | --- | --- | | number | <code>String</code> | 傳入值 | | point | <code>String</code> | 固定小數n位 | <a name="Utility+yyyy2yyy"></a> ### utility.yyyy2yyy() ⇒ <code>String</code> yyyy2yyy('2020年01月02日') **Kind**: instance method of [<code>Utility</code>](#Utility) **Summary**: 西元年轉民國年 **Returns**: <code>String</code> - 109年01月02日 <a name="Utility+yyy2yyyy"></a> ### utility.yyy2yyyy() ⇒ <code>String</code> yyyy2yyy('107年01月02日') **Kind**: instance method of [<code>Utility</code>](#Utility) **Summary**: 民國年轉西元年 **Returns**: <code>String</code> - 2020年01月02日 <a name="Utility+getCurrentDate"></a> ### utility.getCurrentDate() ⇒ <code>String</code> **Kind**: instance method of [<code>Utility</code>](#Utility) **Summary**: 取得當下民國日期 **Returns**: <code>String</code> - 109年01月02日 <a name="Utility+getCurrentDateDiff"></a> ### utility.getCurrentDateDiff(diff) ⇒ <code>String</code> getCurrentDateDiff(2) 假設當下是2020/01/03 **Kind**: instance method of [<code>Utility</code>](#Utility) **Summary**: 取得當下日期減天數 **Returns**: <code>String</code> - 傳回就是2020/01/01 | Param | Type | Description | | --- | --- | --- | | diff | <code>String</code> | 欲減掉的天數 | <a name="Utility+getCurrentTime"></a> ### utility.getCurrentTime() ⇒ <code>String</code> **Kind**: instance method of [<code>Utility</code>](#Utility) **Summary**: 取得當下時間(時跟分) **Returns**: <code>String</code> - 18時10分 <a name="Utility+getLastMonthCurrentDate"></a> ### utility.getLastMonthCurrentDate(num) ⇒ <code>String</code> 假設當天是109/01/02 **Kind**: instance method of [<code>Utility</code>](#Utility) **Summary**: 取得N個月前的當天 **Returns**: <code>String</code> - 回傳108/12/02 | Param | Type | Description | | --- | --- | --- | | num | <code>String</code> | 往前n個月 | <a name="Utility+getNextMonthCurrentDate"></a> ### utility.getNextMonthCurrentDate(num) ⇒ <code>String</code> 假設當天是109/01/02 **Kind**: instance method of [<code>Utility</code>](#Utility) **Summary**: 取得N個月後的當天 **Returns**: <code>String</code> - 回傳109/02/02 | Param | Type | Description | | --- | --- | --- | | num | <code>String</code> | 往後n個月 | <a name="Utility+getParameterByName"></a> ### utility.getParameterByName(name, num) ⇒ <code>String</code> 假設網址(url)是https://a.b.c/xxx.aspx?x=val1&y=val2, getParameterByName(y,url) **Kind**: instance method of [<code>Utility</code>](#Utility) **Summary**: 取得網址參數的值 **Returns**: <code>String</code> - 回傳y的值是val2 | Param | Type | Description | | --- | --- | --- | | name | <code>String</code> | 欲取得的參數名稱 | | num | <code>String</code> | 完整的網址 | <a name="Utility+twd97_to_latlng"></a> ### utility.twd97\_to\_latlng($x, $y) ⇒ <code>array</code> **Kind**: instance method of [<code>Utility</code>](#Utility) **Summary**: TWD97轉WGS84 **Returns**: <code>array</code> - 回傳WGS84坐標陣列 | Param | Type | Description | | --- | --- | --- | | $x | <code>float</code> | TWD97 x坐標 | | $y | <code>float</code> | TWD97 y坐標 |