~bac/juju-gui/trunkcopy

<p>This example shows how to populate a DataTable with data from the Yahoo! Local webservice retrieved via a same-domain script. First we create a DataSource.IO instance pointing to data, then using the DataTableDataSource plugin we can load data for Chinese restaurants near our office.</p>

<p>In this example, we set the <code>initialRequest</code> value in the DataTableDataSource plugin constructor so that the initial data is loaded first and then the DataTable is rendered in a separate call.</p>

<p><strong>Note:</strong> XML parsing currently has known issues on the Android WebKit browser.

</div>

/* custom styles for this example */

.example .yui3-datatable {

margin-bottom: 1em;

}

/* css to counter global site css */

.example table {

width: auto;

}

.example caption {

display: table-caption;

}

.example th,

.example td {

text-transform: none;

border: 0 none;

}

</style>

YUI().use("datasource-io", "datasource-xmlschema", "datatable-datasource", function (Y) {

var ds = new Y.DataSource.IO({

source:"../assets/datatable/ylocal.xml?"})

.plug(Y.Plugin.DataSourceXMLSchema, {

schema: {

resultListLocator: "Result",

resultFields: [

{

key:"Title",

locator:"*[local-name() ='Title']"

{

key:"Phone",

locator:"*[local-name() ='Phone']"

{

key:"Rating",

locator:"*[local-name()='Rating']/*[local-name()='AverageRating']",

// The data contains "NaN" for unrated restaurants

parser: function (val) {

return isNaN(val) ? '(none)' : val;

}

]

}

}),

dt = new Y.DataTable({

columns: ["Title", "Phone", "Rating"],

summary:"Chinese restaurants near 98089",

caption:"Table with XML data from same-domain script"

}).plug(Y.Plugin.DataTableDataSource, {

datasource: ds,

initialRequest:"zip=94089&query=chinese"

}).render("#chinese");

dt.datasource.load();

});

</script>

</div>

<h2>Populating Your DataTable with Remote Data using DataSource.IO</h2>

<p>Your table can be easily populated with XML data from your back-end by creating a DataSource instance and using the DataTableDataSource plugin to load the data into a DataTable.</p>

<p>Start with the <code>use()</code> statement:</p>

100

101

<pre class="code prettyprint">YUI().use("datasource-io", "datasource-xmlschema", "datatable-datasource", function(Y) {

102

});</pre>

103

104

105

<p>Next create a DataSource.IO instance pointing to your data. (Note that in order to point the Yahoo! Local webservice, you would need to bypass cross-domain browser restrictions on XHR by creating a locally served proxy. You do not need to implement such a proxy when your data is accessed from the same domain.) Define the correct schema for the DataSourceJSONSchema plugin. This is a good time to call <code>sendRequest</code> to make sure the data returns as expected.</p>

106

107

<pre class="code prettyprint">var dataSource = new Y.DataSource.IO({

108

source:"ylocal_proxy.php?zip=94089&query=chinese"

109

});

110

111

dataSource.plug(Y.Plugin.DataSourceXMLSchema, {

112

schema: {

113

resultListLocator: "Result",

114

resultFields: [

115

{key:"Title", locator:"*[local-name() ='Title']"},

116

{key:"Phone", locator:"*[local-name() ='Phone']"},

117

{key:"Rating", locator:"*[local-name()='Rating']/*[local-name()='AverageRating']"}

118

]

119

}

120

});

121

122

dataSource.sendRequest({

123

callback: {

124

success: function (e) {

125

Y.log(e);

126

}

127

}

128

});</pre>

129

130

131

<p>Now that the DataSource is created properly, define the columns that you want your table to show. These columns map directly to the parameter names returned in the data.</p>

132

133

<p>Now you are ready to create a DataTable using the columns you have defined. When you plug the instance with the DataTableDataSource plugin, point to your DataSource instance, and set an <code>initialRequest</code> value so that the initial data loads right way. Then call <code>render()</code> after the data response has been processed.</p>

134

135

<pre class="code prettyprint">var dataSource = new Y.DataSource.IO({

136

source:"ylocal_proxy.php?zip=94089&query=chinese"

137

});

138

139

dataSource.plug(Y.Plugin.DataSourceXMLSchema, {

140

schema: {

141

resultListLocator: "Result",

142

resultFields: [

143

{key:"Title", locator:"*[local-name() ='Title']"},

144

{key:"Phone", locator:"*[local-name() ='Phone']"},

145

{key:"Rating", locator:"*[local-name()='Rating']/*[local-name()='AverageRating']"}

146

]

147

}

148

});

149

150

var table = new Y.DataTable({

151

columns: ["Title", "Phone", "Rating"],

152

summary: "Chinese restaurants near 98089",

153

caption: "Table with XML data from same-domain script"

154

});

155

table.plug(Y.Plugin.DataTableDataSource, {

156

datasource: dataSource,

157

initialRequest: ""

158

});

159

160

dataSource.after("response", function() {

161

table.render("#pizza")}

162

);</pre>

163

164

165

<p>One final change you can make is to split the URL between the DataSource <code>source</code> value and the <code>request</code> value sent to the DataTableDataSource plugin. Splitting the URL this way facilitates making future requests to the same DataSource.

166

167

<p>Here's the code to run the whole example:</p>

168

169

<pre class="code prettyprint">YUI().use("datasource-get", "datasource-jsonschema", "datatable-datasource", function(Y) {

170

var dataSource = new Y.DataSource.IO({

171

source: "ylocal_proxy.php?"

172

});

173

174

dataSource.plug(Y.Plugin.DataSourceXMLSchema, {

175

schema: {

176

resultListLocator: "Result",

177

resultFields: [

178

{key:"Title", locator:"*[local-name() ='Title']"},

179

{key:"Phone", locator:"*[local-name() ='Phone']"},

180

{key:"Rating", locator:"*[local-name()='Rating']/*[local-name()='AverageRating']"}

181

]

182

}

183

});

184

185

var table = new Y.DataTable({

186

columns: ["Title", "Phone", "Rating"],

187

summary: "Chinese restaurants near 98089",

188

caption: "Table with XML data from same-domain script"

189

});

190

191

table.plug(Y.Plugin.DataTableDataSource, {

192

datasource: dataSource,

193

initialRequest: "zip=94089&query=chinese"

194

});

195

196

dataSource.after("response", function() {

197

table.render("#pizza")}

198

);

199

200

// Make another request later

201

//table.datasource.load({request:"zip=94089&query=pizza"});

202

});</pre>

203

204

</div>

205

</div>

206

</div>

207

208

209

210

211

212

213

214

215

<h2 class="no-toc">Examples</h2>

216

</div>

217

218

219

220

221

222

223

<a href="datatable-basic.html">Basic DataTable</a>

224

</li>

225

226

227

228

229

<a href="datatable-dsget.html">DataTable + DataSource.Get + JSON Data</a>

230

</li>

231

232

233

234

235

<a href="datatable-dsio.html">DataTable + DataSource.IO + XML Data</a>

236

</li>

237

238

239

240

241

<a href="datatable-formatting.html">Formatting Row Data for Display</a>

242

</li>

243

244

245

246

247

<a href="datatable-nestedcols.html">Nested Column Headers</a>

248

</li>

249

250

251

252

253

<a href="datatable-sort.html">Column Sorting</a>

254

</li>

255

256

257

258

259

<a href="datatable-scroll.html">Scrolling DataTable</a>

260

</li>

261

262

263

264

265

<a href="datatable-recordtype.html">Sortable generated columns</a>

266

</li>

267

268

269

270

271

</ul>

272

</div>

273

</div>

274

275

276

277

278

279

<h2 class="no-toc">Examples That Use This Component</h2>

280

</div>

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

<a href="../panel/panel-form.html">Creating a Modal Form</a>

304

</li>

305

306

307

</ul>

308

</div>

309

</div>

310

311

</div>

312

</div>

313

</div>

314

</div>

315

316

317

318

319

</body>

320

</html>

Older »