TVUI

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 9 Open GitHub ↗

电视应用前端开发框架

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# TVUI API 手册 #
  TVUI是基于JavaScript的电视应用程序用户界面软件开发工具包，为创建效果、互动电视应用程序，提供必要的功能，节省开发的时间和规模。

## TVUI.Util ##
工具函数静态类，不需要实例化，直接调用即可。
### TVUI.Util.encode(str) ###
字符转码，等于 encodeURIComponent
### TVUI.Util.decode(str) ###
字符转码，等于 decodeURIComponent
### TVUI.Util.proxy(func, obj, [param1], [param2],...) ###
作用域代理函数
 @param func 要修改作用域的函数
 @param obj  作用域对象
 @returns {Function} 修改后的函数
举例1：
 var func # TVUI.Util.proxy(function(){
    console.log(this.name); //--> kenny
 }, {name:'kenny'});
  
 func();

举例2：
可注入参数
 var func # TVUI.Util.proxy(function(str){
    console.log(this.name); //--> kenny
    console.log(str); //--> hello
 }, {name:'kenny'}, 'hello');
  
 func();

### TVUI.Util.likeArray(array) ###
判断是否一个类数组
 @param array 要判断的数组
 @returns {boolean}
### TVUI.Util.queryToJson(str)###
把查询字符串转换成json格式，中文自动解码, 适合在需要获取多个参数时使用

举例：
  var query # 'name#kenny&age#18';
  var json # TVUI.Util.queryToJson(query);  
  console.log(json); //--> {name:'kenny', age:18}

### TVUI.Util.getParam(name, [url])###
根据url参数名称，获取对应的值

@param name 参数名称
 @url 指定的url，可选， 默认是当前页面的url，即location.href
 @returns {String} 参数值

举例：

var url # 'http://www.baidu.com/?key#abc';
  var value # TVUI.Util.getParam('key', url);
  console.log(value); //--> abc

### TVUI.Util.param(obj) ###
把json格式数据转换成查询字符串，该方法是 TVUI.Util.queryToJson(str) 的逆转换

@param obj json格式数据
 @returns {String} 查询字符串

举例：
 var obj # {name:'kenny', age:18};
 var str # TVUI.Util.param(obj);
 console.log(str); //--> name#kenny&age#18

### TVUI.Util.getFileName([pathName]) ###
获取文件名，不包含扩展名

@pathName 文件路径，可选，默认是当前页面的url
 @returns {String} 文件名称

### TVUI.Util.log([param1],[param2]...) ###
输出控制台，用作代替console.log, 由于机顶盒或浏览器未开启调式模式时，是不支持console的，在调试时打了console又忘记删除就会造成程序崩溃，建议用TVUI.Util.log代替，用法与console.log完全一致

### TVUI.Util.guid() ###
生成一个guid，无参数

### TVUI.Util.pad(num, n) ###
数字补零
 @param num 要补零的数字
 @n 位数
 @returns {String}

举例：
  var str # TVUI.Util.pad(9, 3);
  console.log(str); //--> 009

### TVUI.Util.range(data, num, index) ###
循环从数组中取出指定项，并且指定项目在中间

举例：

var arr # [1,2,3,4,5];
  TVUI.Util.range(arr, 3, 0); //--> [5, 1, 2]
  TVUI.Util.range(arr, 3, 1); //--> [1, 2, 3]
  TVUI.Util.range(arr, 3, 2); //--> [2, 3, 4]
  TVUI.Util.range(arr, 3, 3); //--> [3, 4, 5]
  TVUI.Util.range(arr, 3, 4); //--> [4, 5, 1]

### TVUI.Util.rangeLeft(data, num, index) ###
循环从数组中取出指定项，并且指定项目在左边第一个

举例：

var arr # [1,2,3,4,5];
 TVUI.Util.rangeLeft(arr, 3, 0); //--> [1, 2, 3]
 TVUI.Util.rangeLeft(arr, 3, 1); //--> [2, 3, 4]
 TVUI.Util.rangeLeft(arr, 3, 2); //--> [3, 4, 5]
 TVUI.Util.rangeLeft(arr, 3, 3); //--> [4, 5, 1]
 TVUI.Util.rangeLeft(arr, 3, 4); //--> [5, 1, 2]

### TVUI.Util.rangeFixed(data, num, index) ###
在数组范围内中取出指定项

举例：

