Skip to content

Commit 04aeb44

Browse files
committed
完善了对Tools.js的描述
尝试修正Loading.js的描述中不能正确链接的部分
1 parent 954478a commit 04aeb44

1 file changed

Lines changed: 76 additions & 9 deletions

File tree

Template/Public/JavaScript/README.md

Lines changed: 76 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -141,20 +141,21 @@
141141
|属性|canvasID|String|储存了指定`canvas`的ID|
142142
|属性|canvasIndex|Number|指明自身在内部维护的储存库中的编号|
143143
|属性|ClickFlag|Number|控件动画播放的状态|
144-
|方法|[Init_CTX](#Loading.Init_CTX "详细信息")|Object|初始化内部的绘图对象`ctx`,返回`this.ctx`|
145-
|方法|[Init](#Loading.Init "详细信息")|Object|初始化自身,会自动调用`this.Init_CTX`,返回`this`|
146-
|方法|[setSchedule](#Loading.setSchedule "详细信息")|Object|直接设定`Schedule`的值,返回`this`|
147-
|方法|[PercentageValue2ShowValue](#Loading.PercentageValue2ShowValue "详细信息")|Number|将百分比的值转换为用于显示的值|
148-
|方法|[Refresh](#Loading.Refresh "详细信息")|void|根据配置渲染页面|
149-
|方法|[start](#Loading.start "详细信息")|Object|开始动画,返回`this`|
150-
|方法|[stop](#Loading.stop "详细信息")|Object|停止动画,返回`this`|
151-
|方法|[onClick](#Loading.onClick "详细信息")|Object|如果传参为非`false`就认为是开启点击事件响应功能,返回`this`|
152-
|静态方法|[indexOf](#Loading.static-indexOf "详细信息")|Object|取得指定的`Loading_Control`对象|
144+
|方法|[Init_CTX](#LoadingInit_CTX "详细信息")|Object|初始化内部的绘图对象`ctx`,返回`this.ctx`|
145+
|方法|[Init](#LoadingInit "详细信息")|Object|初始化自身,会自动调用`this.Init_CTX`,返回`this`|
146+
|方法|[setSchedule](#LoadingsetSchedule "详细信息")|Object|直接设定`Schedule`的值,返回`this`|
147+
|方法|[PercentageValue2ShowValue](#LoadingPercentageValue2ShowValue "详细信息")|Number|将百分比的值转换为用于显示的值|
148+
|方法|[Refresh](#LoadingRefresh "详细信息")|void|根据配置渲染页面|
149+
|方法|[start](#Loadingstart "详细信息")|Object|开始动画,返回`this`|
150+
|方法|[stop](#Loadingstop "详细信息")|Object|停止动画,返回`this`|
151+
|方法|[onClick](#LoadingonClick "详细信息")|Object|如果传参为非`false`就认为是开启点击事件响应功能,返回`this`|
152+
|静态方法|[indexOf](#Loadingstatic-indexOf "详细信息")|Object|取得指定的`Loading_Control`对象|
153153

154154
### Loading.Init_CTX
155155

156156
>初始化内部的绘图对象`ctx`
157157
158+
* 参数:无
158159
* 返回值:`canvas`绘制控制对象
159160

160161
### Loading.Init
@@ -183,24 +184,32 @@
183184

184185
>将百分比的值转换为用于显示的系数
185186
187+
参数列表:
188+
|参数名|参数类型|参数描述|
189+
|---|---|---|
190+
|params|Number|要转换的数值|
191+
186192
* 返回值:用于显示的公式系数之一,在内部参与运算
187193

188194
### Loading.Refresh
189195

190196
>根据配置渲染页面
191197
198+
* 参数:无
192199
* 返回值:无返回值
193200

194201
### Loading.start
195202

196203
>开始动画
197204
205+
* 参数:无
198206
* 返回值:所在对象自身
199207

200208
### Loading.stop
201209

202210
>停止动画
203211
212+
* 参数:无
204213
* 返回值:所在对象自身
205214

206215
### Loading.onClick
@@ -224,6 +233,7 @@
224233
|index|Number/String|依据指定的索引编号或者`canvas`节点的ID,返回对应的`Loading_Control`对象|
225234

226235
* 返回值:指定的对象
236+
* 错误返回值:undefined
227237

228238
### Loading 示例
229239

@@ -265,3 +275,60 @@ data:image/png;base64,' + TextureList['dirt']
265275
266276
这里是关于文件[Tools.js](https://github.com/MemoryShadow/MemoryShadow.github.io/blob/master/Template/Public/JavaScript/Tools.js "访问源代码")
267277
的详细介绍.
278+
279+
该文件有以下方法:
280+
281+
|方法名|方法用途|返回值|
282+
|---|---|---|
283+
|[_GET](#ToolsGET)|解析当前页面中由GET方法传递过来的值|Array|
284+
|[GetXmlHttp](#ToolsGetXmlHttp)|取得一个Ajax对象|Object|
285+
|[Ajax](#ToolsAjax)|发送一次Ajax请求|void|
286+
287+
### Tools._GET
288+
289+
>解析当前页面中由GET方法传递过来的值
290+
291+
* 参数:无
292+
* 返回值:一个数组,其值由GET方法提交的键名,或者提交的顺序(Number)来索引获得
293+
294+
### Tools.GetXmlHttp
295+
296+
>取得一个Ajax对象
297+
298+
* 参数:无
299+
* 返回值:一个`XMLHttpRequest`对象
300+
301+
### Tools.Ajax
302+
303+
>发送一次Ajax请求
304+
305+
参数列表:
306+
|参数名|参数类型|参数描述|
307+
|---|---|---|
308+
|method|String|指定参数发送的方法,只接受GET和POST|
309+
|Url|String|指定要请求的页面URL|
310+
|search|String|请求的参数,不同字段之间使用&符进行分隔|
311+
|method|callback|回调函数,参数1将会传入一个`XMLHttpRequest`对象|
312+
313+
* 返回值:无
314+
315+
方法示例:
316+
317+
```JavaScript
318+
/**
319+
* 获取一条彩虹屁
320+
* @param {String} id 要盛放返回值的HTML节点ID
321+
*/
322+
function CaiHongPi(id) {
323+
Ajax("GET",
324+
"https://memoryshadow.freetzi.com/Template/Public/ToolAPI/",
325+
"Mode=Ajax&Function=CaiHongPi",
326+
function (XmlHttp) {
327+
// 当响应达成,并且成功的时候,就修改数据
328+
if (XmlHttp.readyState == 4 && XmlHttp.status == 200) {
329+
document.getElementById(id).innerHTML = XmlHttp.responseText;
330+
}
331+
}
332+
);
333+
}
334+
```

0 commit comments

Comments
 (0)