**本章节主要介绍框架扩展到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。|