var arr # [1,2,3,4,5];
 TVUI.Util.rangeFixed(arr, 3, 0); //--> [1, 2, 3]
 TVUI.Util.rangeFixed(arr, 3, 1); //--> [1, 2, 3]
 TVUI.Util.rangeFixed(arr, 3, 2); //--> [2, 3, 4]
 TVUI.Util.rangeFixed(arr, 3, 3); //--> [3, 4, 5]
 TVUI.Util.rangeFixed(arr, 3, 4); //--> [3, 4, 5]

### TVUI.Util.timeout(func, time, [obj]) ###
延时执行，用来代替setTimeout, 由于setTimeout会修改函数的this指向，TVUI.Util.timeout可以指定作用域this，建议使用代替setTimeout

@func 延时执行的函数
 @time 延时时间
 @obj 作用域对象，可选
 @returns{Number}

举例：
 TVUI.Util.timeout(function(){
   console.log(this.name); //--> kenny
 }, 1000, {name:'kenny'});

### TVUI.Util.date(dateStr, format, options) ###
日期时间处理函数

@dateStr 日期对象或字符串
 @format 输入格式，如 yyyy-MM-dd hh:mm:ss
 @options 时间偏移选项，可选，默认：｛y:0, M:0, d:0, h:0, m:0, s:0｝
 @returns{String|Date}

举例：

var now # new Date();
 TVUI.Util.date(now,'yyyy-MM-dd',{d:1}); //--> 当前日期增加一天

### TVUI.Util.tpl(template, data) ###
模版处理函数，用作根据数据和模版生成视图

@template 模版字符串
 @data 数据，数组或对象
 @returns{String}

举例：
 <nowiki>var template # '{$name},{$age}';
 TVUI.Util.tpl(template, {name:'kenny',age:18}); //--> kenny,18
 TVUI.Util.tpl(template, [{name:'kenny',age:18},{name:'sam',age:20}]); //--> kenny,18sam,20</nowiki>

如果模版内容比较多，可以把模版写到html里面，如：

html：
 <nowiki><script type#"template/text" id#"template">
 {$name},{$age}
 </script></nowiki>

js:
  var template # $('#template').html();

### TVUI.Util.getCharCount(str) ###
获取字符串字节数，1个中文算2个字节

### TVUI.Util.subStr(str, len) ###
截取字符串，1个中文算2个字节
 @str 要截取的字符串
 @len 截取字节长度
 @returns{String}

### TVUI.Util.getSTBType() ###
获取机顶盒类型，'''不推荐使用'''

## TVUI.Event ##
事件模块，提供dom事件绑定和删除功能，事件是采用原生addEventListener绑定方式
### TVUI.Event.on(type, handler, [scope])  ###
绑定一个事件

@type 事件名称，如：keyup keydown
 @handler 回调函数
 @scope 作用域，就是handler中的 this 指向的对象 
 @returns {TVUI.uuid|*} 返回唯一的标识id

### TVUI.Event.off([type], [handler])  ###
删除事件

用法：
 TVUI.Event.off(type, handler) 删除具体一个事件
 TVUI.Event.off(type) 删除指定一类事件，例如要删除keyup的全部事件 off('keyup')
 TVUI.Event.off()  删除所有事件
 TVUI.Event.off(id) 删除指定id标识的事件
 TVUI.Event.off(ids) 删除指定id标识数组的事件

### TVUI.Event.fire(type, keyCode)  ###

触发事件

@param type 事件名称
 @param keyCode 模拟事件keyCode

### TVUI.Event.onPress(callback, [scope])  ###

按键事件，不需要长按连续触发的，建议使用这个绑定方式，提高性能

@param callback 事件回调函数，回调函数参数是事件对象，就是fixEvent后的对象
 @param scope 作用域
 @returns {TVUI.uuid|*} 事件唯一标识

### TVUI.Event.onKey(code, callback, [scope])  ###

按键事件，这种绑定方式支持长按连续触发

@param code 按键的keyCode
 @param callback 事件回调函数，回调函数参数是事件对象，就是fixEvent后的对象
 @param scope 作用域
 @returns {*[]} 事件唯一标识数组

### TVUI.Event.onKeys(codes, callback, [scope])  ###

绑定多个按键事件

@param codes 按键keyCode数组
 @param callback 事件回调函数，回调函数参数是事件对象，就是fixEvent后的对象
 @param scope 作用域
 @returns {Array} 事件唯一标识数组

### TVUI.Event.onOk(callback, [scope])  ###

确定键事件