**本章節主要介紹框架擴展到vue實例上的一些方法。**
|名稱|參數|返回值|描述|
|---|---|---|---|
|$api(apiName, methodName, params)|apiName：**httpConfig.api**配置中，掃描之后的文件名稱。methodName：api文件中的方法名稱。params：要傳輸的參數。|Promise|根據文件名與內部方法名來發送對應請求。**注意：如果沒有進行options.http配置的話，該方法是不存在的！**|
|$jump(path/{name: 'xxx'}, replace)|第一個參數為字符串的話，會尋找對應path的路由進行跳轉，如果為對象的話，會根據內部的屬性進行跳轉，與$router.push一致。replace：boolean類型，是否替換，默認為false，如果為true，則相當于執行了$router.replace函數。|無|框架內部針對路由跳轉的進一步封裝，所有的頁面跳轉都要調用此方法。原來的$router.push、$router.replace已禁用。**注意：如果沒有進行options.router配置的話，該方法是不存在的！**|
|$changeStore(mutationName, payload)|mutationName：vuex中配置的mutation的名稱。payload：參數。|無|剛方法是針對$store.commit的進一步封裝，**同時保留了原來的$store.commit方法。推薦使用$changeStore，原來的方法可能會在以后的版本中禁用。**|
|$getRef(ref)|ref: string類型，要獲取的實例所綁定的ref值|返回獲取到的實例或實例數組|根據ref綁定的值，獲取對應的實例或實例數組。|
|$chunk(source, chunkLength)|source：要操作的數組對象。chunkLength：每組的長度|一個分割處理后的二維數組。|用于把數組按照指定個數進行分組。例如[1,2,3,4,5,6]變成[[1,2],[3,4],[5,6]。|
|$encrypt.encoder(target, salt)|target：object類型，要被加密的對象。salt：鹽，可選值。|被加密之后的字符串。|用來進行對象加密。|
|$encrypt.decoder(encoderStr, salt)|encoderStr：被加密的字符串。salt：鹽，選填，如果加密時填寫了，那么解密時要填寫一致的。|返回被解密的對象。|將某個加密字符串解密成原本的樣子。|
|$busCollect(...busIds)|this.$bus.on/this.$bus.once。|無|將監聽當做參數傳入此方法，即可在組件銷毀時，自動取消監聽。|
|$bus.on(eventName, func)|eventName：事件名稱。func：處理函數。|監聽ID，string類型。用于取消監聽。|全局監聽某個事件。|
|$bus.once(eventName, func)|同上|同上|同上，區別在于，該監聽只會執行一次，觸發過后自動銷毀。|
|$bus.emit(eventName, params)|eventName：要觸發的事件名稱。params：觸發事件時，傳遞的參數。|無|全局觸發某個事件。|
|$bus.stop(id)|id：string類型，創建監聽時返回的ID。|無|用來停止某個監聽。|
|$tips.success(message)|message：string類型，提示內容。|無|彈出一個代表成功的提示。|
|$tips.info(message)|同上|無|彈出一個代表信息的提示。|
|$tips.warning(message)|同上|無|彈出一個代表警告的提示。|
|$tips.error(message)|同上|無|彈出一個代表異常的提示。|
|$tips.confirm(message, title)|message：string類型，確認框的內容。title：string類型，確認框的標題，默認為“提醒”。|Promise|用來彈出一個確認框。|
|$loading.show(text)|text：string類型，loading要展示的文本內容，默認為“正在加載數據，請稍后。”。|id，string類型，關閉loading時需要使用。|用于打開一個loading遮罩。|
|$loading.close(id)|id：string類型，創建loading時返回的id。|無|用于關閉某個loading。|
|$loading.closeAll|無|無|用于關閉窗口中所有的loading遮罩。|
|$slideTo(target, from, to, duration, completeCallback)|target：要被移動的dom元素。from：number類型，從什么坐標開始。to：number類型，到什么坐標結束。duration：number類型，從開始到結束需要的時長，單位是毫秒。completeCallback：function類型，移動結束后的回調函數。|無|將元素平滑的從某個點位移動到另一個點位。|
|$formatDate(date, pattern)|date：date / string類型，要格式化的時間對象。pattern：string類型，要格式化為哪種格式，默認為“yyyy-MM-dd hh:mm:ss”。|string類型，被格式化之后的時間。|將某個date / string類型的時間進行格式化。|
|$copy(content)|content：string類型，要復制到剪切板的內容。|無|將內容復制到剪切板。|
|$toFixed(num, digits, isRound)|num：string / number類型，要被操作的數字。digits：number類型，要保留幾位小數。isRound：boolean類型，是否四舍五入，默認為false。|返回截取后的數字。|用來截取數字到指定的小數位。|
|$formatMoney(target, addComma)|target：string / number類型，要被格式化的對象。addComma：boolean類型，是否添加千分位，默認true。|格式化之后的數據。|分轉元，同時支持是否添加千分位。|
|$formatNumber(num)|number類型，要被格式化的對象|格式化之后的數據。|將數字格式化為千分位形式。|
|$typeEqual(target, type)|target：object，要被判斷的對象。type：可傳入類型，例如：Array，則校驗target是否屬于Array類型，該參數可傳多個，多個類型時，其中一個符合要求則返回true。|類型是否符合|校驗target是否符合某個類型。|
|$removeItemInArray(array, removeItem)|array:Array類型，要操作的數組對象。removeItem：object類型，要在數組中刪除的對象。|無|在數組中刪除某個元素。|
|$trim(str)|string類型，要去空格的字符串。|返回去空格之后的字符串。|給字符串去除兩邊的空格。|
|$isEmpty(obj)|object類型，判斷obj是否為空。|為空時返回true，反之返回false。|用于判斷對象是否為空。|
|$isNotEmpty(obj)|object類型，判斷obj是否不為空。|不為空時返回true，反之返回false。|用于判斷對象是否非空。|
|$getRandomByRegion(min, max)|min: number類型，獲取隨機數區間的最小值(包含)。max: number類型，獲取隨機數區間的最大值(包含)。|返回獲取到的隨機數。|獲取指定區間的隨機數。|
|$list2Tree(array, setting)|array: array類型，要轉換為樹結構的原數組對象。setting：配置項，包含idField：string類型，代表主鍵的字段，默認id。pidField：string類型，代表父id的字段，默認parentId。childrenField：string類型，子節點存放的字段名，默認children。rootPidValue：根節點值，默認為'0'。removeEmptyChild: boolean類型，如果子節點不存在，是否移除子節點字段，默認為true。|返回樹結構對象。|將list轉換為樹結構。|
|$tree2List(array, removeChildren)|array: array類型，要轉換為list的樹結構對象。childrenField：string類型，子節點存放的字段。removeChildren：boolean類型，是否刪除children字段，默認true。|將樹結構拉平為list。|將樹結構拉平為list。|
