开发者API
Base
- myFocus(settings)返回值:myFocus对象
- 新建myFocus对象(类似jQuery对象，为一个类DOM数组)，settings为调用set函数中的参数集合。
- myFocus.set(settings[,callback])返回值:undefined
- myFocus的调用函数，settings为设置的参数集，callback为回调函数，详细请阅读使用者API。
- myFocus.extend(obj1[,obj2,obj3...])返回值:Object
- 扩展函数，把obj2,obj3...属性扩展到obj1对象上，如果只有一个obj1，那么默认扩展myFocus空间。
- myFocus.config返回值:Object
- 设置集合，每款风格对应一个参数对象，例如{'mF_YSlider':{direction:'random'}}
- myFocus.config.extend(obj)返回值:Object
- 扩展风格设置，一般在风格文件中设置个性参数。
- myFocus.fn返回值:Object
- myFocus原形，相当于它的prototype。
- myFocus.fn.extend(obj)返回值:Object
- 扩展原形方法。
- myFocus.pattern返回值:Object
- 风格应用集(空间)
- myFocus.pattern.extend(obj)返回值:Object
- 扩展风格应用集(空间)
- myFocus.isIE返回值:Boolean
- 判断是否IE，是返回true，否返回false
DOM
- .find(selector)返回值:myFocus对象
- 查找并返回所有与指定表达式匹配的元素，类似jQuery的find()，但只支持基本查找，不支持过滤(:filter)/属性([attr="value"])查找。
- .parent()返回值:myFocus对象
- 查找并返回它的父元素。
- .html([htmlString])返回值:String
- 当参数为空，获取匹配元素(第一个)的html内容；当不为空，设置匹配元素(第一个)的html内容。
- .each(fn)返回值:myFocus对象
- 以每一个匹配的元素作为上下文来执行一个函数。类似jQuery的each()，函数中this 指代的是 DOM 对象而非 myFocus 对象。返回 'false' 将停止循环 (就像在普通的循环中使用 'break')。返回 'true' 跳至下一个循环(就像在普通的循环中使用'continue'
- .eq(n)返回值:myFocus对象
- 获取第n个元素，从0算起。
- .wrap(htmlString)返回值:myFocus对象
- 把所匹配的元素用其他元素的结构化标记包装起来。注意每次只wrap一个元素,多个请用each。
- .addHtml(htmlString)返回值:myFocus对象
- 向匹配的元素内部追加html字符串。返回值是追加后的html元素。
- .addList(className,type)返回值:myFocus对象
- 向匹配的元素内部追加列，这个列的数量等同焦点图的图片数量，className为列的class名称，type为列的类型，内置3种类型：'num'(数字按钮列)|'txt'(文字列)|'thumb'(略缩图列)，省略设置为普通列。返回值为新添加的列元素。
- .addListNum([className])返回值:myFocus对象
- 向匹配的元素内部追加数字列，相当于.addList()参数type='num'的快捷方式调用。
- .addListTxt([className])返回值:myFocus对象
- 向匹配的元素内部追加文字列，相当于.addList()参数type='txt'的快捷方式调用。
- .addListThumb([className])返回值:myFocus对象
- 向匹配的元素内部追加略缩图列，相当于.addList()参数type='thumb'的快捷方式调用。
- .remove()返回值:undefined
- 删除匹配的元素
- .repeat([n])返回值:myFocus对象
- 重复生成匹配的元素，默认重复一遍，n为重复n遍。
CSS
- .css(name|properties)返回值:Number|String|myFocus对象
- 获取匹配元素的name样式值(不带单位)，或把一个“名/值对”properties对象设置为匹配元素的样式属性。例如：$obj.css({height:300})设置$obj高为300px，$obj.css('height')获取$obj的高(返回300)
- .addClass(className)返回值:myFocus对象
- 为匹配的元素添加指定的类名。
- .removeClass(className)返回值:myFocus对象
- 为匹配的元素删除指定的类名。
Animate
- .fadeIn([time][,type][,fn])返回值:myFocus对象
- 通过不透明度的变化来实现匹配元素的淡入效果。time为渐变时间(毫秒)，默认400；type为渐变的缓动类型，默认“linear(线性)”；fn是在动画完成时执行的函数，上下文this为匹配元素DOM。
- .fadeOut([time][,type][,fn])返回值:myFocus对象
- 通过不透明度的变化来实现匹配元素的淡出效果。time为渐变时间(毫秒)，默认400；type为渐变的缓动类型，默认“linear(线性)”；fn是在动画完成时执行的函数，上下文this为匹配元素DOM。
- .slide(params[,time][,type][,fn])返回值:myFocus对象
- 通过位置/大小/透明度等变化来平滑过渡匹配的元素。params为一个“名/值对”对象的样式属性；time为过渡时间(毫秒)，默认800；type为过渡的缓动类型，默认“easeOut”；fn是在动画完成时执行的函数，上下文this为匹配元素DOM。
- .stop()返回值:myFocus对象
- 停止匹配元素的所有运动效果。
- .easing返回值:Object
- 缓动库，已集成'linear','swing','easeIn','easeOut','easeInOut'，可以用myFocus.extend()方法扩展更多缓动效果。
Method
- .bind(type,fn)返回值:myFocus对象
- 为匹配元素的特定事件绑定事件处理函数。type为事件类型；fn为处理函数。处理函数第一个参数为event，上下文this为匹配元素DOM，返回false可以阻止冒泡及默认事件。
- .play(funcLastFrame,funcCurrentFrame[,seamless])返回值:undefined
- 轮播函数，funcLastFrame为上一帧处理函数，带有2个参数，第一个为上一帧的索引值，第二个为总帧数；funcCurrentFrame为当前帧处理函数，带有3个参数，第一个为当前帧的索引值，第二个为总帧数，第三个为上一帧的索引值；seamless为是否无缝(滑动效果才有效)
- .run(index)返回值:undefined
- 轮播运行的核心方法，index为运行帧的索引值，支持相对增减'+-=value'，例如：$focus.run('+=1')，运行下一帧；$focus.run('-=1')，运行上一帧。
- .runIndex返回值:Number
- 运行的当前帧索引值
- .runTimer返回值:Number|String
- 运行的计数器，一般用于clearInterval
- .bindControl($btnList[,params])返回值:undefined
- 为焦点图绑定控制。$btnList是要被绑定控制的myFocus对象(按钮列表)；params是一个“名/值对”对象，包含有：{thumbShowNum:'略缩图显示数目(如果有)',isRunning:'运行中的标记(当需要判断时)'}
- .scrollTo(index[,time])返回值:myFocus对象
- 匹配的元素(略缩图列表)滚动到指定的索引值index，time为滚动的时间(单位毫秒)，默认500
注：函数参数中的“[]”表示此中括号内的参数可省。
此API基于myFocus v2.0制作，时间有限，只列出了有用于开发者开发的方法/属性，如有错漏疑问欢迎来信或留言。